app-MAIL-temp/example.env

177 lines
5.1 KiB
Bash
Raw Normal View History

# This file contains all available options in SimpleLogin.
# Some are optional and are commented out by default.
# Some are only relevant for our SaaS version, for example for payment integration, analytics, etc.
# Server url
2019-08-17 12:26:37 +02:00
URL=http://localhost:7777
2019-12-16 18:30:17 +01:00
# If you want to enable sentry for error tracking, put your sentry dsn here.
# SENTRY_DSN=your_sentry_dsn
2019-07-22 12:14:02 +02:00
# Possible to use another sentry project for the front-end to avoid noises
# If not set, fallback to SENTRY_DSN
# SENTRY_FRONT_END_DSN=your_sentry_dsn
2019-12-16 18:36:59 +01:00
# apply colored log to facilitate local development
# COLOR_LOG=true
2019-12-16 18:36:59 +01:00
# Only print email content, not sending it, for local development
NOT_SEND_EMAIL=true
2019-12-16 18:36:59 +01:00
# domain used to create alias
EMAIL_DOMAIN=sl.local
2019-12-16 18:36:59 +01:00
2020-05-07 13:28:04 +02:00
# Allow SimpleLogin to enforce SPF by using the extra headers from postfix
# ENFORCE_SPF=true
2020-05-07 13:28:04 +02:00
# other domains that can be used to create aliases, in addition to EMAIL_DOMAIN
# OTHER_ALIAS_DOMAINS=["domain1.com", "domain2.com"]
2020-05-25 19:51:30 +02:00
# domains that can be used to create aliases. If set, override OTHER_ALIAS_DOMAINS
# ALIAS_DOMAINS=["domain1.com", "domain2.com"]
2020-05-25 19:51:30 +02:00
2020-10-15 16:01:44 +02:00
# (optional) domains that are only available to premium accounts
# PREMIUM_ALIAS_DOMAINS=["premium.com"]
2020-10-15 16:01:44 +02:00
2020-04-15 22:36:50 +02:00
# the alias domain used when creating the first alias for user, default to EMAIL_DOMAIN if not set
# FIRST_ALIAS_DOMAIN = another-domain.com
# transactional email is sent from this email address
SUPPORT_EMAIL=support@sl.local
2020-01-28 03:29:04 +01:00
SUPPORT_NAME=Son from SimpleLogin
2020-06-10 13:54:42 +02:00
# To use VERP
# prefix must end with + and suffix must start with +
# BOUNCE_PREFIX = "bounces+"
# BOUNCE_SUFFIX = "+@sl.local"
2021-05-25 17:56:24 +02:00
# same as BOUNCE_PREFIX but used for reply phase. Note it doesn't have the plus sign (+) at the end.
# BOUNCE_PREFIX_FOR_REPLY_PHASE = "bounce_reply"
2019-12-16 18:36:59 +01:00
# to receive general stats.
# ADMIN_EMAIL=admin@sl.local
2019-07-22 12:14:02 +02:00
# Max number emails user can generate for free plan
# Set to 5 by default
# MAX_NB_EMAIL_FREE_PLAN=5
# Close registration. Avoid people accidentally creating new account on a self-hosted SimpleLogin
# DISABLE_REGISTRATION=1
2019-12-16 18:40:23 +01:00
# custom domain needs to point to these MX servers
EMAIL_SERVERS_WITH_PRIORITY=[(10, "email.hostname.")]
2019-12-16 18:40:23 +01:00
# these emails are ignored when computing stats
2019-12-16 18:40:23 +01:00
# IGNORED_EMAILS = ["my_email@domain.com"]
# By default, new aliases must end with ".{random_word}". This is to avoid a person taking all "nice" aliases.
# this option doesn't make sense in self-hosted. Set this variable to disable this option.
# DISABLE_ALIAS_SUFFIX=1
# If you want to use another MTA to send email, you could set the address of your MTA here
# By default, emails are sent using the the same Postfix server that receives emails
# POSTFIX_SERVER=my-postfix.com
2021-04-07 11:56:07 +02:00
# the DKIM private key used to compute DKIM-Signature
2021-03-08 15:18:03 +01:00
# DKIM_PRIVATE_KEY_PATH=local_data/dkim.key
2019-12-27 23:44:32 +01:00
# delete and recreate the sqlite database, for local development
RESET_DB=true
2019-12-16 18:40:23 +01:00
# DB Connection
2019-12-18 17:10:10 +01:00
# Local SQLite database
DB_URI=sqlite:///db.sqlite
2019-12-18 17:10:10 +01:00
# Postgres
# DB_URI=postgresql://myuser:mypassword@sl-db:5432/simplelogin
FLASK_SECRET=secret
# AWS params
# BUCKET=to_fill
# AWS_ACCESS_KEY_ID=to_fill
# AWS_SECRET_ACCESS_KEY=to_fill
# AWS_REGION=to_fill
# Paddle
# PADDLE_VENDOR_ID=123
# PADDLE_MONTHLY_PRODUCT_ID=123
# PADDLE_YEARLY_PRODUCT_ID=123
# PADDLE_PUBLIC_KEY_PATH=local_data/paddle.key.pub
# PADDLE_AUTH_CODE=123
2019-07-22 12:14:02 +02:00
# OpenId key
OPENID_PRIVATE_KEY_PATH=local_data/jwtRS256.key
OPENID_PUBLIC_KEY_PATH=local_data/jwtRS256.key.pub
2019-07-06 16:39:45 +02:00
2019-07-22 12:14:02 +02:00
# Words to generate random email alias
WORDS_FILE_PATH=local_data/words.txt
# Login with Github
# GITHUB_CLIENT_ID=to_fill
# GITHUB_CLIENT_SECRET=to_fill
# Login with Google
# GOOGLE_CLIENT_ID=to_fill
# GOOGLE_CLIENT_SECRET=to_fill
# Login with Facebook
# FACEBOOK_CLIENT_ID=to_fill
# FACEBOOK_CLIENT_SECRET=to_fill
# Flask profiler
# FLASK_PROFILER_PATH=/tmp/flask-profiler.sql
2020-03-08 11:54:59 +01:00
# FLASK_PROFILER_PASSWORD=password
# Where to store GPG Keyring
# GNUPGHOME=/tmp/gnupg
2020-03-13 14:37:48 +01:00
# By default, files are uploaded to s3
# Set this variable to use the local "static/upload/" directory instead
LOCAL_FILE_UPLOAD=true
2020-04-09 22:18:03 +02:00
# The landing page
2020-04-18 20:47:11 +02:00
# LANDING_PAGE_URL=https://simplelogin.io
2020-08-12 16:12:41 +02:00
# The status page
# STATUS_PAGE_URL=https://status.simplelogin.io
2020-04-18 20:47:11 +02:00
# Used when querying info on Apple API
2020-04-29 15:47:03 +02:00
# APPLE_API_SECRET=secret
2020-05-10 14:43:41 +02:00
# MACAPP_APPLE_API_SECRET=secret
# Disable onboarding emails
# For self-hosted instance
2020-05-21 20:42:25 +02:00
DISABLE_ONBOARDING=true
# By default use postfix port 25. This param is used to override the Postfix port,
# useful when using another SMTP server when developing locally
# POSTFIX_PORT=1025
# set the 2 below variables to enable hCaptcha
# HCAPTCHA_SECRET=very_long_string
2020-08-12 15:24:34 +02:00
# HCAPTCHA_SITEKEY=00000000-0000-0000-0000-000000000000
# Set the 2 below variables to enable Plausible Analytics
# PLAUSIBLE_HOST=https://plausible.io
2020-08-15 16:33:48 +02:00
# PLAUSIBLE_DOMAIN=yourdomain.com
# Spamassassin server
# SPAMASSASSIN_HOST = 127.0.0.1
# if set, used to sign the forwarding emails
# PGP_SENDER_PRIVATE_KEY_PATH=local_data/private-pgp.asc
# Coinbase
# COINBASE_WEBHOOK_SECRET=to_fill
# COINBASE_CHECKOUT_ID=to_fill
# COINBASE_API_KEY=to_fill
2021-03-26 09:56:04 +01:00
# COINBASE_YEARLY_PRICE=30.00
# set the frequency limit on alias creation
2021-03-26 10:00:16 +01:00
# ALIAS_LIMIT = "100/day;50/hour;5/minute"
# whether to enable spam scan using SpamAssassin
2021-05-13 22:44:16 +02:00
# ENABLE_SPAM_ASSASSIN = 1
# Have I Been Pwned
# HIBP_SCAN_INTERVAL_DAYS = 7
# HIBP_API_KEYS=[]