diff --git a/doc/config/environment-variables.md b/doc/config/environment-variables.md index 45556e4..054822c 100644 --- a/doc/config/environment-variables.md +++ b/doc/config/environment-variables.md @@ -15,9 +15,9 @@ This document contains all the environment variables which are available for thi | `POSTAL_DEFAULT_SPAM_FAILURE_THRESHOLD` | Integer | The default threshold at which a message should be treated as spam failure | 20 | | `POSTAL_USE_LOCAL_NS_FOR_DOMAIN_VERIFICATION` | Boolean | Domain verification and checking usually checks with a domain's nameserver. Enable this to check with the server's local nameservers. | false | | `POSTAL_USE_RESENT_SENDER_HEADER` | Boolean | Append a Resend-Sender header to all outgoing e-mails | true | -| `POSTAL_SIGNING_KEY_PATH` | String | Path to the private key used for signing | config/postal/signing.key | -| `POSTAL_SMTP_RELAYS` | Array of strings | An array of SMTP relays in the format of smtp://host:port | | -| `POSTAL_TRUSTED_PROXIES` | Array of strings | An array of IP addresses to trust for proxying requests to Postal (in addition to localhost addresses) | | +| `POSTAL_SIGNING_KEY_PATH` | String | Path to the private key used for signing | $config-file-root/signing.key | +| `POSTAL_SMTP_RELAYS` | Array of strings | An array of SMTP relays in the format of smtp://host:port | [] | +| `POSTAL_TRUSTED_PROXIES` | Array of strings | An array of IP addresses to trust for proxying requests to Postal (in addition to localhost addresses) | [] | | `WEB_SERVER_DEFAULT_PORT` | Integer | The default port the web server should listen on unless overriden by the PORT environment variable | 5000 | | `WEB_SERVER_DEFAULT_BIND_ADDRESS` | String | The default bind address the web server should listen on unless overriden by the BIND_ADDRESS environment variable | 127.0.0.1 | | `WEB_SERVER_MAX_THREADS` | Integer | The maximum number of threads which can be used by the web server | 5 | @@ -44,12 +44,12 @@ This document contains all the environment variables which are available for thi | `GELF_PORT` | Integer | GELF port to send logs to | 12201 | | `GELF_FACILITY` | String | The facility name to add to all log entries sent to GELF | postal | | `SMTP_SERVER_DEFAULT_PORT` | Integer | The default port the SMTP server should listen on unless overriden by the PORT environment variable | 25 | -| `SMTP_SERVER_DEFAULT_BIND_ADDRESS` | String | The default bind address the SMTP server should listen on unless overriden by the BIND_ADDRESS environment variable | 127.0.0.1 | +| `SMTP_SERVER_DEFAULT_BIND_ADDRESS` | String | The default bind address the SMTP server should listen on unless overriden by the BIND_ADDRESS environment variable | :: | | `SMTP_SERVER_DEFAULT_HEALTH_SERVER_PORT` | Integer | The default port for the SMTP server health server to listen on | 9091 | | `SMTP_SERVER_DEFAULT_HEALTH_SERVER_BIND_ADDRESS` | String | The default bind address for the SMTP server health server to listen on | 127.0.0.1 | | `SMTP_SERVER_TLS_ENABLED` | Boolean | Enable TLS for the SMTP server (requires certificate) | false | -| `SMTP_SERVER_TLS_CERTIFICATE_PATH` | String | The path to the SMTP server's TLS certificate | config/postal/smtp.cert | -| `SMTP_SERVER_TLS_PRIVATE_KEY_PATH` | String | The path to the SMTP server's TLS private key | config/postal/smtp.key | +| `SMTP_SERVER_TLS_CERTIFICATE_PATH` | String | The path to the SMTP server's TLS certificate | $config-file-root/smtp.cert | +| `SMTP_SERVER_TLS_PRIVATE_KEY_PATH` | String | The path to the SMTP server's TLS private key | $config-file-root/smtp.key | | `SMTP_SERVER_TLS_CIPHERS` | String | Override ciphers to use for SSL | | | `SMTP_SERVER_SSL_VERSION` | String | The SSL versions which are supported | SSLv23 | | `SMTP_SERVER_PROXY_PROTOCOL` | Boolean | Enable proxy protocol for use behind some load balancers | false | diff --git a/doc/config/yaml.yml b/doc/config/yaml.yml index 491edb2..23edd0e 100644 --- a/doc/config/yaml.yml +++ b/doc/config/yaml.yml @@ -24,7 +24,7 @@ postal: # Append a Resend-Sender header to all outgoing e-mails use_resent_sender_header: true # Path to the private key used for signing - signing_key_path: config/postal/signing.key + signing_key_path: $config-file-root/signing.key # An array of SMTP relays in the format of smtp://host:port smtp_relays: [] # An array of IP addresses to trust for proxying requests to Postal (in addition to localhost addresses) @@ -96,7 +96,7 @@ smtp_server: # The default port the SMTP server should listen on unless overriden by the PORT environment variable default_port: 25 # The default bind address the SMTP server should listen on unless overriden by the BIND_ADDRESS environment variable - default_bind_address: 127.0.0.1 + default_bind_address: :: # The default port for the SMTP server health server to listen on default_health_server_port: 9091 # The default bind address for the SMTP server health server to listen on @@ -104,9 +104,9 @@ smtp_server: # Enable TLS for the SMTP server (requires certificate) tls_enabled: false # The path to the SMTP server's TLS certificate - tls_certificate_path: config/postal/smtp.cert + tls_certificate_path: $config-file-root/smtp.cert # The path to the SMTP server's TLS private key - tls_private_key_path: config/postal/smtp.key + tls_private_key_path: $config-file-root/smtp.key # Override ciphers to use for SSL tls_ciphers: # The SSL versions which are supported