-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
67 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: Configuration | ||
description: '' | ||
category: Installation | ||
--- | ||
Postal can be configured through its configuration file or environment variables. There are a fair number of areas which can be configured. | ||
|
||
You can review all the available configuration options. | ||
|
||
* [Full Postal Configuration file](https://github.com/postalserver/postal/blob/main/doc/config/yaml.yml) - this is an example configuration file that contains all the configuration options along with their defaults and a description. This file would usually exist in `/opt/postal/config/postal.yml`. | ||
|
||
* [All environment variables](https://github.com/postalserver/postal/blob/main/doc/config/environment-variables.md) - this page lists all the environment variables. All configuration that can be set in the config file can also be set by an environment variable. | ||
|
||
::callout | ||
Note: If you change any configuration, you should be sure to restart Postal | ||
:: | ||
|
||
## Ports and bind addresses | ||
|
||
The web & SMTP server listen on ports and addresses. The defaults for these can be set through configuration however, if you're running multiple instances of these on a single host you will need to specify different ports for each one. | ||
|
||
You can use the `PORT` and `BIND_ADDRESS` environment variables to provide instance-specific values for these processes. | ||
|
||
## Legacy configuration | ||
|
||
The current version for the Postal configuration file is `2`. This is shown by the `version: 2` in the configuration file itself. | ||
|
||
Postal still supports the version 1 (or legacy) configuration format from Postal v2 and earlier. If you are using this config file, you will receive a warning in the logs when starting Postal. We recommend changing your configuration to follow the new v2 format which is documented above. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
--- | ||
title: Click & Open Tracking | ||
description: '' | ||
position: 3.0 | ||
category: Features | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Logging | ||
description: '' | ||
category: Features | ||
--- | ||
|
||
All Postal processes log to STDOUT and STDERR which means their logs are managed by whatever engine is used to run the container. In the default case, this is Docker. | ||
|
||
## Limiting the size of logs | ||
|
||
Docker cam be configured to limit the size of the log files it stores. To avoid storing large numbers of log files, you should configure this appropriately. This can be achieved by setting a maximum size in your `/etc/docker/daemon.json` file. | ||
|
||
```json | ||
{ | ||
"log-driver": "local", | ||
"log-opts": { | ||
"max-size": "100m" | ||
} | ||
} | ||
``` | ||
|
||
## Sending logs to Graylog | ||
|
||
Postal includes support for sending log output to a central Graylog server over UDP. This can be configured using the following options: | ||
|
||
```yaml | ||
gelf: | ||
# GELF-capable host to send logs to | ||
host: | ||
# GELF port to send logs to | ||
port: 12201 | ||
# The facility name to add to all log entries sent to GELF | ||
facility: postal | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
--- | ||
title: SMTP TLS | ||
description: '' | ||
position: 3.2 | ||
category: Features | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters