diff --git a/Configuration.md b/Configuration.md index 9b74995..3675bbf 100644 --- a/Configuration.md +++ b/Configuration.md @@ -17,18 +17,18 @@ LISTMONK_db__password = "xxxx" ### List of environment variables -- `LISTMONK_address`: Interface and port where the app will run its webserver. Default: **"0.0.0.0:9000"** -- `LISTMONK_root`: Public root URL of the listmonk installation that'll be used in the messages for linking to images, unsubscribe page etc. Default: **"https://listmonk.mysite.com"** -- `LISTMONK_logo_url`: (Optional) full URL to the static logo to be displayed on user facing view such as the unsubscription page. eg: https://mysite.com/images/logo.svg. Default: **"https://listmonk.mysite.com/public/static/logo.png"** -- `LISTMONK_favicon_url`: (Optional) full URL to the static favicon to be displayed on user facing view such as the unsubscription page. eg: https://mysite.com/images/favicon.png. Default: **"https://listmonk.mysite.com/public/static/favicon.png"** -- `LISTMONK_from_email`: The default 'from' e-mail for outgoing e-mail campaigns. Default: **"listmonk \"** -- `LISTMONK_notify_emails`: List of e-mail addresses to which admin notifications such as import updates, campaign completion, failure etc. should be sent. To disable notifications, set an empty list, eg: notify_emails = []. Default: **["admin1@mysite.com", "admin2@mysite.com"]** -- `LISTMONK_concurrency`: Maximum concurrent workers that will attempt to send messages simultaneously. This should depend on the number of CPUs the machine has and also the number of simultaenous e-mails the mail server will. Default: **"100"** -- `LISTMONK_max_send_errors`: The number of errors (eg: SMTP timeouts while e-mailing) a running campaign should tolerate before it is paused for manual investigation or intervention. Set to 0 to never pause. Default: **"1000"** -- `LISTMONK_allow_blacklist`: Allow subscribers to unsubscribe from all mailing lists and mark themselves as blacklisted? Default: **"false"** -- `LISTMONK_allow_export`: Allow subscribers to export data recorded on them? Default: **"false"** -- `LISTMONK_exportable`: Items to include in the data export. [profile] Subscriber's profile including custom attributes [subscriptions] Subscriber's subscription lists (private list names are masked) [campaign_views] Campaigns the subscriber has viewed and the view counts [link_clicks] Links that the subscriber has clicked and the click counts. Default: **["profile", "subscriptions", "campaign_views", "link_clicks"]** -- `LISTMONK_allow_wipe`: Allow subscribers to delete themselves from the database? This deletes the subscriber and all their subscriptions. Their association to campaign views and link clicks are also removed while views and click counts remain (with no subscriber associated to them) so that stats and analytics aren't affected. Default: **"false"** +- `LISTMONK_app__address`: Interface and port where the app will run its webserver. Default: **"0.0.0.0:9000"** +- `LISTMONK_app__root`: Public root URL of the listmonk installation that'll be used in the messages for linking to images, unsubscribe page etc. Default: **"https://listmonk.mysite.com"** +- `LISTMONK_app__logo_url`: (Optional) full URL to the static logo to be displayed on user facing view such as the unsubscription page. eg: https://mysite.com/images/logo.svg. Default: **"https://listmonk.mysite.com/public/static/logo.png"** +- `LISTMONK_app__favicon_url`: (Optional) full URL to the static favicon to be displayed on user facing view such as the unsubscription page. eg: https://mysite.com/images/favicon.png. Default: **"https://listmonk.mysite.com/public/static/favicon.png"** +- `LISTMONK_app__from_email`: The default 'from' e-mail for outgoing e-mail campaigns. Default: **"listmonk \"** +- `LISTMONK_app__notify_emails`: List of e-mail addresses to which admin notifications such as import updates, campaign completion, failure etc. should be sent. To disable notifications, set an empty list, eg: notify_emails = []. Default: **["admin1@mysite.com", "admin2@mysite.com"]** +- `LISTMONK_app__concurrency`: Maximum concurrent workers that will attempt to send messages simultaneously. This should depend on the number of CPUs the machine has and also the number of simultaenous e-mails the mail server will. Default: **"100"** +- `LISTMONK_app__max_send_errors`: The number of errors (eg: SMTP timeouts while e-mailing) a running campaign should tolerate before it is paused for manual investigation or intervention. Set to 0 to never pause. Default: **"1000"** +- `LISTMONK_app__allow_blacklist`: Allow subscribers to unsubscribe from all mailing lists and mark themselves as blacklisted? Default: **"false"** +- `LISTMONK_app__allow_export`: Allow subscribers to export data recorded on them? Default: **"false"** +- `LISTMONK_app__exportable`: Items to include in the data export. [profile] Subscriber's profile including custom attributes [subscriptions] Subscriber's subscription lists (private list names are masked) [campaign_views] Campaigns the subscriber has viewed and the view counts [link_clicks] Links that the subscriber has clicked and the click counts. Default: **["profile", "subscriptions", "campaign_views", "link_clicks"]** +- `LISTMONK_app__allow_wipe`: Allow subscribers to delete themselves from the database? This deletes the subscriber and all their subscriptions. Their association to campaign views and link clicks are also removed while views and click counts remain (with no subscriber associated to them) so that stats and analytics aren't affected. Default: **"false"** - `LISTMONK_db__host`: Allows you to set the Postgres host path. Default: **"demo-db"** - `LISTMONK_db__port`: Set the port for the Postgres connection. Default: **"5432"**