mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-16 02:02:13 -05:00
7c1fa1bd75
This changeset updates the README.md file with a set of entirely new instructions. These updates are intended to improve clarity, simplify steps, and reduce confusion and environment-setup gotchas that folks have run into previously and we have learned from. A couple of other changes are also included: - Minor adjustments to the Makefile to improve make bootstrap - Updates to the sample.env file to include previously missing required environment variables Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
59 lines
1.7 KiB
Bash
59 lines
1.7 KiB
Bash
# See README.md for local setup instructions
|
|
|
|
# ## REBUILD THE DEVCONTAINER WHEN YOU MODIFY .ENV ###
|
|
|
|
#############################################################
|
|
|
|
# AWS
|
|
AWS_US_TOLL_FREE_NUMBER=+18556438890
|
|
|
|
#############################################################
|
|
|
|
# Local Docker setup, all overwritten in cloud.gov
|
|
# ADMIN_BASE_URL=http://admin:6012
|
|
# API_HOST_NAME=http://dev:6011
|
|
# REDIS_URL=redis://redis:6380
|
|
# DATABASE_URL=postgresql://postgres:chummy@db:5432/notification_api
|
|
# SQLALCHEMY_DATABASE_TEST_URI=postgresql://postgres:chummy@db:5432/test_notification_api
|
|
|
|
|
|
# If you want to do local development with localstack copy this to your .env file and uncomment it
|
|
# LOCALSTACK_ENDPOINT_URL=http://localhost:4566
|
|
|
|
# Local direct setup, all overwritten in cloud.gov
|
|
ADMIN_BASE_URL=http://localhost:6012
|
|
API_HOST_NAME=http://localhost:6011
|
|
REDIS_URL=redis://localhost:6379
|
|
DATABASE_URL=postgresql://localhost:5432/notification_api
|
|
SQLALCHEMY_DATABASE_TEST_URI=postgresql://localhost:5432/test_notification_api
|
|
|
|
#############################################################
|
|
|
|
# Debug
|
|
DEBUG=True
|
|
ANTIVIRUS_ENABLED=0
|
|
REDIS_ENABLED=1
|
|
NOTIFY_ENVIRONMENT=development
|
|
SES_STUB_URL=None
|
|
NOTIFY_APP_NAME=api
|
|
|
|
#############################################################
|
|
|
|
# E2E Testing
|
|
|
|
NOTIFY_E2E_TEST_EMAIL=example@fake.gov
|
|
NOTIFY_E2E_TEST_PASSWORD="don't write secrets to the sample file"
|
|
|
|
#############################################################
|
|
|
|
# Flask
|
|
FLASK_APP=application.py
|
|
FLASK_DEBUG=true
|
|
WERKZEUG_DEBUG_PIN=off
|
|
|
|
#############################################################
|
|
|
|
# New Relic
|
|
NEW_RELIC_CONFIG_FILE=newrelic.ini
|
|
NEW_RELIC_LICENSE_KEY="don't write secrets to the sample file"
|