Skip to content

Commit 01ba33e

Browse files
committed
various updates
1 parent 8845a9f commit 01ba33e

File tree

9 files changed

+67
-9
lines changed

9 files changed

+67
-9
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Configuration
3+
description: ''
4+
category: Installation
5+
---
6+
Postal can be configured through its configuration file or environment variables. There are a fair number of areas which can be configured.
7+
8+
You can review all the available configuration options.
9+
10+
* [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`.
11+
12+
* [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.
13+
14+
::callout
15+
Note: If you change any configuration, you should be sure to restart Postal
16+
::
17+
18+
## Ports and bind addresses
19+
20+
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.
21+
22+
You can use the `PORT` and `BIND_ADDRESS` environment variables to provide instance-specific values for these processes.
23+
24+
## Legacy configuration
25+
26+
The current version for the Postal configuration file is `2`. This is shown by the `version: 2` in the configuration file itself.
27+
28+
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.

content/2.getting-started/4.dns-configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,15 +118,15 @@ If you wish to receive incoming e-mail by forwarding messages directly to routes
118118

119119
## Example Postal Configuration
120120

121-
In your `postal.yml` you should have something that looks like the below:
121+
In your `postal.yml` you should have something that looks like the below to cover the key DNS records.
122122

123123
```yaml
124124
dns:
125125
mx_records:
126-
- postal.example.com
127-
smtp_server_hostname: postal.example.com
128-
track_domain: postal.example.com
126+
- mx1.postal.example.com
127+
- mx2.postal.example.com
129128
spf_include: spf.postal.example.com
130-
return_path: rp.postal.example.com
129+
return_path_domain: rp.postal.example.com
131130
route_domain: routes.postal.example.com
131+
track_domain: track.postal.example.com
132132
```
File renamed without changes.
File renamed without changes.

content/3.features/click-and-open-tracking.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Click & Open Tracking
33
description: ''
4-
position: 3.0
54
category: Features
65
---
76

content/3.features/ip-pools.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: IP Pools
33
description: ''
4-
position: 3.1
54
category: Features
65
---
76
Postal supports sending messages from different IP addresses. This allows you to configure certain sets of IPs for different mail servers or send from different IPs based on the sender or recipient addresses.

content/3.features/logging.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Logging
3+
description: ''
4+
category: Features
5+
---
6+
7+
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.
8+
9+
## Limiting the size of logs
10+
11+
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.
12+
13+
```json
14+
{
15+
"log-driver": "local",
16+
"log-opts": {
17+
"max-size": "100m"
18+
}
19+
}
20+
```
21+
22+
## Sending logs to Graylog
23+
24+
Postal includes support for sending log output to a central Graylog server over UDP. This can be configured using the following options:
25+
26+
```yaml
27+
gelf:
28+
# GELF-capable host to send logs to
29+
host:
30+
# GELF port to send logs to
31+
port: 12201
32+
# The facility name to add to all log entries sent to GELF
33+
facility: postal
34+
```

content/3.features/smtp-tls.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: SMTP TLS
33
description: ''
4-
position: 3.2
54
category: Features
65
---
76

content/3.features/spam-and-virus-checking.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Spam & Virus Checking
33
description: ''
4-
position: 3.2
54
category: Features
65
---
76
Postal can integrate with SpamAssassin and ClamAV to automatically scan incoming and outgoing messages that pass through mail servers.

0 commit comments

Comments
 (0)