mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
31c45f951d3e7e4634e60d4acd814a446d5bc73c
Chat Mail server configuration
This repository setups a ready-to-go chatmail instance comprised of a minimal setup of the battle-tested postfix smtp server and dovecot imap server.
Getting started
-
prepare your local system:
scripts/init.sh
-
set environment variable to the chatmail domain you want to setup:
export CHATMAIL_DOMAIN=c1.testrun.org # replace with your host
-
run the deploy of the chat mail instance:
scripts/deploy.sh
Running tests and benchmarks (offline and online)
-
Set
CHATMAIL_SSHso thatssh root@$CHATMAIL_SSHallows to login to the chatmail instance server. -
To run local and online tests:
scripts/test.sh
-
To run benchmarks against your chatmail instance:
scripts/bench.sh
Running tests (offline and online)
## Dovecot/Postfix configuration
### Ports
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
Dovecot listens on ports 143(imap) and 993 (imaps).
## DNS
For DKIM you must add a DNS entry as found in /etc/opendkim/selector.txt on your chatmail instance.
The above `scripts/deploy.sh` prints out the DKIM selector and DNS entry you
need to setup with your DNS provider.
## Emergency Commands
If you need to stop account creation,
e.g. because some script is wildly creating accounts,
just run `touch /tmp/nocreate`.
You can remove the file
as soon as the attacker was banned
by different means.
Languages
Python
86%
Jinja
10%
Filebench WML
1.3%
Shell
1%
Forth
0.6%
Other
1.1%