Skip to content

Example Env File

Robin Lafontaine edited this page Feb 13, 2025 · 2 revisions
#################################################
# ********* Authentication Credentials **********
#################################################

# Required: Authentication DB User and Password
AUTH_PG_USER= #postgres
AUTH_PG_PASSWORD= #password

# Optional: Email & password for default Admin account, defaults to admin@example.com:password
# NOTE: You will be forced to change the password after 1st login
DEFAULT_ADMIN_EMAIL= #admin@example.com
DEFAULT_ADMIN_PASSWORD= #password

# Optional: Comma separated list of allowed email domains for user registration
ALLOWED_EMAIL_DOMAINS= #example.com,mail.com

##################################################
# ******** Formation Database Credentials ********
##################################################

# Required: Formation DB User and Password
FORMATION_PG_USER= #postgres
FORMATION_PG_PASSWORD= #password

##################################################
# ********** SMTP Server Configuration ***********
##################################################

# Required: SMTP Username and Password
SMTP_MAIL_USERNAME= #sender@example.com
SMTP_MAIL_PASSWORD= #1234

# Optional: SMTP Host, if not provided, mailserver will be used
SMTP_HOST= #mailserver

# Optional: SMTP Port, if not provided, 25 will be used
SMTP_PORT= #25

# Optional: Email from address, if not provided, sender@example.com will be used
SMTP_FROM= #sender@example.com

# Optional: Enable TLS, if not provided, false will be used
SMTP_ENABLE_TLS= #false

##################################################
# *************** S3 Configuration ***************
##################################################

# Required: Access Key and Secret Key
S3_ACCESS_KEY= #accesskey
S3_SECRET_KEY= #supersecretkey

# Optional: External endpoint, if not provided, local S3 will be used
S3_ENDPOINT=

# Optional: Bucket, if not provided, local S3 'assets' will be used
S3_BUCKET=

##################################################
# ************ GoPhish Configuration *************
##################################################

# Required: GoPhish API Key
GOPHISH_API_KEY= #supersecretapikey

# Required: TRUE if TLS disabled, else FALSE (WARNING: Case sensitive)
IGNORE_TLS_ERRORS= #TRUE

##################################################
# ************* Proxy Configuration **************
##################################################

# Optional: Sets `client_max_body_size` in MB, defaults to 500
MAX_UPLOAD_SIZE_MB= #500

Clone this wiki locally