Herald is an application that accepts emailed text-message dispatches (TMDs), parses them, and sends them off to Slack with beautiful formatting.
Setup of Herald involves a few steps, but it isn't very difficult. You'll need to create an app on Slack, load our code onto your server, and set some environment variables.
- Head over to Slack's app portal, and create a new app.
- Add the OAuth scope
chat:write. - Install the app to your workspace, and take note of the bot user token (it starts with
xoxb-and then a ton of random characters). You'll also need the signing secret, which is available on the "basic information" page.
You can easily deploy this app using Docker Compose. Your docker-compose.yml file should look something like the following (we use Traefik for routing, FYI):
herald:
build: https://github.com/techinems/herald.git#main
container_name: herald
restart: always
labels:
- traefik.tcp.routers.herald_smtp.service=herald_smtp
- traefik.tcp.services.herald_smtp.loadbalancer.server.port=25
- traefik.tcp.routers.herald_smtp.entrypoints=smtp
- traefik.tcp.routers.herald_smtp.rule=HostSNI(`*`)
Fill in the environment variables as appropriate, and run a docker-compose up -d herald, or whatever you named your service.
Herald is provided under the MIT License.
For any question, comments, or concerns, email [email protected], create an issue, or open up a pull request.