gafl-webapp-service
The web and telesales service buying a rod fishing licence; for https://www.gov.uk/fishing-licences
To run from this directory:
node src/gafl-webapp-service.js
Environment variables
| name | description | required | default | valid |
|---|---|---|---|---|
| NODE_ENV | Node environment | no | development, fsh-{env} | |
| HAPI_KEEP_ALIVE_TIMEOUT_MS | Configure the keep-alive timeout on the server listener | no | 1 minute | |
| PORT | The http port the listens on | no | 3000 | |
| REDIS_HOST | Hostname of the redis instance used for session caching | yes | ||
| REDIS_PORT | Port number of the redis instance used for session caching | no | 6379 | |
| REDIS_PASSWORD | Password used to authenticate with the configured redis instance | no | ||
| CHANNEL | The sales channel | no | websales | websales, telesales |
| SESSION_COOKIE_NAME | Name of the session cookie | no | sid | |
| CSRF_TOKEN_COOKIE_NAME | Name of the CSRF token cookie | no | rlsctkn | |
| SESSION_COOKIE_PASSWORD | Encryption key for the session cookie (at least 32 characters) | yes | ||
| SESSION_TTL_MS | Time to live for the session cookie and cache | no | 10800000 | |
| ADDRESS_LOOKUP_URL | OS Places API endpoint URL | no | https://api.os.uk/search/places/v1/postcode | |
| ADDRESS_LOOKUP_KEY | The API key required by OS places | no | ||
| ADDRESS_LOOKUP_MAX_RESULTS | Maximum results to fetch from OS API (pagination cap) | no | 5000 | |
| ADDRESS_LOOKUP_TIMEOUT_MS | The timeout in milliseconds for the lookup | no | 10000 | |
| SALES_API_URL | The address of the sales api | no | http://0.0.0.0:4000 | |
| SALES_API_TIMEOUT_MS | The timeout in milliseconds requests to the api | no | 10000 | |
| GOV_PAY_API_URL | The GOV.UK Pay API base url | no | Yes | |
| GOV_PAY_APIKEY | GOV pay access identifier | no | Yes | |
| GOV_PAY_REQUEST_TIMEOUT_MS | Timeout in milliseconds for API requests | no | Yes | |
| FEEDBACK_URI | Location of feedback survey | no | # | |
| ANALYTICS_PRIMARY_PROPERTY | Analytics ID for tracking inc ecommerce | no | ||
| ANALYTICS_PROPERTY_API | Analytics property API key for linking Analytics.google property | no | ||
| SERVICE_PAGE | GOV.UK service page | no | https://www.gov.uk/fishing-licences/buy-a-fishing-licence | |
| AIRBRAKE_HOST | URL of airbrake host | no | ||
| AIRBRAKE_PROJECT_KEY | Project key for airbrake logging | no | ||
| ENABLE_ANALYTICS_OPT_IN_DEBUGGING | Set log if analytics been checked in non-production | no | ||
| ERROR_PAGE_ROUTE | Display error pages to support welsh language | no | ||
| SHOW_CANCELLATION_JOURNEY | Display option to show recurring payments cancellation journey to admin | no | telesales | |
| SHOW_CANCELLATION_JOURNEY_PUBLIC | Display option to show recurring payments cancellation journey to public | no | websales |
OS Places address lookup
The address lookup service calls the OS Places API directly. The service performs client-side filtering when a premises search is provided.
GOV.UK pay setup
The details of the GOV.UK payment API can be found here: https://docs.payments.service.gov.uk/#gov-uk-pay-technical-documentation