breccia-mapper/deploy/deploy-ansible/example.env

# REQUIRED=Secret key
# Used to generate CSRF tokens - must never be made public
SECRET_KEY=changeme

# REQUIRED=Database password
# The password for the breccia-mapper user in the postgres database
DB_PASSWORD=changeme

# REQUIRED=Google Maps API key
# Google Maps API key to display maps of people's locations - required to enable map functionality
# Default: None
# GOOGLE_MAPS_API_KEY=None

# Debug
# Should the server run in debug mode?  Provides information to users which is unsafe in production
# Default: False
DEBUG=False

# Project long name
# The project's full name.
# Default: Project Network Mapper
# PROJECT_LONG_NAME=Project Network Mapper

# Project short name
# The project's short/abbreviated name. This will also be used as the app's name when installed as PWA.
# Default: Network Mapper
# PROJECT_SHORT_NAME=Network Mapper

# Project description
# The project's description. Used when installed as a PWA.
# Default: Application to map network relationships in the organisation.
# PROJECT_DESCRIPTION=Application to map network relationships in the organisation.

# Theme color
# The project's theme color, in hex format (excluding the leading #).
# Default: 212121
# THEME_COLOR=212121

# Background color
# The project's background color, in hex format (excluding the leading #).
# Default: ffffff
# BACKGROUND_COLOR=ffffff

# Allowed hosts
# Accepted values for server header in request - protects against CSRF and CSS attacks
# Default: * if DEBUG else localhost
# ALLOWED_HOSTS=127.0.0.1,localhost,localhost.localdomain

# Site URL
# The URL the site will be deployed on. Do not include http://, https://, or a trailing slash.
# Default: localhost
# SITE_URL=localhost

# Site protocol
# The protocol the site uses. Valid options are http or https.
# Default: http
# SITE_PROTOCOL=http

# Trusted origins
# The trusted origin domains of requests - protects against CSRF and CSS attacks
# Default: '*' if DEBUG else 'http://127.0.0.1,http://localhost,http://localhost.localdomain'
# TRUSTED_ORIGINS=http://127.0.0.1,http://localhost,http://localhost.localdomain

# Database backup storage location
# Directory where database backups should be stored
# Default: .dbbackup
# DBBACKUP_STORAGE_LOCATION=.dbbackup

# Default language
# Default language - used for translation - has not been enabled
# Default: en-gb
# LANGUAGE_CODE=en-gb

# Timezone
# Default timezone
# Default: UTC
# TIME_ZONE=UTC

# Logging level
# Level of messages written to log file
# Default: INFO
# LOG_LEVEL=INFO

# Logging filename
# Path to logfile
# Default: debug.log
# LOG_FILENAME=debug.log

# Logging duration
# Number of days of logs to keep - logfile is rotated out at the end of each day
# Default: 14
# LOG_DAYS=14

# STMP host
# Hostname of SMTP server
# Default: None
# EMAIL_HOST=None

# Default from email address
# Email address from which messages are sent
# Default: None
# DEFAULT_FROM_EMAIL=None

# [DEBUG ONLY] Email file path
# Directory where emails will be stored if not using an SMTP server
# Default: mail.log
# EMAIL_FILE_PATH=mail.log

# SMTP username
# Username to authenticate with SMTP server
# Default: None
# EMAIL_HOST_USER=None

# SMTP password
# Password to authenticate with SMTP server
# Default: None
# EMAIL_HOST_PASSWORD=None

# SMTP port
# Port to access on SMTP server
# Default: 25
# EMAIL_PORT=25

# SMTP use TLS
# Use TLS to communicate with SMTP server?  Usually on port 587
# Cannot be enabled at the same time as EMAIL_USE_SSL
# Default: True if EMAIL_PORT == 587 else False
# EMAIL_USE_TLS=True if EMAIL_PORT == 587 else False

# SMTP use SSL
# Use SSL to communicate with SMTP server?  Usually on port 465
# Cannot be enabled at the same time as EMAIL_USE_TLS
# Default: True if EMAIL_PORT == 465 else False
# EMAIL_USE_SSL=True if EMAIL_PORT == 465 else False