listmonk/config.toml.sample

[app]
# Interface and port where the app will run its webserver.  The default value
# of localhost will only listen to connections from the current machine. To
# listen on all interfaces use '0.0.0.0'. To listen on the default web address
# port, use port 80 (this will require running with elevated permissions).
address = "localhost:9000"

# Database.
[db]
host = "localhost"
port = 5432
user = "listmonk"
password = "listmonk"

# Ensure that this database has been created in Postgres.
database = "listmonk"

ssl_mode = "disable"
max_open = 25
max_idle = 25
max_lifetime = "300s"

# Optional space separated Postgres DSN params. eg: "application_name=listmonk gssencmode=disable"
params = ""
Fresh start 2018-10-25 21:51:47 +08:00			`[app]`
Document tidbits about listening addresses for non-sysadmin types 2021-05-07 19:44:16 +08:00			`# Interface and port where the app will run its webserver. The default value`
			`# of localhost will only listen to connections from the current machine. To`
			`# listen on all interfaces use '0.0.0.0'. To listen on the default web address`
			`# port, use port 80 (this will require running with elevated permissions).`
Bind to ‘localhost’ instead of ‘0.0.0.0’ by default This is a small safety precaution to make sure the out of the box configuration is not world routeable. Bringing this up on a public interface with a connected database could be a security concern. Any sysadmin worth their salt is going to test offline or by binding to localhost only first anyway, but this gets them started on the right foot and makes sure people don't make mistakes. Also with the high likelihood that a proxy is going to be used for HTTPS termination anyway, the decision to move to a public IP should be more deliberate. 2021-05-07 17:35:22 +08:00			`address = "localhost:9000"`
Add data privacy export / wipe features (aimed at GDPR compliance). - Toggle options to enable self-service data export and wipe options on the public unsubscription page. Subscribers can get a copy of all data on them e-mailed to them as JSON, or instantly wipe all their data. - Refactor "unsubscribe" pages and URIs to "subscription". - Add export icon to subscriber admin view. 2019-07-21 21:48:41 +08:00
Fresh start 2018-10-25 21:51:47 +08:00			`# Database.`
			`[db]`
Use ‘localhost’ as default name for database server Using localhost instead of some random string is much more likely to actually work out of the box. Also it's a lot easier for a sysamdmin to 'scan' for things that need changing. 2021-05-07 17:33:22 +08:00			`host = "localhost"`
Don't indent TOML keys deeper than their sections 2021-05-06 23:28:04 +08:00			`port = 5432`
			`user = "listmonk"`
			`password = "listmonk"`
Add comment explicitly stating that DB has to be created externally. Closes #830. 2022-07-14 13:22:41 +08:00
			`# Ensure that this database has been created in Postgres.`
Don't indent TOML keys deeper than their sections 2021-05-06 23:28:04 +08:00			`database = "listmonk"`
Add comment explicitly stating that DB has to be created externally. Closes #830. 2022-07-14 13:22:41 +08:00
Don't indent TOML keys deeper than their sections 2021-05-06 23:28:04 +08:00			`ssl_mode = "disable"`
			`max_open = 25`
			`max_idle = 25`
			`max_lifetime = "300s"`
Add optional `params` in DB config to accept arbitrary Postgres params. Closes #1016. 2022-12-25 18:58:19 +08:00
			`# Optional space separated Postgres DSN params. eg: "application_name=listmonk gssencmode=disable"`
			`params = ""`