https://github.com/eldada/postfix-relay-kubernetes
Run postfix in a Docker container and in Kubernetes with helm
https://github.com/eldada/postfix-relay-kubernetes
docker hacktoberfest helm-chart kubernetes postfix postfix-relay
Last synced: 5 months ago
JSON representation
Run postfix in a Docker container and in Kubernetes with helm
- Host: GitHub
- URL: https://github.com/eldada/postfix-relay-kubernetes
- Owner: eldada
- License: mit
- Created: 2018-10-10T06:52:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-13T06:54:50.000Z (over 2 years ago)
- Last Synced: 2025-03-30T09:21:54.667Z (6 months ago)
- Topics: docker, hacktoberfest, helm-chart, kubernetes, postfix, postfix-relay
- Language: Shell
- Homepage:
- Size: 31.3 KB
- Stars: 37
- Watchers: 3
- Forks: 34
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Postfix relay running in Kubernetes
This repository has an example of a postfix relay running in Kubernetes using a helm chart.
## Build Docker image
You can build the Docker image locally
```bash
# For local build
docker build -t eldada.jfrog.io/docker/postfix-relay:0.9 Docker/
# Multi arch build and push
docker buildx build --platform linux/amd64,linux/arm64 -t eldada.jfrog.io/docker/postfix-relay:0.9 Docker/p --push
```
## Run locally with Docker
Run the postfix relay locally for testing
```bash
# Need to set SMTP connection details
export SMTP="[smtp.mailgun.org]:587"
export USERNAME_TEST=
export PASSWORD_TEST=
# Optional custom configuration to add/override in /etc/postfix/main.cf (delimited by a ";")
export POSTFIX_CUSTOM_CONFIG="key1 = value1;key2 = value2;key3 = value3"
# Set list of allowed networks
export TX_SMTP_RELAY_NETWORKS='10.0.0.0/8,127.0.0.0/8,172.17.0.0/16,192.0.0.0/8'
docker run --rm -d --name postfix-relay -p 2525:25 \
-e TX_SMTP_RELAY_HOST="${SMTP}" \
-e TX_SMTP_RELAY_MYHOSTNAME=my.local \
-e TX_SMTP_RELAY_USERNAME=${USERNAME_TEST} \
-e TX_SMTP_RELAY_PASSWORD=${PASSWORD_TEST} \
-e TX_SMTP_RELAY_NETWORKS=${TX_SMTP_RELAY_NETWORKS} \
-e POSTFIX_CUSTOM_CONFIG="${POSTFIX_CUSTOM_CONFIG}" \
eldada.jfrog.io/docker/postfix-relay:0.9
```
### Test sending mail
1. Connect to running container on port 2525
```bash
telnet localhost 2525
```
2. Edit the following with your details and paste in your terminal
```bash
helo localhost
mail from: noreply@yourhost.com
rcpt to: you@your.co
data
Subject: Subject here...
The true story of swans singing Pink Floyd.
.
quit
```
3. You should see the following
```bash
220 tx-smtp-relay.yourhost.com ESMTP Postfix
helo localhost
250 tx-smtp-relay.yourhost.com
mail from: noreply@yourhost.com
250 2.1.0 Ok
rcpt to: you@your.co
250 2.1.5 Ok
data
354 End data with .
Subject: Subject here...
The true story of swans singing Pink Floyd.
.
250 2.0.0 Ok: queued as 982FF53C
quit
221 2.0.0 Bye
Connection closed by foreign host
```
4. Check the inbox of `you@your.co` and see you got the email.
## Deploy Helm Chart
The Helm Chart in [helm/postfix](helm/postfix) directory can be used to deploy the postfix-relay into your Kubernetes cluster.
Create a `custom-values.yaml` with the configuration details
```yaml
smtp:
relayHost: "[smtp.mailgun.org]:587"
relayMyhostname:
relayUsername:
relayPassword:
relayNetworks: '10.0.0.0/8,127.0.0.0/8,172.17.0.0/16,192.0.0.0/8'
```
Deploy postfix
```bash
helm upgrade --install postfix-relay helm/postfix -f custom-values.yaml
```
### Postfix Metrics exporter
An optional postfix-exporter sidecar can be deployed for exposing postfix metrics. This is using the work from https://github.com/kumina/postfix_exporter.
To enable the exporter sidecar, update your `custom-values.yaml` file and **add**
```yaml
# Enable the postfix-exporter sidecar
exporter:
enabled: true
# Enable a ServiceMonitor object for Prometheus scraping
serviceMonitor:
enabled: true
```
Deploy postfix
```bash
helm upgrade --install postfix-relay helm/postfix -f custom-values.yaml
```
## Thanks
The work in this repository is based on
- https://github.com/applariat/kubernetes-postfix-relay-host
- https://github.com/kumina/postfix_exporter
- My pains