Configuration is by environment variables that override the defaults.
| Name | Description | Example / default |
|---|---|---|
| TOKEN_KEY | docker - key within the user definition of the \$TOKEN_NAME | api-key |
| TOKEN_NAME | docker - user name of the user that the redis backend uses for scheduled jobs | api-user |
| AWS_SECRET_NAMES | Space separated list of AWS secret stores, not arn! | |
| FLASK_DEBUG | True when debugging or developing app | |
| SERVER_PORT | Port exposed in docker container | 80 |
| DATABASE_URL | location of the application database | |
| CLIENT_SECRETS_JSON | location of the OAUTH2 configuration file | |
| MAIL_PASSWORD | password of the mail user | fake |
| MAIL_SERVER | DNS of the mail server | |
| MAIL_USER_NAME | user name to use mail server | andrew.rowe@example.com |
| REDIS_URL | location of queue server. | redis://localhost:6379 |
| REDIS_JOB_TIMEOUT_SECONDS | Number of seconds to timeout a job, ten hours default | 36000 |
| REGION_NAME | Region name for getting AWS secrets. | ap-southeast-2 |
| RESULT_PAGE_SIZE | Number of SQL results in each display page | 10000 |
| RESULT_CACHE_MINUTES | Number of minutes to retain results in server cache | 1 |
| DB_READY_RETRIES | number of retries waiting for local admin db to be ready | 20 |
| DB_READY_SLEEP_SECONDS | number of seconds per retry to wait for local admin db to be ready | 6 |
| DB_FAILING_SECONDS | number of seconds to wait to see if balance server recovers | 300 |
| CUSTOM_TITLE | Title to show app name | Secure Reporter Dev |
| CUSTOM_LOGIN_HTML | HTML Prompt to show on the login screen | Login required to access reports. |
| CUSTOM_LOGIN_INFORMATION_HTML | HTML Information to display if login problems occur | |
| CUSTOM_HOSTNAME | Hostname for the operating instance. Available in report SQL as | localhost |
| CUSTOM_FAVICON_FILE | favicon.ico file | logo.png |
| CUSTOM_CSS | Custom CSS file | |
| CUSTOM_ADMIN_USERS | CSV list of emails that should be in the admin groups | bab@flong.com,dav@flong.com |
| CUSTOM_ADMIN_GROUP | Name of the group that is the admin | admin |
| CUSTOM_DEFAULT_GROUPS | CSV List of default groups to assign to a new user if groups is not in Single Sign on claim | * |
| CUSTOM_FEATURES | CSV List of features to enable | mail,schedule,excel,audit,post_url |
| CUSTOM_REPORT_AUDIT_AGE_DAYS | Number of days to retain report audit records | 45 |
| CUSTOM_GET_GROUP_SCRIPT | Script to run to return a csv list of groups for the logging in user | 45 |
| PROMOTION_TOKEN_NAME | Name of the token on the promotion host | promotion-key |
| PROMOTION_TOKEN_KEY | Value of the token on the promotion host | 45439809383490348 |
| PROMOTION_HOST | Server address of the promotion host | https://secure-reporter-production.company.com |
| PROMOTION_APPROVERS | List of email addresses that can do reviews. | https://secure-reporter-production.company.com |
| LOGIN_TIMEOUT_SECONDS | Number of seconds to keep a login valid. Defaults to one year. | 365 * 60 * 24 * 60 |