From 8b4641021af6c73e7dd40a23ff31ac4aefa870bc Mon Sep 17 00:00:00 2001 From: Rebecca Law Date: Wed, 17 Feb 2016 09:49:36 +0000 Subject: [PATCH] Update README with set up instructions. --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 38ff703dc..0b30e9f11 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,29 @@ Application for the notification api. Read and write notifications/status queue. Get and update notification status. -mkvirtualenv -p /usr/local/bin/python3 notifications-api - +## Setting Up ``` +mkvirtualenv -p /usr/local/bin/python3 notifications-api +``` + +Creating the environment.sh file. Replace [unique-to-environment] with your something unique to the environment. The local development environments are using the AWS on preview. + +``` +echo " export ADMIN_CLIENT_USER_NAME = 'dev-notify-admin' export ADMIN_CLIENT_SECRET = 'dev-notify-secret-key' export AWS_REGION='eu-west-1' export DANGEROUS_SALT = 'dangerous-salt' export DELIVERY_CLIENT_USER_NAME='dev-notify-delivery' export DELIVERY_CLIENT_SECRET='dev-notify-secret-key' - -export NOTIFY_JOB_QUEUE='notify-jobs-queue-[-unique-to-environment]' -export NOTIFICATION_QUEUE_PREFIX='notification_development[-unique-to-environment]' - +export NOTIFY_JOB_QUEUE='[unique-to-environment]-notify-jobs-queue' +export NOTIFICATION_QUEUE_PREFIX='[unique-to-environment]-notification_development' export SECRET_KEY = 'secret-key' export SQLALCHEMY_DATABASE_URI = 'postgresql://localhost/notification_api' -export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.works' -``` \ No newline at end of file +export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.works' +"> environment.sh +``` + +NOTE: the DELIVERY_CLIENT_USER_NAME, DELIVERY_CLIENT_SECRET, NOTIFY_JOB_QUEUE and NOTIFICATION_QUEUE_PREFIX must be the same as the ones in the [notifications-delivery](https://github.com/alphagov/notifications-delivery) app. +The SECRET_KEY and DANGEROUS_SALT are the same in [notifications-delivery](https://github.com/alphagov/notifications-delivery) and [notifications-admin](https://github.com/alphagov/notifications-admin) app \ No newline at end of file