mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-17 18:52:30 -05:00
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
This commit is contained in:
26
README.md
26
README.md
@@ -16,7 +16,7 @@ Get and update notification status.
|
|||||||
mkvirtualenv -p /usr/local/bin/python3 notifications-api
|
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:
|
Create a local environment.sh file containing the following:
|
||||||
|
|
||||||
@@ -24,30 +24,34 @@ Create a local environment.sh file containing the following:
|
|||||||
echo "
|
echo "
|
||||||
export NOTIFY_ENVIRONMENT='development'
|
export NOTIFY_ENVIRONMENT='development'
|
||||||
export ADMIN_BASE_URL='http://localhost:6012'
|
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_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_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 DANGEROUS_SALT='dev-notify-salt'
|
||||||
export FIRETEXT_API_KEY=[contact team member for api key]
|
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 INVITATION_EXPIRATION_DAYS=2
|
||||||
export NOTIFY_EMAIL_DOMAIN='notify.works'
|
export MMG_API_KEY=mmg=secret-key
|
||||||
export NOTIFY_JOB_QUEUE='[unique-to-environment]-notify-jobs-queue' # NOTE unique prefix
|
export MMG_URL="https://api.mmg.co.uk/json/api.php"
|
||||||
export NOTIFICATION_QUEUE_PREFIX='[unique-to-environment]-notification_development' # NOTE unique prefix
|
export NOTIFICATION_QUEUE_PREFIX='[unique-to-environment]' #
|
||||||
|
export NOTIFY_EMAIL_DOMAIN='notify.tools'
|
||||||
export SECRET_KEY='dev-notify-secret-key'
|
export SECRET_KEY='dev-notify-secret-key'
|
||||||
export SQLALCHEMY_DATABASE_URI='postgresql://localhost/notification_api'
|
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_ENABLED=True
|
||||||
export STATSD_HOST="localhost"
|
export STATSD_HOST="localhost"
|
||||||
export STATSD_PORT=1000
|
export STATSD_PORT=1000
|
||||||
export STATSD_PREFIX="stats-prefix"
|
export STATSD_PREFIX="stats-prefix"
|
||||||
export FROM_NUMBER='from_number'
|
export VERIFY_CODE_FROM_EMAIL_ADDRESS='no-reply@notify.tools'
|
||||||
"> environment.sh
|
"> 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.
|
NOTE: The SECRET_KEY and DANGEROUS_SALT should match those in the [notifications-admin](https://github.com/alphagov/notifications-admin) 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: 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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ class Config(object):
|
|||||||
INVITATION_EMAIL_FROM = os.environ['INVITATION_EMAIL_FROM']
|
INVITATION_EMAIL_FROM = os.environ['INVITATION_EMAIL_FROM']
|
||||||
NOTIFY_APP_NAME = 'api'
|
NOTIFY_APP_NAME = 'api'
|
||||||
NOTIFY_LOG_PATH = '/var/log/notify/application.log'
|
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 names are a combination of a prefix plus a name
|
||||||
NOTIFICATION_QUEUE_PREFIX = os.environ['NOTIFICATION_QUEUE_PREFIX']
|
NOTIFICATION_QUEUE_PREFIX = os.environ['NOTIFICATION_QUEUE_PREFIX']
|
||||||
SECRET_KEY = os.environ['SECRET_KEY']
|
SECRET_KEY = os.environ['SECRET_KEY']
|
||||||
|
|||||||
@@ -7,11 +7,10 @@ export AWS_REGION='eu-west-1'
|
|||||||
export DANGEROUS_SALT='dangerous-salt'
|
export DANGEROUS_SALT='dangerous-salt'
|
||||||
export INVITATION_EMAIL_FROM='invites'
|
export INVITATION_EMAIL_FROM='invites'
|
||||||
export INVITATION_EXPIRATION_DAYS=2
|
export INVITATION_EXPIRATION_DAYS=2
|
||||||
export NOTIFY_JOB_QUEUE='notify-jobs-queue-test'
|
export NOTIFICATION_QUEUE_PREFIX='test-env-not-used'
|
||||||
export NOTIFICATION_QUEUE_PREFIX='notification_development-test'
|
|
||||||
export SECRET_KEY='secret-key'
|
export SECRET_KEY='secret-key'
|
||||||
export SQLALCHEMY_DATABASE_URI=${TEST_DATABASE:='postgresql://localhost/test_notification_api'}
|
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 FIRETEXT_API_KEY="Firetext"
|
||||||
export NOTIFY_EMAIL_DOMAIN="test.notify.com"
|
export NOTIFY_EMAIL_DOMAIN="test.notify.com"
|
||||||
export MMG_API_KEY='mmg-secret-key'
|
export MMG_API_KEY='mmg-secret-key'
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ credstash==1.8.0
|
|||||||
boto3==1.2.3
|
boto3==1.2.3
|
||||||
boto==2.39.0
|
boto==2.39.0
|
||||||
celery==3.1.20
|
celery==3.1.20
|
||||||
twilio==4.6.0
|
|
||||||
monotonic==0.3
|
monotonic==0.3
|
||||||
statsd==3.2.1
|
statsd==3.2.1
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user