Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
djjudas21 committed Mar 2, 2021
1 parent d267f19 commit 8dea7a6
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# kubernetes-postfix-relay-host
A SMTP relay host for transactional based emails from within a k8 cluster.
# tx-smtp-relay

This image provides an SMTP relay host for emails from within a Kubernetes cluster.

Configure this container to use an upstream authenticated SMTP relay, and provide an open relay service to your cluster.
This means you don't have to configure all of your containerised services with email auth secrets.

## Overview
This repository contains Kubernetes config files and a docker image to easily set up a SMTP relay for services such as SendGrid.
## Config

This image supports the following enironment variables:

## Background
We needed a simple docker image that can be configured with env vars. Also, the functionality is easily overridded by providing an alternate init script.
* `TX_SMTP_RELAY_HOST`
* `TX_SMTP_RELAY_MYHOSTNAME`
* `TX_SMTP_RELAY_USERNAME`
* `TX_SMTP_RELAY_PASSWORD`

# Quickstart
Run on docker
Expand Down

0 comments on commit 8dea7a6

Please sign in to comment.