diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..44aa200 --- /dev/null +++ b/.env.example @@ -0,0 +1,32 @@ +# Database credentials +DB_NAME=name # Look for "database" or "schema" +DB_USER=user +DB_PASSWORD=password +DB_HOST=hostname +DB_PORT=port + +# Email server configuration with AWS SES, can be left as placeholders if not sending emails +AWS_SES_ACCESS_KEY_ID=access_key_id +AWS_SES_SECRET_ACCESS_KEY=secret_access_key +AWS_SES_REGION_NAME=region_name +AWS_SES_REGION_ENDPOINT=region_endpoint +DEFAULT_FROM_EMAIL=email + +# The URL of the site, used for generating links +BASE_URL=url + +# The folder where logs will be stored +LOG_DIR=filepath + +# Comma-separated list of admin email addresses in case anything goes wrong +ADMIN_EMAILS=email,email + +# Secret key for Django data signing, can stay a placeholder for development +SECRET_KEY=django-secret-key + +# Whether to actually send emails +# If false, the important content from the emails will be logged +SEND_EMAILS=False + +# Enable debug mode, important to have this false in production for security +DEBUG=True diff --git a/example.env b/example.env deleted file mode 100644 index 7b5a5ca..0000000 --- a/example.env +++ /dev/null @@ -1,15 +0,0 @@ -DB_NAME=name -DB_USER=user -DB_PASSWORD=password -DB_HOST=hostname -DB_PORT=port -AWS_SES_ACCESS_KEY_ID=access_key_id -AWS_SES_SECRET_ACCESS_KEY=secret_access_key -AWS_SES_REGION_NAME=region_name -AWS_SES_REGION_ENDPOINT=region_endpoint -DEFAULT_FROM_EMAIL=email -BASE_URL=url -LOG_DIR=filepath -ADMIN_EMAILS=email,email -SEND_EMAILS=False -DEBUG=True