darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-01-30 06:21:50 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clarify setup instructions for environment.sh

Browse Source
This commit is contained in:
Ben Thorner
2021-02-17 17:04:28 +00:00
parent de6ed47239
commit 273fd339ac
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -17,9 +17,7 @@ To run the API you will need appropriate AWS credentials. See the [Wiki](https:/
### `environment.sh`
Creating the environment.sh file. Replace [unique-to-environment] with your something unique to the environment.
Create a local environment.sh file containing the following:
Creating and edit an environment.sh file.
```
echo "
@@ -35,11 +33,14 @@ export WERKZEUG_DEBUG_PIN=off
"> environment.sh
```
NOTES:
Things to change:
* Replace the placeholder key and prefix values as appropriate
* The SECRET_KEY and DANGEROUS_SALT should match those in the [notifications-admin](https://github.com/alphagov/notifications-admin) app.
* The unique prefix for the queue names prevents clashing with others' queues in shared amazon environment and enables filtering by queue name in the SQS interface.
* Replace `YOUR_OWN_PREFIX` with `local_dev_<first name>`.
* Run the following in the credentials repo to get the API keys.
```
notify-pass credentials/providers/api_keys
```
### Postgres