From 62e5361b0c77b07b33edb17c072bcbd88b57a840 Mon Sep 17 00:00:00 2001 From: Leo Hemsted Date: Wed, 24 Aug 2016 15:00:09 +0100 Subject: [PATCH] cleaned up environment file * sorted list in README and environment_test.sh * removed some unused vars * cleaned up some names to be more accurate in the readme * removed twilio as a dependency --- README.md | 26 +++++++++++++++----------- config.py | 1 - environment_test.sh | 5 ++--- requirements.txt | 1 - 4 files changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8d31a6be3..018c372de 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Get and update notification status. 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. +Creating the environment.sh file. Replace [unique-to-environment] with your something unique to the environment. Your AWS credentials should be set up for notify-tools (the development/CI AWS account). Create a local environment.sh file containing the following: @@ -24,30 +24,34 @@ Create a local environment.sh file containing the following: echo " export NOTIFY_ENVIRONMENT='development' export ADMIN_BASE_URL='http://localhost:6012' -export ADMIN_CLIENT_SECRET='dev-notify-secret-key' export ADMIN_CLIENT_USER_NAME='dev-notify-admin' +export ADMIN_CLIENT_SECRET='dev-notify-secret-key' +export API_HOST_NAME='http://localhost:6011' + export AWS_REGION='eu-west-1' +export AWS_ACCESS_KEY_ID=[MY ACCESS KEY] +export AWS_SECRET_ACCESS_KEY=[MY SECRET] + export DANGEROUS_SALT='dev-notify-salt' export FIRETEXT_API_KEY=[contact team member for api key] -export INVITATION_EMAIL_FROM='invites@notifications.service.gov.uk' +export FROM_NUMBER='40605' +export INVITATION_EMAIL_FROM='invites' export INVITATION_EXPIRATION_DAYS=2 -export NOTIFY_EMAIL_DOMAIN='notify.works' -export NOTIFY_JOB_QUEUE='[unique-to-environment]-notify-jobs-queue' # NOTE unique prefix -export NOTIFICATION_QUEUE_PREFIX='[unique-to-environment]-notification_development' # NOTE unique prefix +export MMG_API_KEY=mmg=secret-key +export MMG_URL="https://api.mmg.co.uk/json/api.php" +export NOTIFICATION_QUEUE_PREFIX='[unique-to-environment]' # +export NOTIFY_EMAIL_DOMAIN='notify.tools' export SECRET_KEY='dev-notify-secret-key' export SQLALCHEMY_DATABASE_URI='postgresql://localhost/notification_api' -export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.works' -export MMG_API_KEY=mmg=secret-key export STATSD_ENABLED=True export STATSD_HOST="localhost" export STATSD_PORT=1000 export STATSD_PREFIX="stats-prefix" -export FROM_NUMBER='from_number' +export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.tools' "> 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. +NOTE: The SECRET_KEY and DANGEROUS_SALT should match those in the [notifications-admin](https://github.com/alphagov/notifications-admin) app. NOTE: Also note the unique prefix for the queue names. This prevents clashing with others queues in shared amazon environment and using a prefix enables filtering by queue name in the SQS interface. diff --git a/config.py b/config.py index d8067dc53..6e569bb23 100644 --- a/config.py +++ b/config.py @@ -15,7 +15,6 @@ class Config(object): INVITATION_EMAIL_FROM = os.environ['INVITATION_EMAIL_FROM'] NOTIFY_APP_NAME = 'api' NOTIFY_LOG_PATH = '/var/log/notify/application.log' - NOTIFY_JOB_QUEUE = os.environ['NOTIFY_JOB_QUEUE'] # Notification Queue names are a combination of a prefix plus a name NOTIFICATION_QUEUE_PREFIX = os.environ['NOTIFICATION_QUEUE_PREFIX'] SECRET_KEY = os.environ['SECRET_KEY'] diff --git a/environment_test.sh b/environment_test.sh index d4665632b..c265171d5 100644 --- a/environment_test.sh +++ b/environment_test.sh @@ -7,11 +7,10 @@ export AWS_REGION='eu-west-1' export DANGEROUS_SALT='dangerous-salt' export INVITATION_EMAIL_FROM='invites' export INVITATION_EXPIRATION_DAYS=2 -export NOTIFY_JOB_QUEUE='notify-jobs-queue-test' -export NOTIFICATION_QUEUE_PREFIX='notification_development-test' +export NOTIFICATION_QUEUE_PREFIX='test-env-not-used' export SECRET_KEY='secret-key' export SQLALCHEMY_DATABASE_URI=${TEST_DATABASE:='postgresql://localhost/test_notification_api'} -export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.works' +export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.tools' export FIRETEXT_API_KEY="Firetext" export NOTIFY_EMAIL_DOMAIN="test.notify.com" export MMG_API_KEY='mmg-secret-key' diff --git a/requirements.txt b/requirements.txt index 904bd6e3e..f3fa950eb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -16,7 +16,6 @@ credstash==1.8.0 boto3==1.2.3 boto==2.39.0 celery==3.1.20 -twilio==4.6.0 monotonic==0.3 statsd==3.2.1