Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@siebsie23
siebsie23 authored Jul 15, 2024
1 parent 5507f9d commit 070b0a3
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 55 deletions.
81 changes: 39 additions & 42 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,25 +70,24 @@ Be sure to view the following repositories to understand all the customizable op
| ADMIN_LNAME | Name of Admin Last Name | `Admin` |
| ADMIN_PASS | Password of Admin user | `PostalMailServer` |
#### Application Settings
| Parameter | Description | Default |
| ------------------------- | ---------------------------------------- | ------- |
| `ENABLE_TRACKING` | Enable Click Tracking `true` or `false` | `true` |
| `MAX_DELIVERY_ATTEMPTS` | Maximum Delivery Attempts before failing | `18` |
| `MAX_HOLD_EXPIRY_DAYS` | Maximum Holding days before expiring | `7` |
| `SUPPRESSION_LIST_EXPIRY` | Suppression List expiry in days | `30` |
| Parameter | Description | Default |
| ----------------------------------------- | ---------------------------------------- | ------- |
| `MAXIMUM_DELIVERY_ATTEMPTS` | Maximum Delivery Attempts before failing | `18` |
| `MAXIMUM_HOLD_EXPIRY_DAYS` | Maximum Holding days before expiring | `7` |
| `SUPPRESSION_LIST_AUTOMATIC_REMOVAL_DAYS` | Suppression List expiry in days | `30` |

#### DNS Settings
| Parameter | Description | Default |
| -------------------------- | --------------------------------------------------- | ---------------------- |
| `DNS_HOSTNAME` | Domain Name Mail Server | `example.com` |
| `DNS_MX` | MX Record Hostnames - Seperate multiple with commas | |
| `DNS_SPF` | SPF Hostname | `spf.$DNS_HOSTNAME` |
| `DNS_RETURN_PATH` | Return path Hostname | `rp.$DNS_HOSTNAME` |
| `DNS_ROUTE_DOMAIN` | `Routing Domain` | `routes.$DNS_HOSTNAME` |
| `DNS_TRACK_DOMAIN` | `Tracking Domain` | `track.$DNS_HOSTNAME` |
| `DNS_DKIM_IDENTIFIER` | DKIM Identifier | `postal` |
| `DNS_DOMAIN_VERIFY_PREFIX` | Domain verification prefix | `postal-verification` |
| `DNS_RETURN_PATH_PREFIX` | Custom Return Path Prefix | `psrp` |
| Parameter | Description | Default |
| -------------------------- | --------------------------------------------------- | --------------------------- |
| `DNS_HELO_HOSTNAME` | HELO Domain Name Mail Server | `postal.example.com` |
| `DNS_MX` | MX Record Hostnames - Seperate multiple with commas | |
| `DNS_SPF_INCLUDE` | SPF Hostname | `spf.$DNS_HELO_HOSTNAME` |
| `DNS_RETURN_PATH_DOMAIN` | Return path Hostname | `rp.$DNS_HELO_HOSTNAME` |
| `DNS_ROUTE_DOMAIN` | `Routing Domain` | `routes.$DNS_HELO_HOSTNAME` |
| `DNS_TRACK_DOMAIN` | `Tracking Domain` | `track.$DNS_HELO_HOSTNAME` |
| `DNS_DKIM_IDENTIFIER` | DKIM Identifier | `postal` |
| `DNS_DOMAIN_VERIFY_PREFIX` | Domain verification prefix | `postal-verification` |
| `DNS_RETURN_PATH_PREFIX` | Custom Return Path Prefix | `psrp` |

#### Security Settings
| Parameter | Description | Default |
Expand All @@ -100,10 +99,10 @@ Be sure to view the following repositories to understand all the customizable op
| `FAIL2BAN_MAX_RETRY` | Ban after how many tries during time period | `5` |

#### Performance Settings
| Parameter | Description | Default |
| ----------------- | ---------------------------- | ------- |
| `WORKERS_AMOUNT` | Amount of Workers | `1` |
| `WORKERS_THREADS` | Amount of Threads per worker | `4` |
| Parameter | Description | Default |
| ----------------- | ----------------------------------- | ------- |
| `WORKERS_THREADS` | Amount of Threads per worker. | `2` |
| `WEB_MAX_THREADS` | Maximum amount of webserver threads | `5` |

#### Logging Settings
| Parameter | Description | Default |
Expand Down Expand Up @@ -140,8 +139,8 @@ Be sure to view the following repositories to understand all the customizable op

| Parameter | Description | Default |
| ------------------------ | -------------------------- | ------- |
| `SPAM_THRESHOLD` | Amount to classify as Spam | `5.0` |
| `SPAM_FAILURE_THRESHOLD` | Amount to fail as Spam | `5.0` |
| `SPAM_THRESHOLD` | Amount to classify as Spam | `5` |
| `SPAM_FAILURE_THRESHOLD` | Amount to fail as Spam | `20` |

#### Anti Virus Settings
| Parameter | Description | Default |
Expand All @@ -155,22 +154,21 @@ Be sure to view the following repositories to understand all the customizable op
| Parameter | Description | Default |
| -------------------------- | ----------------------------------------- | ------- |
| `SMTP_CLIENT_OPEN_TIMEOUT` | Timeout for an Open Connection in seconds | `30` |
| `SMTP_CLIENT_READ_TIMEOUT` | Timeout for Reading Data in seconds | `60` |
| `SMTP_CLIENT_READ_TIMEOUT` | Timeout for Reading Data in seconds | `30` |

##### Server
| Parameter | Description | Default |
| ------------------------------------ | -------------------------------------------------- | ----------------- |
| `SMTP_SERVER_ENABLE_TLS` | Enable TLS | `false` |
| `SMTP_SERVER_HELO_HOSTNAME` | What Hostname to send for HELO | `$DNS_HOSTNAME` |
| `SMTP_SERVER_LOG_CONNECTIONS` | Log SMTP Connections | `true` |
| `SMTP_SERVER_MAX_MESSAGE_SIZE` | Max message size in Megabytes | `50` |
| `SMTP_SERVER_PORT` | Listening Port for Postal Main SMTP Server | `25` |
| `SMTP_SERVER_PROXY_PROTOCOL` | Utilize Proxy Protocol | `false` |
| `SMTP_SERVER_SSL_VERSION` | SSL Versions | `SSLv23` |
| `SMTP_SERVER_STRIP_RECEIVED_HEADERS` | Strip Recieved Headers | `false` |
| `SMTP_SERVER_TLS_CERT` | TLS Cert Location (Will authgenerate if not exist) | `/certs/cert.pem` |
| `SMTP_SERVER_TLS_CIPHERS` | TLS Ciphers to use | |
| `SMTP_SERVER_TLS_KEY` | TLS Key Location (Will autogenerate if not exist) | `/certs/key.pem` |
| Parameter | Description | Default |
| ------------------------------------ | -------------------------------------------------- | ------------------- |
| `SMTP_SERVER_HOSTNAME` | SMTP Server hostname | `postal.examle.com` |
| `SMTP_SERVER_ENABLE_TLS` | Enable TLS | `false` |
| `SMTP_SERVER_LOG_CONNECTIONS` | Log SMTP Connections | `false` |
| `SMTP_SERVER_MAX_MESSAGE_SIZE` | Max message size in Megabytes | `50` |
| `SMTP_SERVER_PORT` | Listening Port for Postal Main SMTP Server | `25` |
| `SMTP_SERVER_PROXY_PROTOCOL` | Utilize Proxy Protocol | `false` |
| `SMTP_SERVER_TLS_SSL_VERSION` | SSL Versions | `SSLv23` |
| `SMTP_SERVER_TLS_CERT` | TLS Cert Location (Will authgenerate if not exist) | `/certs/cert.pem` |
| `SMTP_SERVER_TLS_CIPHERS` | TLS Ciphers to use | |
| `SMTP_SERVER_TLS_KEY` | TLS Key Location (Will autogenerate if not exist) | `/certs/key.pem` |

##### Management System
| Parameter | Description | Default |
Expand All @@ -182,12 +180,12 @@ Be sure to view the following repositories to understand all the customizable op
| `SMTP_USER` | Username to authenticate to SMTP Server | |
| `SMTP_PASS` | Password to authenticate to SMTP Server | |

##### Relay
<!-- ##### Relay
| Parameter | Description | Default |
| --------------------- | -------------------------------------------- | ------- |
| `SMTP_RELAY_HOST` | Relay all outbound messages to this hostname | |
| `SMTP_RELAY_PORT` | SMTP Relay Port | `25` |
| `SMTP_RELAY_SSL_MODE` | Relay SSL / TLS Mode | `Auto` |
| `SMTP_RELAY_SSL_MODE` | Relay SSL / TLS Mode | `Auto` | -->

#### Other Settings
| Parameter | Description | Default |
Expand All @@ -200,10 +198,9 @@ Be sure to view the following repositories to understand all the customizable op
| `SETUP_TYPE` | Choose `AUTO` or `MANUAL` Setup type - Auto uses these environment variables | `AUTO` |
| `SIGNING_KEY_FILE` | Signing Key File | `signing.key` |
| `SIGNING_KEY_SIZE` | Signing Key Size | `1024` |
| `WEB_BIND_IP` | Bind IP for the Web Interface | `0.0.0.0` |
| `WEB_BIND_PORT` | Bind Port for the Web Interface | `5000` |
| `WEB_BIND_ADDRESS` | Bind IP for the Web Interface | `0.0.0.0` |
| `WEB_PORT` | Bind Port for the Web Interface | `5000` |
| `WEB_HOSTNAME` | Hostname for Web Interface | `postal.example.com` |
| `WEB_MAX_THREADS` | Max Threads for Web Interface | `5` |
| `WEB_PROTOCOL` | Protocol for Web Interface `http` or `https` | `http` |
### Networking

Expand Down
24 changes: 12 additions & 12 deletions install/assets/defaults/20-postal
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

WEB_HOSTNAME=${WEB_HOSTNAME:-"postal.example.com"}
WEB_PROTOCOL=${WEB_PROTOCOL:-"https"}
SMTP_HOSTNAME=${SMTP_HOSTNAME:-"postal.example.com"}
USE_IP_POOLS=${USE_IP_POOLS:-"false"}
MAXIMUM_DELIVERY_ATTEMPTS=${MAXIMUM_DELIVERY_ATTEMPTS:-"18"}
MAXIMUM_HOLD_EXPIRY_DAYS=${MAXIMUM_HOLD_EXPIRY_DAYS:-"7"}
Expand All @@ -19,20 +18,21 @@ WEB_MAX_THREADS=${WEB_MAX_THREADS:-"5"}
WORKER_HEALTH_SERVER_PORT=${WORKER_HEALTH_SERVER_PORT:-"9090"}
WORKER_HEALTH_SERVER_BIND_ADDRESS=${WORKER_HEALTH_SERVER_BIND_ADDRESS:-"127.0.0.1"}
WORKER_THREADS=${WORKER_THREADS:-"2"}
DB_HOST=${DB_HOST:-"localhost"}
DB_HOST=${DB_HOST:-""}
DB_PORT=${DB_PORT:-"3306"}
DB_USER=${DB_USER:-"postal"}
DB_PASS=${DB_PASS:-"postalpass"}
DB_NAME=${DB_NAME:-"postal"}
DB_USER=${DB_USER:-""}
DB_PASS=${DB_PASS:-""}
DB_NAME=${DB_NAME:-""}
SMTP_SERVER_HOSTNAME=${SMTP_SERVER_HOSTNAME:-"postal.example.com"}
SMTP_SERVER_PORT=${SMTP_SERVER_PORT:-"25"}
SMTP_SERVER_ENABLE_TLS=${SMTP_SERVER_ENABLE_TLS:-"false"}
SMTP_SERVER_TLS_CERT=${SMTP_SERVER_TLS_CERT:-"/etc/postal/ssl/postal.cert"}
SMTP_SERVER_TLS_KEY=${SMTP_SERVER_TLS_KEY:-"/etc/postal/ssl/postal.key"}
SMTP_SERVER_TLS_CERT=${SMTP_SERVER_TLS_CERT:-"/certs/cert.pem"}
SMTP_SERVER_TLS_KEY=${SMTP_SERVER_TLS_KEY:-"/certs/key.pem"}
SMTP_SERVER_TLS_CIPHERS=${SMTP_SERVER_TLS_CIPHERS:-""}
SMTP_SERVER_TLS_SSL_VERSION=${SMTP_SERVER_TLS_SSL_VERSION:-"SSLv23"}
SMTP_SERVER_PROXY_PROTOCOL=${SMTP_SERVER_PROXY_PROTOCOL:-"false"}
SMTP_SERVER_LOG_CONNECTIONS=${SMTP_SERVER_LOG_CONNECTIONS:-"false"}
SMTP_SERVER_MAX_MESSAGE_SIZE=${SMTP_SERVER_MAX_MESSAGE_SIZE:-"14"}
SMTP_SERVER_MAX_MESSAGE_SIZE=${SMTP_SERVER_MAX_MESSAGE_SIZE:-"50"}
DNS_HELO_HOSTNAME=${DNS_HELO_HOSTNAME:-"postal.example.com"}
DNS_MX=${DNS_MX:-"postal.example.com"}
DNS_SPF_INCLUDE=${DNS_SPF_INCLUDE:-"spf.$DNS_HELO_HOSTNAME"}
Expand All @@ -51,16 +51,16 @@ SMTP_FROM_NAME=${SMTP_FROM_NAME:-"Postal"}
SMTP_FROM_ADDRESS=${SMTP_FROM_ADDRESS:-"postal@example.com"}
RAILS_SECRET_KEY=${RAILS_SECRET_KEY:-""}
ENABLE_RSPAMD=${ENABLE_RSPAMD:-"false"}
RSPAMD_HOST=${RSPAMD_HOST:-"127.0.0.1"}
RSPAMD_HOST=${RSPAMD_HOST:-""}
RSPAMD_PORT=${RSPAMD_PORT:-"11334"}
RSMAPD_SSL=${RSMAPD_SSL:-"false"}
RSPAMD_SSL=${RSMAPD_SSL:-"false"}
RSPAMD_PASS=${RSPAMD_PASS:-""}
RSPAMD_FLAGS=${RSPAMD_FLAGS:-""}
ENABLE_SPAMASSASIN=${ENABLE_SPAMASSASIN:-"false"}
SPAMASSASIN_HOST=${SPAMASSASIN_HOST:-"127.0.0.1"}
SPAMASSASIN_HOST=${SPAMASSASIN_HOST:-""}
SPAMASSASIN_PORT=${SPAMASSASIN_PORT:-"783"}
ENABLE_CLAMAV=${ENABLE_CLAMAV:-"false"}
CLAMAV_HOST=${CLAMAV_HOST:-"127.0.0.1"}
CLAMAV_HOST=${CLAMAV_HOST:-""}
CLAMAV_PORT=${CLAMAV_PORT:-"2000"}
SMTP_CLIENT_OPEN_TIMEOUT=${SMTP_CLIENT_OPEN_TIMEOUT:-"30"}
SMTP_CLIENT_READ_TIMEOUT=${SMTP_CLIENT_READ_TIMEOUT:-"30"}
2 changes: 1 addition & 1 deletion install/assets/functions/20-postal
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ version: 2
postal:
web_hostname: ${WEB_HOSTNAME}
web_protocol: ${WEB_PROTOCOL}
smtp_hostname: ${SMTP_HOSTNAME}
smtp_hostname: ${SMTP_SERVER_HOSTNAME}
use_ip_pools: ${USE_IP_POOLS}
default_maximum_delivery_attempts: ${MAXIMUM_DELIVERY_ATTEMPTS}
default_maximum_hold_expiry_days: ${MAXIMUM_HOLD_EXPIRY_DAYS}
Expand Down

0 comments on commit 070b0a3

Please sign in to comment.