From 2d714cae39560a176819884e118f7dd5dd02bd5a Mon Sep 17 00:00:00 2001 From: dandds Date: Thu, 5 Dec 2019 13:08:18 -0500 Subject: [PATCH] Add some missing configuration settings. These settings are used in the deployed instance and mentioned elsewhere in the README, but were missing from the base INI file and the Configuration Guide section of the README. --- .secrets.baseline | 4 ++-- README.md | 17 ++++++++++------- config/base.ini | 8 ++++++++ 3 files changed, 20 insertions(+), 9 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index 49a70104..385c0b04 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "^.secrets.baseline$|^.*pgsslrootcert.yml$", "lines": null }, - "generated_at": "2019-12-03T19:44:47Z", + "generated_at": "2019-12-05T17:54:05Z", "plugins_used": [ { "base64_limit": 4.5, @@ -98,7 +98,7 @@ "hashed_secret": "afc848c316af1a89d49826c5ae9d00ed769415f3", "is_secret": false, "is_verified": false, - "line_number": 21, + "line_number": 29, "type": "Secret Keyword" } ], diff --git a/README.md b/README.md index 44749862..9c31fc19 100644 --- a/README.md +++ b/README.md @@ -168,12 +168,7 @@ Testing file uploads and downloads locally requires a few configuration options. In the flask config (`config/base.ini`, perhaps): ``` -CSP= - -AWS_REGION_NAME="" -AWS_ACCESS_KEY="" -AWS_SECRET_KEY="" -AWS_BUCKET_NAME="" +CSP=< azure | mock> AZURE_STORAGE_KEY="" AZURE_ACCOUNT_NAME="" @@ -183,7 +178,7 @@ AZURE_TO_BUCKET_NAME="" There are also some build-time configuration that are used by parcel. Add these to `.env.local`, and run `rm -r .cache/` before running `yarn build`: ``` -CLOUD_PROVIDER= +CLOUD_PROVIDER= AZURE_ACCOUNT_NAME="" AZURE_CONTAINER_NAME="" ``` @@ -223,6 +218,9 @@ To generate coverage reports for the Javascript tests: ## Configuration - `ASSETS_URL`: URL to host which serves static assets (such as a CDN). +- `AZURE_ACCOUNT_NAME`: The name for the Azure blob storage account +- `AZURE_STORAGE_KEY`: A valid secret key for the Azure blob storage account +- `AZURE_TO_BUCKET_NAME`: The Azure blob storage container name for task order uploads - `BLOB_STORAGE_URL`: URL to Azure blob storage container. - `CAC_URL`: URL for the CAC authentication route. - `CA_CHAIN`: Path to the CA chain file. @@ -238,6 +236,11 @@ To generate coverage reports for the Javascript tests: - `ENVIRONMENT`: String specifying the current environment. Acceptable values: "dev", "prod". - `LIMIT_CONCURRENT_SESSIONS`: Boolean specifying if users should be allowed only one active session at a time. - `LOG_JSON`: Boolean specifying whether app should log in a json format. +- `MAIL_PASSWORD`: String. Password for the SMTP server. +- `MAIL_PORT`: Integer. Port to use on the SMTP server. +- `MAIL_SENDER`: String. Email address to send outgoing mail from. +- `MAIL_SERVER`: The SMTP host +- `MAIL_TLS`: Boolean. Use TLS to connect to the SMTP server. - `PERMANENT_SESSION_LIFETIME`: Integer specifying how many seconds a user's session can stay valid for. https://flask.palletsprojects.com/en/1.1.x/config/#PERMANENT_SESSION_LIFETIME - `PGDATABASE`: String specifying the name of the postgres database. - `PGHOST`: String specifying the hostname of the postgres database. diff --git a/config/base.ini b/config/base.ini index ade3abe1..2cc8fd93 100644 --- a/config/base.ini +++ b/config/base.ini @@ -1,5 +1,8 @@ [default] ASSETS_URL +AZURE_ACCOUNT_NAME +AZURE_STORAGE_KEY +AZURE_TO_BUCKET_NAME BLOB_STORAGE_URL=http://localhost:8000/ CAC_URL = http://localhost:8000/login-redirect CA_CHAIN = ssl/server-certs/ca-chain.pem @@ -15,6 +18,11 @@ DISABLE_CRL_CHECK = false ENVIRONMENT = dev LIMIT_CONCURRENT_SESSIONS = false LOG_JSON = false +MAIL_PASSWORD +MAIL_PORT +MAIL_SENDER +MAIL_SERVER +MAIL_TLS PERMANENT_SESSION_LIFETIME = 1800 PGDATABASE = atat PGHOST = localhost