Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,23 +174,22 @@ Please use a config file instead. This will give you more control over each envi
The defaults can be found in [config](./src/config/index.ts). Place your config files in `runner/config`
See [https://github.com/node-config/node-config#readme](https://github.com/node-config/node-config#readme) for more info.

| name | description | required | default | valid | notes |
| --------------------- | -------------------------------------------------------------------------------- | :------: | ------- | :-------------------------: | :-------------------------------------------------------------------------------------------------------------------------: |
| NODE_ENV | Node environment | no | | development,test,production | |
| PORT | Port number | no | 3009 | | |
| NOTIFY_TEMPLATE_ID | Notify api key | yes | | | Template ID required to send form payloads via [GOV.UK Notify](https://www.notifications.service.gov.uk) email service. |
| NOTIFY_API_KEY | Notify api key | yes | | | API KEY required to send form payloads via [GOV.UK Notify](https://www.notifications.service.gov.uk) email service. |
| LOG_LEVEL | Log level | no | debug | trace,debug,info,error | |
| PHASE_TAG | Tag to use for phase banner | no | beta | alpha, beta, empty string | |
| FEEDBACK_LINK | Link to display in the phase banner when asking for feedback. | no | | | Used for an anchor tag's href. To display an email link, use a 'mailto:dest@domain.com' value. Else use a standard website. |
| HTTP_PROXY | HTTP proxy to use, e.g. the one from CDP. Currently used for Hapi Wreck. | no | | | |
| HTTPS_PROXY | HTTPS proxy to use, e.g. the one from CDP. Currently used for Hapi Wreck. | no | | | |
| NO_PROXY | HTTP proxy to use, e.g. the one from CDP. Currently used for Hapi Wreck. | no | | | |
| AWS_ACCESS_KEY_ID | AWS key id | yes | dummy | | |
| AWS_SECRET_ACCESS_KEY | AWS access key | yes | dummy | | |
| SNS_ENDPOINT | Endpoint for SNS messaging | yes | | | |
| SNS_ADAPTER_TOPIC_ARN | The SNS topic for the submission adapter - in Amazon Resource Name (ARN) format. | yes | | | |
| SNS_SAVE_TOPIC_ARN | The SNS topic for the save-and-exit - in Amazon Resource Name (ARN) format. | yes | | | |
| name | description | required | default | valid | notes |
| --------------------- | -------------------------------------------------------------------------------- | :------: | ------- | :-------------------------: | :---------------------------------------------------------------------------------------------------------------------: |
| NODE_ENV | Node environment | no | | development,test,production | |
| PORT | Port number | no | 3009 | | |
| NOTIFY_TEMPLATE_ID | Notify api key | yes | | | Template ID required to send form payloads via [GOV.UK Notify](https://www.notifications.service.gov.uk) email service. |
| NOTIFY_API_KEY | Notify api key | yes | | | API KEY required to send form payloads via [GOV.UK Notify](https://www.notifications.service.gov.uk) email service. |
| LOG_LEVEL | Log level | no | debug | trace,debug,info,error | |
| PHASE_TAG | Tag to use for phase banner | no | beta | alpha, beta, empty string | |
| HTTP_PROXY | HTTP proxy to use, e.g. the one from CDP. Currently used for Hapi Wreck. | no | | | |
| HTTPS_PROXY | HTTPS proxy to use, e.g. the one from CDP. Currently used for Hapi Wreck. | no | | | |
| NO_PROXY | HTTP proxy to use, e.g. the one from CDP. Currently used for Hapi Wreck. | no | | | |
| AWS_ACCESS_KEY_ID | AWS key id | yes | dummy | | |
| AWS_SECRET_ACCESS_KEY | AWS access key | yes | dummy | | |
| SNS_ENDPOINT | Endpoint for SNS messaging | yes | | | |
| SNS_ADAPTER_TOPIC_ARN | The SNS topic for the submission adapter - in Amazon Resource Name (ARN) format. | yes | | | |
| SNS_SAVE_TOPIC_ARN | The SNS topic for the save-and-exit - in Amazon Resource Name (ARN) format. | yes | | | |

For proxy options, see https://www.npmjs.com/package/proxy-from-env which is used by https://github.com/TooTallNate/proxy-agents/tree/main/packages/proxy-agent.

Expand All @@ -207,7 +206,6 @@ MANAGER_URL=http://localhost:3001
BASE_URL=http://localhost:3009
NOTIFY_TEMPLATE_ID=<notify-template-id>
NOTIFY_API_KEY=<notify-api-key>
FEEDBACK_LINK=http://test.com
DESIGNER_URL=http://localhost:3000
SUBMISSION_URL=http://localhost:3002
UPLOADER_BUCKET_NAME=my-bucket
Expand Down
1 change: 0 additions & 1 deletion jest.setup.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ process.env.REDIS_USERNAME = 'dummy'
process.env.SESSION_COOKIE_PASSWORD = 'test-env-session-cookie-password'
process.env.NOTIFY_TEMPLATE_ID = 'dummy'
process.env.NOTIFY_API_KEY = 'dummy'
process.env.FEEDBACK_LINK = 'https://test.defra.gov.uk/'
process.env.DESIGNER_URL = 'https://forms-designer'
process.env.SUBMISSION_URL = 'https://test-submission-api.cdp-int.defra.cloud'
process.env.UPLOADER_URL = 'https://test-uploader.cdp-int.defra.cloud'
Expand Down
46 changes: 10 additions & 36 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading