tobiass/tachikoma-database repository overview

⁠Tachikoma ESP

This will be an Email Service Provider Software suitable for use with large amounts of transactional emails.

Primary features

• Handle relatively large amount of emails (sub 100k/month)
• Accurately track bounce, delivers, opens & clicks
• Handle unsubscribe properly via replacing links in the email and RFC8058⁠
• Block lists for unsubscribed emails (per sender email)
• Zero Downtime upgrades for web server
• No messages lost, not even during upgrade

Possible later improvements:

• Queue outgoing emails until a specific time
• Web API
• Template support

Runtime requirements

Once finished it will primarily be distributed as one or more docker images, but it's nowhere near there yet. This means that all servers must be installed and configured locally (or inside a docker with port forward).

What it uses:

• Kotlin language (JVM and JS)
• PostgreSQL database
• Postfix email server
• RabbitMQ message broker
• gRPC API

Setting up the development environment

Setting up the different programs necessary to develop (not run) it in IntelliJ.

• JDK 8 (JRE is untested)

** Running **

To build and start, run

./gradlew run

That will start the webpack-dev-server at port 8080 (liable to change) and the webserver (for e.g. gRPC) at port 8070.

To start the docker (with the Postfix email server), first create a file with the format

TACHIKOMA_URL=http://example.com:[email protected]:8070/
MAIL_DOMAIN_MX=false

run

docker run --name postfix -it --rm -h tachikoma-postfix \
  -e TACHIKOMA_CONFIG=/etc/tachikoma.config -v $HOME/.tachikoma-postfix.config:/etc/tachikoma.config \
  sourceforgery/tachikoma-postfix:<version>

E.g.

docker run --name postfix -it --rm -h tachikoma-postfix \
  -e TACHIKOMA_CONFIG=/etc/tachikoma.config -v $HOME/.tachikoma-postfix.config:/etc/tachikoma.config \
  sourceforgery/tachikoma-postfix:0.0.54

Recommendations

• Add the function gw () { $(git rev-parse --show-toplevel)/gradlew "$@" } to avoid having to do ../../../gradlew
• Only run gradlew build, gradlew clean build should not be necessary and slows down development a lot.
• Because of my weak Gradle-fu, updated .proto-files does not trigger rebuild of the rest of the api-projects. gradle clean build is necessary, but only in the api projects.

Getting around some quirks

1. Build with ./gradlew build in the root (should build cleanly).
2. When IntelliJ flakes out and complains about trying to use 1.8 stuff on 1.6, go Open Module Settings, go Facets and add Kotlin Facet to all modules (and their partial modules, e.g. main and test) you're having problems with. Problem will persist until you catch 'em all.

⁠Setup

Example /etc/systemd/system/tachikoma-postfix.service

[Unit]
Description=Tachikoma postfix
After=docker.service
Requires=docker.service

[Service]
Type=simple
Environment=name=tachikoma-postfix
Environment=mailDomain=EXAMPLE.COM
Environment=backendApiKey=XXXXXXXXXXXXXXXXX
Environment=webserverHost=TACHIKOMA-SERVER.EXAMPLE.COM
Environment=image=sourceforgery/tachikoma-postfix:VERSION

ExecStartPre=/usr/bin/docker pull ${image}
ExecStart=/usr/bin/docker run --rm=true -p 25:25 --name=${name} \
  -e MAIL_DOMAIN_MX=false \
  -e TACHIKOMA_URL=https://${mailDomain}:${backendApiKey}@${webserverHost} \
  -v /etc/ssl/private/domainkeys:/etc/opendkim/domainkeys:ro \
  ${image}
ExecStop=-/usr/bin/docker stop ${name}

[Install]
WantedBy=multi-user.target