mirror of
https://github.com/chatmail/relay.git
synced 2026-05-13 17:34:38 +00:00
Compare commits
4 Commits
j4n/docker
...
tmpfs-inde
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
151d6ef445 | ||
|
|
27443ca044 | ||
|
|
be35244371 | ||
|
|
f7f2c9600d |
@@ -1,18 +0,0 @@
|
|||||||
data/
|
|
||||||
venv/
|
|
||||||
__pycache__
|
|
||||||
*.pyc
|
|
||||||
*.orig
|
|
||||||
*.ini
|
|
||||||
.pytest_cache
|
|
||||||
.env
|
|
||||||
|
|
||||||
# Slim build context — .git/ alone can be 100s of MB
|
|
||||||
.git
|
|
||||||
.github/
|
|
||||||
docs/
|
|
||||||
tests/
|
|
||||||
|
|
||||||
# Exclude markdown files but keep www/src/*.md (used by WebsiteDeployer)
|
|
||||||
*.md
|
|
||||||
!www/**/*.md
|
|
||||||
2
.github/workflows/ci.yaml
vendored
2
.github/workflows/ci.yaml
vendored
@@ -15,7 +15,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
- name: download filtermail
|
- name: download filtermail
|
||||||
run: curl -L https://github.com/chatmail/filtermail/releases/download/v0.3.0/filtermail-x86_64 -o /usr/local/bin/filtermail && chmod +x /usr/local/bin/filtermail
|
run: curl -L https://github.com/chatmail/filtermail/releases/download/v0.2.0/filtermail-x86_64-musl -o /usr/local/bin/filtermail && chmod +x /usr/local/bin/filtermail
|
||||||
- name: run chatmaild tests
|
- name: run chatmaild tests
|
||||||
working-directory: chatmaild
|
working-directory: chatmaild
|
||||||
run: pipx run tox
|
run: pipx run tox
|
||||||
|
|||||||
76
.github/workflows/docker-build.yaml
vendored
76
.github/workflows/docker-build.yaml
vendored
@@ -1,76 +0,0 @@
|
|||||||
name: Docker Build
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'docker/**'
|
|
||||||
- 'docker-compose.yaml'
|
|
||||||
- '.dockerignore'
|
|
||||||
- 'chatmaild/**'
|
|
||||||
- 'cmdeploy/**'
|
|
||||||
- '.github/workflows/docker-build.yaml'
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- j4n/docker
|
|
||||||
paths:
|
|
||||||
- 'docker/**'
|
|
||||||
- 'docker-compose.yaml'
|
|
||||||
- '.dockerignore'
|
|
||||||
- 'chatmaild/**'
|
|
||||||
- 'cmdeploy/**'
|
|
||||||
- '.github/workflows/docker-build.yaml'
|
|
||||||
tags:
|
|
||||||
- 'v*'
|
|
||||||
|
|
||||||
env:
|
|
||||||
REGISTRY: ghcr.io
|
|
||||||
IMAGE_NAME: ${{ github.repository }}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
name: Build Docker image
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Login to GHCR
|
|
||||||
if: github.event_name == 'push'
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
registry: ${{ env.REGISTRY }}
|
|
||||||
username: ${{ github.actor }}
|
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Extract metadata (tags, labels)
|
|
||||||
id: meta
|
|
||||||
uses: docker/metadata-action@v5
|
|
||||||
with:
|
|
||||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
|
||||||
tags: |
|
|
||||||
# Tagged releases: v1.2.3 → :1.2.3, :1.2, :latest
|
|
||||||
type=semver,pattern={{version}}
|
|
||||||
type=semver,pattern={{major}}.{{minor}}
|
|
||||||
# Branch pushes: j4n/docker → :j4n-docker
|
|
||||||
type=ref,event=branch
|
|
||||||
# Always: :sha-<hash>
|
|
||||||
type=sha
|
|
||||||
|
|
||||||
- name: Build and push
|
|
||||||
uses: docker/build-push-action@v6
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
file: docker/chatmail_relay.dockerfile
|
|
||||||
push: ${{ github.event_name == 'push' }}
|
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
|
||||||
cache-from: type=gha
|
|
||||||
cache-to: type=gha,mode=max
|
|
||||||
build-args: |
|
|
||||||
GIT_HASH=${{ github.sha }}
|
|
||||||
6
.gitignore
vendored
6
.gitignore
vendored
@@ -164,9 +164,3 @@ cython_debug/
|
|||||||
#.idea/
|
#.idea/
|
||||||
|
|
||||||
chatmail.zone
|
chatmail.zone
|
||||||
|
|
||||||
# docker
|
|
||||||
/data/
|
|
||||||
/custom/
|
|
||||||
docker-compose.override.yaml
|
|
||||||
.env
|
|
||||||
|
|||||||
@@ -121,13 +121,6 @@
|
|||||||
Provide an "fsreport" CLI for more fine grained analysis of message files.
|
Provide an "fsreport" CLI for more fine grained analysis of message files.
|
||||||
([#637](https://github.com/chatmail/relay/pull/637))
|
([#637](https://github.com/chatmail/relay/pull/637))
|
||||||
|
|
||||||
- Add installation via docker compose (MVP 1). The instructions, known issues and limitations are located in `/docs`
|
|
||||||
([#614](https://github.com/chatmail/relay/pull/614))
|
|
||||||
|
|
||||||
- Add configuration parameters
|
|
||||||
([#614](https://github.com/chatmail/relay/pull/614)):
|
|
||||||
- `change_kernel_settings` - Whether to change kernel parameters during installation (default: `True`)
|
|
||||||
- `fs_inotify_max_user_instances_and_watchers` - Value for kernel parameters `fs.inotify.max_user_instances` and `fs.inotify.max_user_watches` (default: `65535`)
|
|
||||||
|
|
||||||
## 1.7.0 2025-09-11
|
## 1.7.0 2025-09-11
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
import os
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import iniconfig
|
import iniconfig
|
||||||
@@ -44,9 +43,6 @@ class Config:
|
|||||||
)
|
)
|
||||||
self.mtail_address = params.get("mtail_address")
|
self.mtail_address = params.get("mtail_address")
|
||||||
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
||||||
self.noacme = os.environ.get("CHATMAIL_NOACME", "false").lower() == "true"
|
|
||||||
self.addr_v4 = os.environ.get("CHATMAIL_ADDR_V4", "")
|
|
||||||
self.addr_v6 = os.environ.get("CHATMAIL_ADDR_V6", "")
|
|
||||||
self.acme_email = params.get("acme_email", "")
|
self.acme_email = params.get("acme_email", "")
|
||||||
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
||||||
self.imap_compress = params.get("imap_compress", "false").lower() == "true"
|
self.imap_compress = params.get("imap_compress", "false").lower() == "true"
|
||||||
@@ -60,6 +56,7 @@ class Config:
|
|||||||
self.privacy_mail = params.get("privacy_mail")
|
self.privacy_mail = params.get("privacy_mail")
|
||||||
self.privacy_pdo = params.get("privacy_pdo")
|
self.privacy_pdo = params.get("privacy_pdo")
|
||||||
self.privacy_supervisor = params.get("privacy_supervisor")
|
self.privacy_supervisor = params.get("privacy_supervisor")
|
||||||
|
self.tmpfs_index = params.get("tmpfs_index", "false").lower() == "true"
|
||||||
|
|
||||||
# deprecated option
|
# deprecated option
|
||||||
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{self.mail_domain}")
|
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{self.mail_domain}")
|
||||||
@@ -115,10 +112,10 @@ def get_default_config_content(mail_domain, **overrides):
|
|||||||
|
|
||||||
if mail_domain.endswith(".testrun.org"):
|
if mail_domain.endswith(".testrun.org"):
|
||||||
override_inipath = inidir.joinpath("override-testrun.ini")
|
override_inipath = inidir.joinpath("override-testrun.ini")
|
||||||
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
params = iniconfig.IniConfig(override_inipath)["params"]
|
||||||
lines = []
|
lines = []
|
||||||
for line in content.split("\n"):
|
for line in content.split("\n"):
|
||||||
for key, value in privacy.items():
|
for key, value in params.items():
|
||||||
value_lines = value.format(mail_domain=mail_domain).strip().split("\n")
|
value_lines = value.format(mail_domain=mail_domain).strip().split("\n")
|
||||||
if not line.startswith(f"{key} =") or not value_lines:
|
if not line.startswith(f"{key} =") or not value_lines:
|
||||||
continue
|
continue
|
||||||
|
|||||||
@@ -17,14 +17,14 @@ from chatmaild.config import read_config
|
|||||||
FileEntry = namedtuple("FileEntry", ("path", "mtime", "size"))
|
FileEntry = namedtuple("FileEntry", ("path", "mtime", "size"))
|
||||||
|
|
||||||
|
|
||||||
def iter_mailboxes(basedir, maxnum):
|
def iter_mailboxes(basedir, maxnum, tmpfs_index):
|
||||||
if not os.path.exists(basedir):
|
if not os.path.exists(basedir):
|
||||||
print_info(f"no mailboxes found at: {basedir}")
|
print_info(f"no mailboxes found at: {basedir}")
|
||||||
return
|
return
|
||||||
|
|
||||||
for name in os_listdir_if_exists(basedir)[:maxnum]:
|
for name in os_listdir_if_exists(basedir)[:maxnum]:
|
||||||
if "@" in name:
|
if "@" in name:
|
||||||
yield MailboxStat(basedir + "/" + name)
|
yield MailboxStat(basedir + "/" + name, name, tmpfs_index)
|
||||||
|
|
||||||
|
|
||||||
def get_file_entry(path):
|
def get_file_entry(path):
|
||||||
@@ -49,11 +49,14 @@ def os_listdir_if_exists(path):
|
|||||||
class MailboxStat:
|
class MailboxStat:
|
||||||
last_login = None
|
last_login = None
|
||||||
|
|
||||||
def __init__(self, basedir):
|
def __init__(self, basedir, name, tmpfs_index):
|
||||||
self.basedir = str(basedir)
|
self.basedir = str(basedir)
|
||||||
|
self.name = name
|
||||||
self.messages = []
|
self.messages = []
|
||||||
self.extrafiles = []
|
self.extrafiles = []
|
||||||
self.scandir(self.basedir)
|
self.scandir(self.basedir)
|
||||||
|
if tmpfs_index:
|
||||||
|
self.scandir("/dev/shm/" + name)
|
||||||
|
|
||||||
def scandir(self, folderdir):
|
def scandir(self, folderdir):
|
||||||
for name in os_listdir_if_exists(folderdir):
|
for name in os_listdir_if_exists(folderdir):
|
||||||
@@ -90,11 +93,13 @@ class Expiry:
|
|||||||
self.all_files = 0
|
self.all_files = 0
|
||||||
self.start = time.time()
|
self.start = time.time()
|
||||||
|
|
||||||
def remove_mailbox(self, mboxdir):
|
def remove_mailbox(self, mboxdir, name):
|
||||||
if self.verbose:
|
if self.verbose:
|
||||||
print_info(f"removing {mboxdir}")
|
print_info(f"removing {mboxdir}")
|
||||||
if not self.dry:
|
if not self.dry:
|
||||||
shutil.rmtree(mboxdir)
|
shutil.rmtree(mboxdir)
|
||||||
|
if self.config.tmpfs_index:
|
||||||
|
shutil.rmtree("/dev/shm/" + name)
|
||||||
self.del_mboxes += 1
|
self.del_mboxes += 1
|
||||||
|
|
||||||
def remove_file(self, path, mtime=None):
|
def remove_file(self, path, mtime=None):
|
||||||
@@ -121,7 +126,7 @@ class Expiry:
|
|||||||
self.all_mboxes += 1
|
self.all_mboxes += 1
|
||||||
changed = False
|
changed = False
|
||||||
if mbox.last_login and mbox.last_login < cutoff_without_login:
|
if mbox.last_login and mbox.last_login < cutoff_without_login:
|
||||||
self.remove_mailbox(mbox.basedir)
|
self.remove_mailbox(mbox.basedir, mbox.name)
|
||||||
return
|
return
|
||||||
|
|
||||||
mboxname = os.path.basename(mbox.basedir)
|
mboxname = os.path.basename(mbox.basedir)
|
||||||
@@ -145,6 +150,9 @@ class Expiry:
|
|||||||
changed = True
|
changed = True
|
||||||
if changed:
|
if changed:
|
||||||
self.remove_file(f"{mbox.basedir}/maildirsize")
|
self.remove_file(f"{mbox.basedir}/maildirsize")
|
||||||
|
for file in mbox.extrafiles:
|
||||||
|
if "dovecot.index" in file.path.split("/")[-1] and file.size > 500 * 1024:
|
||||||
|
self.remove_file(file.path)
|
||||||
|
|
||||||
def get_summary(self):
|
def get_summary(self):
|
||||||
return (
|
return (
|
||||||
@@ -197,7 +205,9 @@ def main(args=None):
|
|||||||
|
|
||||||
maxnum = int(args.maxnum) if args.maxnum else None
|
maxnum = int(args.maxnum) if args.maxnum else None
|
||||||
exp = Expiry(config, dry=not args.remove, now=now, verbose=args.verbose)
|
exp = Expiry(config, dry=not args.remove, now=now, verbose=args.verbose)
|
||||||
for mailbox in iter_mailboxes(str(config.mailboxes_dir), maxnum=maxnum):
|
for mailbox in iter_mailboxes(
|
||||||
|
str(config.mailboxes_dir), maxnum, config.tmpfs_index
|
||||||
|
):
|
||||||
exp.process_mailbox_stat(mailbox)
|
exp.process_mailbox_stat(mailbox)
|
||||||
print(exp.get_summary())
|
print(exp.get_summary())
|
||||||
|
|
||||||
|
|||||||
@@ -159,7 +159,7 @@ def main(args=None):
|
|||||||
|
|
||||||
maxnum = int(args.maxnum) if args.maxnum else None
|
maxnum = int(args.maxnum) if args.maxnum else None
|
||||||
rep = Report(now=now, min_login_age=int(args.min_login_age), mdir=args.mdir)
|
rep = Report(now=now, min_login_age=int(args.min_login_age), mdir=args.mdir)
|
||||||
for mbox in iter_mailboxes(str(config.mailboxes_dir), maxnum=maxnum):
|
for mbox in iter_mailboxes(str(config.mailboxes_dir), maxnum, config.tmpfs_index):
|
||||||
rep.process_mailbox_stat(mbox)
|
rep.process_mailbox_stat(mbox)
|
||||||
rep.dump_summary()
|
rep.dump_summary()
|
||||||
|
|
||||||
|
|||||||
@@ -48,6 +48,9 @@ passthrough_senders =
|
|||||||
# (space-separated, item may start with "@" to whitelist whole recipient domains)
|
# (space-separated, item may start with "@" to whitelist whole recipient domains)
|
||||||
passthrough_recipients =
|
passthrough_recipients =
|
||||||
|
|
||||||
|
# store index files in tmpfs (good for disk size and I/O, bad for ram)
|
||||||
|
tmpfs_index = false
|
||||||
|
|
||||||
# path to www directory - documented here: https://chatmail.at/doc/relay/getting_started.html#custom-web-pages
|
# path to www directory - documented here: https://chatmail.at/doc/relay/getting_started.html#custom-web-pages
|
||||||
#www_folder = www
|
#www_folder = www
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
|
[params]
|
||||||
|
|
||||||
[privacy]
|
tmpfs_index = true
|
||||||
|
|
||||||
passthrough_recipients = privacy@testrun.org echo@{mail_domain}
|
passthrough_recipients = privacy@testrun.org echo@{mail_domain}
|
||||||
|
|
||||||
|
|||||||
@@ -43,20 +43,22 @@ def create_new_messages(basedir, relpaths, size=1000, days=0):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def mbox1(example_config):
|
def mbox1(example_config):
|
||||||
mboxdir = example_config.mailboxes_dir.joinpath("mailbox1@example.org")
|
addr = "mailbox1@example.org"
|
||||||
|
mboxdir = example_config.mailboxes_dir.joinpath(addr)
|
||||||
mboxdir.mkdir()
|
mboxdir.mkdir()
|
||||||
fill_mbox(mboxdir)
|
fill_mbox(mboxdir)
|
||||||
return MailboxStat(mboxdir)
|
return MailboxStat(mboxdir, addr, False)
|
||||||
|
|
||||||
|
|
||||||
def test_deltachat_folder(example_config):
|
def test_deltachat_folder(example_config):
|
||||||
"""Test old setups that might have a .DeltaChat folder where messages also need to get removed."""
|
"""Test old setups that might have a .DeltaChat folder where messages also need to get removed."""
|
||||||
mboxdir = example_config.mailboxes_dir.joinpath("mailbox1@example.org")
|
addr = "mailbox1@example.org"
|
||||||
|
mboxdir = example_config.mailboxes_dir.joinpath(addr)
|
||||||
mboxdir.mkdir()
|
mboxdir.mkdir()
|
||||||
mbox2dir = mboxdir.joinpath(".DeltaChat")
|
mbox2dir = mboxdir.joinpath(".DeltaChat")
|
||||||
mbox2dir.mkdir()
|
mbox2dir.mkdir()
|
||||||
fill_mbox(mbox2dir)
|
fill_mbox(mbox2dir)
|
||||||
mb = MailboxStat(mboxdir)
|
mb = MailboxStat(mboxdir, addr, False)
|
||||||
assert len(mb.messages) == 2
|
assert len(mb.messages) == 2
|
||||||
|
|
||||||
|
|
||||||
@@ -69,7 +71,11 @@ def test_filentry_ordering(tmp_path):
|
|||||||
|
|
||||||
|
|
||||||
def test_no_mailbxoes(tmp_path, capsys):
|
def test_no_mailbxoes(tmp_path, capsys):
|
||||||
assert [] == list(iter_mailboxes(str(tmp_path.joinpath("notexists")), maxnum=10))
|
assert [] == list(
|
||||||
|
iter_mailboxes(
|
||||||
|
str(tmp_path.joinpath("notexists")), maxnum=10, tmpfs_index=False
|
||||||
|
)
|
||||||
|
)
|
||||||
out, err = capsys.readouterr()
|
out, err = capsys.readouterr()
|
||||||
assert "no mailboxes" in err
|
assert "no mailboxes" in err
|
||||||
|
|
||||||
@@ -86,13 +92,13 @@ def test_stats_mailbox(mbox1):
|
|||||||
|
|
||||||
create_new_messages(mbox1.basedir, ["large-extra"], size=1000)
|
create_new_messages(mbox1.basedir, ["large-extra"], size=1000)
|
||||||
create_new_messages(mbox1.basedir, ["index-something"], size=3)
|
create_new_messages(mbox1.basedir, ["index-something"], size=3)
|
||||||
mbox2 = MailboxStat(mbox1.basedir)
|
mbox2 = MailboxStat(mbox1.basedir, mbox1.name, False)
|
||||||
assert len(mbox2.extrafiles) == 5
|
assert len(mbox2.extrafiles) == 5
|
||||||
assert mbox2.extrafiles[0].size == 1000
|
assert mbox2.extrafiles[0].size == 1000
|
||||||
|
|
||||||
# cope well with mailbox dirs that have no password (for whatever reason)
|
# cope well with mailbox dirs that have no password (for whatever reason)
|
||||||
Path(mbox1.basedir).joinpath("password").unlink()
|
Path(mbox1.basedir).joinpath("password").unlink()
|
||||||
mbox3 = MailboxStat(mbox1.basedir)
|
mbox3 = MailboxStat(mbox1.basedir, mbox1.name, False)
|
||||||
assert mbox3.last_login is None
|
assert mbox3.last_login is None
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -57,19 +57,10 @@ def test_one_mail(
|
|||||||
path = str(config._inipath)
|
path = str(config._inipath)
|
||||||
|
|
||||||
popen = make_popen(["filtermail", path, filtermail_mode])
|
popen = make_popen(["filtermail", path, filtermail_mode])
|
||||||
|
line = popen.stderr.readline().strip()
|
||||||
# Wait for filtermail to start accepting connections
|
if b"loop" not in line:
|
||||||
import socket
|
print(line.decode("ascii"), file=sys.stderr)
|
||||||
import time
|
pytest.fail("starting filtermail failed")
|
||||||
for _ in range(50): # 5 second timeout
|
|
||||||
try:
|
|
||||||
sock = socket.create_connection(("127.0.0.1", smtp_inject_port), timeout=0.1)
|
|
||||||
sock.close()
|
|
||||||
break
|
|
||||||
except (ConnectionRefusedError, OSError):
|
|
||||||
time.sleep(0.1)
|
|
||||||
else:
|
|
||||||
pytest.fail("filtermail failed to start accepting connections")
|
|
||||||
|
|
||||||
addr = f"user1@{config.mail_domain}"
|
addr = f"user1@{config.mail_domain}"
|
||||||
config.get_user(addr).set_password("l1k2j3l1k2j3l")
|
config.get_user(addr).set_password("l1k2j3l1k2j3l")
|
||||||
|
|||||||
@@ -5,11 +5,6 @@ import os
|
|||||||
from pyinfra.operations import files, server, systemd
|
from pyinfra.operations import files, server, systemd
|
||||||
|
|
||||||
|
|
||||||
def has_systemd():
|
|
||||||
"""Returns False during Docker image builds or any other non-systemd environment."""
|
|
||||||
return os.path.isdir("/run/systemd/system")
|
|
||||||
|
|
||||||
|
|
||||||
def get_resource(arg, pkg=__package__):
|
def get_resource(arg, pkg=__package__):
|
||||||
return importlib.resources.files(pkg).joinpath(arg)
|
return importlib.resources.files(pkg).joinpath(arg)
|
||||||
|
|
||||||
|
|||||||
@@ -101,17 +101,11 @@ def run_cmd(args, out):
|
|||||||
env["CHATMAIL_WEBSITE_ONLY"] = "True" if args.website_only else ""
|
env["CHATMAIL_WEBSITE_ONLY"] = "True" if args.website_only else ""
|
||||||
env["CHATMAIL_DISABLE_MAIL"] = "True" if args.disable_mail else ""
|
env["CHATMAIL_DISABLE_MAIL"] = "True" if args.disable_mail else ""
|
||||||
env["CHATMAIL_REQUIRE_IROH"] = "True" if require_iroh else ""
|
env["CHATMAIL_REQUIRE_IROH"] = "True" if require_iroh else ""
|
||||||
if not args.dns_check_disabled:
|
|
||||||
env["CHATMAIL_ADDR_V4"] = remote_data.get("A") or ""
|
|
||||||
env["CHATMAIL_ADDR_V6"] = remote_data.get("AAAA") or ""
|
|
||||||
deploy_path = importlib.resources.files(__package__).joinpath("run.py").resolve()
|
deploy_path = importlib.resources.files(__package__).joinpath("run.py").resolve()
|
||||||
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
|
|
||||||
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y"
|
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y"
|
||||||
if ssh_host in ["localhost", "@docker"]:
|
if ssh_host in ["localhost", "@docker"]:
|
||||||
if ssh_host == "@docker":
|
|
||||||
env["CHATMAIL_NOPORTCHECK"] = "True"
|
|
||||||
env["CHATMAIL_NOSYSCTL"] = "True"
|
|
||||||
cmd = f"{pyinf} @local {deploy_path} -y"
|
cmd = f"{pyinf} @local {deploy_path} -y"
|
||||||
|
|
||||||
if version.parse(pyinfra.__version__) < version.parse("3"):
|
if version.parse(pyinfra.__version__) < version.parse("3"):
|
||||||
@@ -127,7 +121,7 @@ def run_cmd(args, out):
|
|||||||
out.red("Website deployment failed.")
|
out.red("Website deployment failed.")
|
||||||
elif retcode == 0:
|
elif retcode == 0:
|
||||||
out.green("Deploy completed, call `cmdeploy dns` next.")
|
out.green("Deploy completed, call `cmdeploy dns` next.")
|
||||||
elif not args.dns_check_disabled and not remote_data["acme_account_url"]:
|
elif not remote_data["acme_account_url"]:
|
||||||
out.red("Deploy completed but letsencrypt not configured")
|
out.red("Deploy completed but letsencrypt not configured")
|
||||||
out.red("Run 'cmdeploy run' again")
|
out.red("Run 'cmdeploy run' again")
|
||||||
retcode = 0
|
retcode = 0
|
||||||
@@ -331,7 +325,7 @@ def add_config_option(parser):
|
|||||||
"--config",
|
"--config",
|
||||||
dest="inipath",
|
dest="inipath",
|
||||||
action="store",
|
action="store",
|
||||||
default=Path(os.environ.get("CHATMAIL_INI", "chatmail.ini")),
|
default=Path("chatmail.ini"),
|
||||||
type=Path,
|
type=Path,
|
||||||
help="path to the chatmail.ini file",
|
help="path to the chatmail.ini file",
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
Chat Mail pyinfra deploy.
|
Chat Mail pyinfra deploy.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
@@ -11,7 +10,6 @@ from pathlib import Path
|
|||||||
|
|
||||||
from chatmaild.config import read_config
|
from chatmaild.config import read_config
|
||||||
from pyinfra import facts, host, logger
|
from pyinfra import facts, host, logger
|
||||||
from pyinfra.facts import hardware
|
|
||||||
from pyinfra.api import FactBase
|
from pyinfra.api import FactBase
|
||||||
from pyinfra.facts.files import Sha256File
|
from pyinfra.facts.files import Sha256File
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
@@ -26,7 +24,6 @@ from .basedeploy import (
|
|||||||
activate_remote_units,
|
activate_remote_units,
|
||||||
configure_remote_units,
|
configure_remote_units,
|
||||||
get_resource,
|
get_resource,
|
||||||
has_systemd,
|
|
||||||
)
|
)
|
||||||
from .dovecot.deployer import DovecotDeployer
|
from .dovecot.deployer import DovecotDeployer
|
||||||
from .filtermail.deployer import FiltermailDeployer
|
from .filtermail.deployer import FiltermailDeployer
|
||||||
@@ -39,7 +36,7 @@ from .www import build_webpages, find_merge_conflict, get_paths
|
|||||||
|
|
||||||
class Port(FactBase):
|
class Port(FactBase):
|
||||||
"""
|
"""
|
||||||
Returns the process occupying a port.
|
Returns the process occuping a port.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def command(self, port: int) -> str:
|
def command(self, port: int) -> str:
|
||||||
@@ -67,8 +64,6 @@ def _build_chatmaild(dist_dir) -> None:
|
|||||||
|
|
||||||
|
|
||||||
def remove_legacy_artifacts():
|
def remove_legacy_artifacts():
|
||||||
if not has_systemd():
|
|
||||||
return
|
|
||||||
# disable legacy doveauth-dictproxy.service
|
# disable legacy doveauth-dictproxy.service
|
||||||
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
||||||
systemd.service(
|
systemd.service(
|
||||||
@@ -303,7 +298,7 @@ class LegacyRemoveDeployer(Deployer):
|
|||||||
present=False,
|
present=False,
|
||||||
)
|
)
|
||||||
# remove echobot if it is still running
|
# remove echobot if it is still running
|
||||||
if has_systemd() and host.get_fact(SystemdEnabled).get("echobot.service"):
|
if host.get_fact(SystemdEnabled).get("echobot.service"):
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Disable echobot.service",
|
name="Disable echobot.service",
|
||||||
service="echobot.service",
|
service="echobot.service",
|
||||||
@@ -562,43 +557,33 @@ def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -
|
|||||||
line="\nnameserver 9.9.9.9",
|
line="\nnameserver 9.9.9.9",
|
||||||
)
|
)
|
||||||
|
|
||||||
# Check if mtail_address interface is available (if configured)
|
port_services = [
|
||||||
if config.mtail_address and config.mtail_address not in ('127.0.0.1', '::1', 'localhost'):
|
(["master", "smtpd"], 25),
|
||||||
ipv4_addrs = host.get_fact(hardware.Ipv4Addrs)
|
("unbound", 53),
|
||||||
all_addresses = [addr for addrs in ipv4_addrs.values() for addr in addrs]
|
("acmetool", 80),
|
||||||
if config.mtail_address not in all_addresses:
|
(["imap-login", "dovecot"], 143),
|
||||||
Out().red(f"Deploy failed: mtail_address {config.mtail_address} is not available (VPN up?).\n")
|
("nginx", 443),
|
||||||
exit(1)
|
(["master", "smtpd"], 465),
|
||||||
|
(["master", "smtpd"], 587),
|
||||||
if not os.environ.get("CHATMAIL_NOPORTCHECK"):
|
(["imap-login", "dovecot"], 993),
|
||||||
port_services = [
|
("iroh-relay", 3340),
|
||||||
(["master", "smtpd"], 25),
|
("mtail", 3903),
|
||||||
("unbound", 53),
|
("dovecot-stats", 3904),
|
||||||
("acmetool", 80),
|
("nginx", 8443),
|
||||||
(["imap-login", "dovecot"], 143),
|
(["master", "smtpd"], config.postfix_reinject_port),
|
||||||
("nginx", 443),
|
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
||||||
(["master", "smtpd"], 465),
|
("filtermail", config.filtermail_smtp_port),
|
||||||
(["master", "smtpd"], 587),
|
("filtermail", config.filtermail_smtp_port_incoming),
|
||||||
(["imap-login", "dovecot"], 993),
|
]
|
||||||
("iroh-relay", 3340),
|
for service, port in port_services:
|
||||||
("mtail", 3903),
|
print(f"Checking if port {port} is available for {service}...")
|
||||||
("stats", 3904),
|
running_service = host.get_fact(Port, port=port)
|
||||||
("nginx", 8443),
|
if running_service:
|
||||||
(["master", "smtpd"], config.postfix_reinject_port),
|
if running_service not in service:
|
||||||
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
Out().red(
|
||||||
("filtermail", config.filtermail_smtp_port),
|
f"Deploy failed: port {port} is occupied by: {running_service}"
|
||||||
("filtermail", config.filtermail_smtp_port_incoming),
|
)
|
||||||
]
|
exit(1)
|
||||||
for service, port in port_services:
|
|
||||||
print(f"Checking if port {port} is available for {service}...")
|
|
||||||
running_service = host.get_fact(Port, port=port)
|
|
||||||
services = [service] if isinstance(service, str) else service
|
|
||||||
if running_service:
|
|
||||||
if running_service not in services:
|
|
||||||
Out().red(
|
|
||||||
f"Deploy failed: port {port} is occupied by: {running_service}"
|
|
||||||
)
|
|
||||||
exit(1)
|
|
||||||
|
|
||||||
tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"]
|
tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"]
|
||||||
|
|
||||||
@@ -610,12 +595,7 @@ def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -
|
|||||||
UnboundDeployer(config),
|
UnboundDeployer(config),
|
||||||
TurnDeployer(mail_domain),
|
TurnDeployer(mail_domain),
|
||||||
IrohDeployer(config.enable_iroh_relay),
|
IrohDeployer(config.enable_iroh_relay),
|
||||||
]
|
AcmetoolDeployer(config.acme_email, tls_domains),
|
||||||
|
|
||||||
if not config.noacme:
|
|
||||||
all_deployers.append(AcmetoolDeployer(config.acme_email, tls_domains))
|
|
||||||
|
|
||||||
all_deployers += [
|
|
||||||
WebsiteDeployer(config),
|
WebsiteDeployer(config),
|
||||||
ChatmailVenvDeployer(config),
|
ChatmailVenvDeployer(config),
|
||||||
MtastsDeployer(),
|
MtastsDeployer(),
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
import os
|
|
||||||
|
|
||||||
from chatmaild.config import Config
|
from chatmaild.config import Config
|
||||||
from pyinfra import host
|
from pyinfra import host
|
||||||
from pyinfra.facts.server import Arch, Sysctl
|
from pyinfra.facts.server import Arch, Sysctl
|
||||||
@@ -11,7 +9,6 @@ from cmdeploy.basedeploy import (
|
|||||||
activate_remote_units,
|
activate_remote_units,
|
||||||
configure_remote_units,
|
configure_remote_units,
|
||||||
get_resource,
|
get_resource,
|
||||||
has_systemd,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -25,11 +22,10 @@ class DovecotDeployer(Deployer):
|
|||||||
|
|
||||||
def install(self):
|
def install(self):
|
||||||
arch = host.get_fact(Arch)
|
arch = host.get_fact(Arch)
|
||||||
if has_systemd() and "dovecot.service" in host.get_fact(SystemdEnabled):
|
if not "dovecot.service" in host.get_fact(SystemdEnabled):
|
||||||
return # already installed and running
|
_install_dovecot_package("core", arch)
|
||||||
_install_dovecot_package("core", arch)
|
_install_dovecot_package("imapd", arch)
|
||||||
_install_dovecot_package("imapd", arch)
|
_install_dovecot_package("lmtpd", arch)
|
||||||
_install_dovecot_package("lmtpd", arch)
|
|
||||||
|
|
||||||
def configure(self):
|
def configure(self):
|
||||||
configure_remote_units(self.config.mail_domain, self.units)
|
configure_remote_units(self.config.mail_domain, self.units)
|
||||||
@@ -120,19 +116,18 @@ def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
|
|||||||
|
|
||||||
# as per https://doc.dovecot.org/2.3/configuration_manual/os/
|
# as per https://doc.dovecot.org/2.3/configuration_manual/os/
|
||||||
# it is recommended to set the following inotify limits
|
# it is recommended to set the following inotify limits
|
||||||
if not os.environ.get("CHATMAIL_NOSYSCTL"):
|
for name in ("max_user_instances", "max_user_watches"):
|
||||||
for name in ("max_user_instances", "max_user_watches"):
|
key = f"fs.inotify.{name}"
|
||||||
key = f"fs.inotify.{name}"
|
if host.get_fact(Sysctl)[key] > 65535:
|
||||||
if host.get_fact(Sysctl)[key] > 65535:
|
# Skip updating limits if already sufficient
|
||||||
# Skip updating limits if already sufficient
|
# (enables running in incus containers where sysctl readonly)
|
||||||
# (enables running in incus containers where sysctl readonly)
|
continue
|
||||||
continue
|
server.sysctl(
|
||||||
server.sysctl(
|
name=f"Change {key}",
|
||||||
name=f"Change {key}",
|
key=key,
|
||||||
key=key,
|
value=65535,
|
||||||
value=65535,
|
persist=True,
|
||||||
persist=True,
|
)
|
||||||
)
|
|
||||||
|
|
||||||
timezone_env = files.line(
|
timezone_env = files.line(
|
||||||
name="Set TZ environment variable",
|
name="Set TZ environment variable",
|
||||||
|
|||||||
@@ -68,13 +68,11 @@ userdb {
|
|||||||
##
|
##
|
||||||
|
|
||||||
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
||||||
|
{% if config.tmpfs_index %}
|
||||||
|
mail_location = maildir:{{ config.mailboxes_dir }}/%u:INDEX=/dev/shm/%u
|
||||||
|
{% else %}
|
||||||
mail_location = maildir:{{ config.mailboxes_dir }}/%u
|
mail_location = maildir:{{ config.mailboxes_dir }}/%u
|
||||||
|
{% endif %}
|
||||||
# index/cache files are not very useful for chatmail relay operations
|
|
||||||
# but it's not clear how to disable them completely.
|
|
||||||
# According to https://doc.dovecot.org/2.3/settings/advanced/#core_setting-mail_cache_max_size
|
|
||||||
# if the cache file becomes larger than the specified size, it is truncated by dovecot
|
|
||||||
mail_cache_max_size = 500K
|
|
||||||
|
|
||||||
namespace inbox {
|
namespace inbox {
|
||||||
inbox = yes
|
inbox = yes
|
||||||
|
|||||||
@@ -14,10 +14,10 @@ class FiltermailDeployer(Deployer):
|
|||||||
|
|
||||||
def install(self):
|
def install(self):
|
||||||
arch = host.get_fact(facts.server.Arch)
|
arch = host.get_fact(facts.server.Arch)
|
||||||
url = f"https://github.com/chatmail/filtermail/releases/download/v0.3.0/filtermail-{arch}"
|
url = f"https://github.com/chatmail/filtermail/releases/download/v0.2.0/filtermail-{arch}-musl"
|
||||||
sha256sum = {
|
sha256sum = {
|
||||||
"x86_64": "f14a31323ae2dad3b59d3fdafcde507521da2f951a9478cd1f2fe2b4463df71d",
|
"x86_64": "1e5bbb646582cb16740c6dfbbca39edba492b78cc96ec9fa2528c612bb504edd",
|
||||||
"aarch64": "933770d75046c4fd7084ce8d43f905f8748333426ad839154f0fc654755ef09f",
|
"aarch64": "3564fba8605f8f9adfeefff3f4580533205da043f47c5968d0d10db17e50f44e",
|
||||||
}[arch]
|
}[arch]
|
||||||
self.need_restart |= files.download(
|
self.need_restart |= files.download(
|
||||||
name="Download filtermail",
|
name="Download filtermail",
|
||||||
|
|||||||
@@ -61,20 +61,6 @@ class PostfixDeployer(Deployer):
|
|||||||
)
|
)
|
||||||
need_restart |= lmtp_header_cleanup.changed
|
need_restart |= lmtp_header_cleanup.changed
|
||||||
|
|
||||||
tls_policy_map = files.put(
|
|
||||||
name="Upload SMTP TLS Policy that accepts self-signed certificates for IP-only hosts",
|
|
||||||
src=get_resource("postfix/smtp_tls_policy_map"),
|
|
||||||
dest="/etc/postfix/smtp_tls_policy_map",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= tls_policy_map.changed
|
|
||||||
if tls_policy_map.changed:
|
|
||||||
server.shell(
|
|
||||||
commands=["postmap /etc/postfix/smtp_tls_policy_map"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# Login map that 1:1 maps email address to login.
|
# Login map that 1:1 maps email address to login.
|
||||||
login_map = files.put(
|
login_map = files.put(
|
||||||
src=get_resource("postfix/login_map"),
|
src=get_resource("postfix/login_map"),
|
||||||
|
|||||||
@@ -1,3 +1,2 @@
|
|||||||
/^DKIM-Signature:/ IGNORE
|
/^DKIM-Signature:/ IGNORE
|
||||||
/^Authentication-Results:/ IGNORE
|
/^Authentication-Results:/ IGNORE
|
||||||
/^Received:/ IGNORE
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ smtp_tls_security_level=verify
|
|||||||
# <https://www.postfix.org/postconf.5.html#smtp_tls_servername>
|
# <https://www.postfix.org/postconf.5.html#smtp_tls_servername>
|
||||||
smtp_tls_servername = hostname
|
smtp_tls_servername = hostname
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
smtp_tls_policy_maps = regexp:/etc/postfix/smtp_tls_policy_map
|
smtp_tls_policy_maps = inline:{nauta.cu=may}
|
||||||
smtp_tls_protocols = >=TLSv1.2
|
smtp_tls_protocols = >=TLSv1.2
|
||||||
smtp_tls_mandatory_protocols = >=TLSv1.2
|
smtp_tls_mandatory_protocols = >=TLSv1.2
|
||||||
|
|
||||||
@@ -69,15 +69,6 @@ mynetworks = 127.0.0.0/8
|
|||||||
{% else %}
|
{% else %}
|
||||||
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% if config.addr_v4 %}
|
|
||||||
smtp_bind_address = {{ config.addr_v4 }}
|
|
||||||
{% endif %}
|
|
||||||
{% if config.addr_v6 %}
|
|
||||||
smtp_bind_address6 = {{ config.addr_v6 }}
|
|
||||||
{% endif %}
|
|
||||||
{% if config.addr_v4 or config.addr_v6 %}
|
|
||||||
smtp_bind_address_enforce = yes
|
|
||||||
{% endif %}
|
|
||||||
mailbox_size_limit = 0
|
mailbox_size_limit = 0
|
||||||
message_size_limit = {{config.max_message_size}}
|
message_size_limit = {{config.max_message_size}}
|
||||||
recipient_delimiter = +
|
recipient_delimiter = +
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
/^\[[^]]+\]$/ encrypt
|
|
||||||
/^nauta\.cu$/ may
|
|
||||||
@@ -89,11 +89,6 @@ class LocalExec:
|
|||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
self.docker = docker
|
self.docker = docker
|
||||||
|
|
||||||
def __call__(self, call, kwargs=None, log_callback=None):
|
|
||||||
if kwargs is None:
|
|
||||||
kwargs = {}
|
|
||||||
return call(**kwargs)
|
|
||||||
|
|
||||||
def logged(self, call, kwargs: dict):
|
def logged(self, call, kwargs: dict):
|
||||||
where = "locally"
|
where = "locally"
|
||||||
if self.docker:
|
if self.docker:
|
||||||
|
|||||||
@@ -1,262 +0,0 @@
|
|||||||
Docker installation
|
|
||||||
===================
|
|
||||||
|
|
||||||
This section provides instructions for installing a chatmail relay
|
|
||||||
using Docker Compose.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
Docker support is experimental and not yet covered by automated tests, please report bugs.
|
|
||||||
|
|
||||||
|
|
||||||
Known limitations
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
- Requires cgroups v2 on the host. Operation with cgroups v1 has not been tested.
|
|
||||||
- This preliminary image simply wraps the cmdeploy process detailed in the :doc:`getting_started` instructions in a full Debian-systemd image.
|
|
||||||
- Currently, the image has only been tested and built on amd64, though arm64 should theoretically work as well.
|
|
||||||
|
|
||||||
|
|
||||||
Prerequisites
|
|
||||||
-------------
|
|
||||||
|
|
||||||
- **Docker Compose v2** (``docker compose``, not ``docker-compose``) is
|
|
||||||
required for its ``cgroup: host`` support (`Install instructions <https://docs.docker.com/engine/install/debian/#install-using-the-repository>`_:)
|
|
||||||
|
|
||||||
- **DNS records** for your domain (see step 1 below).
|
|
||||||
|
|
||||||
- **Kernel parameters** — ``fs.inotify.max_user_instances`` and
|
|
||||||
``fs.inotify.max_user_watches`` must be raised on the host because they
|
|
||||||
cannot be changed inside the container (see step 2 below).
|
|
||||||
|
|
||||||
|
|
||||||
Preliminary setup
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
We use ``chat.example.org`` as the chatmail domain in the following
|
|
||||||
steps. Please substitute it with your own domain.
|
|
||||||
|
|
||||||
1. Setup the initial DNS records.
|
|
||||||
The following is an example in the familiar BIND zone file format with
|
|
||||||
a TTL of 1 hour (3600 seconds).
|
|
||||||
Please substitute your domain and IP addresses.
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
chat.example.org. 3600 IN A 198.51.100.5
|
|
||||||
chat.example.org. 3600 IN AAAA 2001:db8::5
|
|
||||||
www.chat.example.org. 3600 IN CNAME chat.example.org.
|
|
||||||
mta-sts.chat.example.org. 3600 IN CNAME chat.example.org.
|
|
||||||
|
|
||||||
2. Configure kernel parameters on the host, as these can not be set from the container::
|
|
||||||
|
|
||||||
echo "fs.inotify.max_user_instances=65536" | sudo tee -a /etc/sysctl.d/99-inotify.conf
|
|
||||||
echo "fs.inotify.max_user_watches=65536" | sudo tee -a /etc/sysctl.d/99-inotify.conf
|
|
||||||
sudo sysctl --system
|
|
||||||
|
|
||||||
|
|
||||||
Docker Compose Setup
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
Pre-built images are available from GitHub Container Registry. The
|
|
||||||
``main`` branch and tagged releases are pushed automatically by CI::
|
|
||||||
|
|
||||||
docker pull ghcr.io/chatmail/relay:main # latest main branch
|
|
||||||
docker pull ghcr.io/chatmail/relay:1.2.3 # tagged release
|
|
||||||
|
|
||||||
|
|
||||||
Create service directory
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
Either:
|
|
||||||
|
|
||||||
- Create a service directory, e.g., `/srv/chatmail-relay`::
|
|
||||||
|
|
||||||
mkdir -p /srv/chatmail-relay && cd /srv/chatmail-relay
|
|
||||||
wget https://raw.githubusercontent.com/chatmail/relay/refs/heads/main/docker-compose.yaml https://raw.githubusercontent.com/chatmail/relay/refs/heads/main/docker-compose.override.yaml.example
|
|
||||||
wget https://raw.githubusercontent.com/chatmail/relay/refs/heads/main/docker/env.example -O .env
|
|
||||||
|
|
||||||
|
|
||||||
- or clone the chatmail repo ::
|
|
||||||
|
|
||||||
git clone https://github.com/chatmail/relay
|
|
||||||
cd relay
|
|
||||||
cp example.env .env
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Customize and start
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
1. All local customizations (data paths, extra volumes, config mounts) go in
|
|
||||||
``docker-compose.override.yaml``, which Compose merges automatically with
|
|
||||||
the base file. By default, all data is stored in docker volumes, you will
|
|
||||||
likely want to at least create and configure the mail storage location. Copy
|
|
||||||
the example to get started::
|
|
||||||
|
|
||||||
cp docker/docker-compose.override.yaml.example docker-compose.override.yaml
|
|
||||||
# and edit docker-compose.override.yaml
|
|
||||||
|
|
||||||
|
|
||||||
2. Configure the ``.env`` file. Only ``MAIL_DOMAIN`` is required, the domain
|
|
||||||
name of the future server.
|
|
||||||
|
|
||||||
The container generates a ``chatmail.ini`` with defaults from
|
|
||||||
``MAIL_DOMAIN`` on first start. To customize chatmail settings, mount
|
|
||||||
your own ``chatmail.ini`` instead (see `Custom chatmail.ini`_ below).
|
|
||||||
|
|
||||||
3. Start the container::
|
|
||||||
|
|
||||||
docker compose up -d
|
|
||||||
docker compose logs -f chatmail # view logs, Ctrl+C to exit
|
|
||||||
|
|
||||||
4. After installation is complete, open ``https://chat.example.org`` in
|
|
||||||
your browser.
|
|
||||||
|
|
||||||
|
|
||||||
Managing the server
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
Use ``docker exec`` to run cmdeploy commands inside the container::
|
|
||||||
|
|
||||||
# Show required DNS records
|
|
||||||
docker exec chatmail /opt/cmdeploy/bin/cmdeploy dns --ssh-host @local
|
|
||||||
|
|
||||||
# Check server status
|
|
||||||
docker exec chatmail /opt/cmdeploy/bin/cmdeploy status --ssh-host @local
|
|
||||||
|
|
||||||
# Run benchmarks (can also run from any machine with cmdeploy installed)
|
|
||||||
docker exec chatmail /opt/cmdeploy/bin/cmdeploy bench chat.example.org
|
|
||||||
|
|
||||||
|
|
||||||
Customization
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Custom website
|
|
||||||
^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
You can customize the chatmail landing page by mounting a directory with
|
|
||||||
your own website source files.
|
|
||||||
|
|
||||||
1. Create a directory with your custom website source::
|
|
||||||
|
|
||||||
mkdir -p ./custom/www/src
|
|
||||||
nano ./custom/www/src/index.md
|
|
||||||
|
|
||||||
2. Add the volume mount in ``docker-compose.override.yaml``::
|
|
||||||
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
volumes:
|
|
||||||
- ./custom/www:/opt/chatmail-www
|
|
||||||
|
|
||||||
3. Restart the service::
|
|
||||||
|
|
||||||
docker compose down
|
|
||||||
docker compose up -d
|
|
||||||
|
|
||||||
|
|
||||||
Custom chatmail.ini
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
There are two configuration modes:
|
|
||||||
|
|
||||||
**Simple (default):** Set ``MAIL_DOMAIN`` in ``.env``. The container
|
|
||||||
auto-generates ``chatmail.ini`` with defaults on first start. This is
|
|
||||||
sufficient for most deployments.
|
|
||||||
|
|
||||||
**Advanced:** Generate a ``chatmail.ini``, edit it, and mount it into
|
|
||||||
the container. This gives you full control over all chatmail settings.
|
|
||||||
|
|
||||||
1. Extract the generated config from a running container::
|
|
||||||
|
|
||||||
docker cp chatmail:/etc/chatmail/chatmail.ini ./chatmail.ini
|
|
||||||
|
|
||||||
2. Edit ``chatmail.ini`` as needed.
|
|
||||||
|
|
||||||
3. Add the volume mount in ``docker-compose.override.yaml`` ::
|
|
||||||
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
volumes:
|
|
||||||
- ./chatmail.ini:/etc/chatmail/chatmail.ini
|
|
||||||
|
|
||||||
4. Restart the container, the container skips generating a new one: ::
|
|
||||||
|
|
||||||
docker compose down && docker compose up -d
|
|
||||||
|
|
||||||
|
|
||||||
Migrating from a bare-metal install
|
|
||||||
------------------------------------
|
|
||||||
|
|
||||||
If you have an existing bare-metal chatmail installation and want to
|
|
||||||
switch to Docker:
|
|
||||||
|
|
||||||
1. Stop all existing services::
|
|
||||||
|
|
||||||
systemctl stop postfix dovecot doveauth nginx opendkim unbound \
|
|
||||||
acmetool-redirector filtermail filtermail-incoming chatmail-turn \
|
|
||||||
iroh-relay chatmail-metadata lastlogin mtail
|
|
||||||
systemctl disable postfix dovecot doveauth nginx opendkim unbound \
|
|
||||||
acmetool-redirector filtermail filtermail-incoming chatmail-turn \
|
|
||||||
iroh-relay chatmail-metadata lastlogin mtail
|
|
||||||
|
|
||||||
2. Copy your existing ``chatmail.ini`` and mount it into the container
|
|
||||||
(see `Custom chatmail.ini`_ above)::
|
|
||||||
|
|
||||||
cp /usr/local/lib/chatmaild/chatmail.ini ./chatmail.ini
|
|
||||||
|
|
||||||
3. Copy persistent data into the ``./data/`` subdirectories (for example, as configured in `Customize and start`_) ::
|
|
||||||
|
|
||||||
mkdir -p data/chatmail-dkimkeys data/chatmail-acme data/chatmail
|
|
||||||
|
|
||||||
# DKIM keys
|
|
||||||
cp -a /etc/dkimkeys/* data/chatmail-dkimkeys/
|
|
||||||
|
|
||||||
# ACME certificates and account
|
|
||||||
rsync -a /var/lib/acme/ data/chatmail-acme/
|
|
||||||
|
|
||||||
# Mail data
|
|
||||||
rsync -a /home/ data/chatmail/
|
|
||||||
|
|
||||||
Alternatively, mount ``/home/vmail`` directly by changing the volume
|
|
||||||
in ``docker-compose-override.yaml``::
|
|
||||||
|
|
||||||
- /home/vmail:/home/vmail
|
|
||||||
|
|
||||||
The three ``./data/`` subdirectories cover all persistent state.
|
|
||||||
Everything else is regenerated by the ``configure`` and ``activate``
|
|
||||||
stages on container start.
|
|
||||||
|
|
||||||
Building the image
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Clone the repository and build the Docker image::
|
|
||||||
|
|
||||||
git clone https://github.com/chatmail/relay
|
|
||||||
cd relay
|
|
||||||
docker compose build chatmail
|
|
||||||
|
|
||||||
The build bakes all binaries, Python packages, and the install stage
|
|
||||||
into the image. After building, only ``docker-compose.yaml`` and ``.env``
|
|
||||||
are needed to run the container.
|
|
||||||
|
|
||||||
You can transfer a locally built image to your server directly (pigz is parallel `gzip` which can be used instead as well) ::
|
|
||||||
|
|
||||||
docker save chatmail-relay:latest | pigz | ssh chat.example.org 'pigz -d | docker load'
|
|
||||||
|
|
||||||
|
|
||||||
Forcing a full reinstall
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
On container start, only the ``configure`` and ``activate`` stages run by default.
|
|
||||||
|
|
||||||
To force a full reinstall (e.g. after updating the source), either
|
|
||||||
rebuild the image::
|
|
||||||
|
|
||||||
docker compose build chatmail
|
|
||||||
docker compose up -d
|
|
||||||
|
|
||||||
Or override the stages at runtime without rebuilding::
|
|
||||||
|
|
||||||
CMDEPLOY_STAGES="install,configure,activate" docker compose up -d
|
|
||||||
@@ -80,12 +80,6 @@ steps. Please substitute it with your own domain.
|
|||||||
configure at your DNS provider (it can take some time until they are
|
configure at your DNS provider (it can take some time until they are
|
||||||
public).
|
public).
|
||||||
|
|
||||||
Docker installation
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
There is experimental support for running chatmail via Docker Compose.
|
|
||||||
See :doc:`docker` for full setup instructions.
|
|
||||||
|
|
||||||
Other helpful commands
|
Other helpful commands
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ Contributions and feedback welcome through the https://github.com/chatmail/relay
|
|||||||
:maxdepth: 5
|
:maxdepth: 5
|
||||||
|
|
||||||
getting_started
|
getting_started
|
||||||
docker
|
|
||||||
proxy
|
proxy
|
||||||
migrate
|
migrate
|
||||||
overview
|
overview
|
||||||
|
|||||||
@@ -14,8 +14,8 @@ We know of three work-in-progress alternative implementation efforts:
|
|||||||
it to support all of the features and configuration settings required
|
it to support all of the features and configuration settings required
|
||||||
to operate as a chatmail relay.
|
to operate as a chatmail relay.
|
||||||
|
|
||||||
- `Madmail <https://github.com/themadorg/madmail>`_: an
|
- `Madmail <https://github.com/omidz4t/madmail>`_: an
|
||||||
experimental fork of `Maddy Mail Server <https://maddy.email/>`_, modified
|
experimental fork of Maddy Mail Server <https://maddy.email/>`_ optimized
|
||||||
for chatmail deployments. It provides a single binary solution
|
for chatmail deployments. It provides a single binary solution
|
||||||
for running a chatmail relay.
|
for running a chatmail relay.
|
||||||
|
|
||||||
|
|||||||
@@ -1,33 +0,0 @@
|
|||||||
# Local overrides — copy to docker-compose.override.yaml in the repo root.
|
|
||||||
# Compose automatically merges this with docker-compose.yaml.
|
|
||||||
#
|
|
||||||
# cp docker/docker-compose.override.yaml.example docker-compose.override.yaml
|
|
||||||
#
|
|
||||||
# Volumes listed here are APPENDED to the base file's volumes.
|
|
||||||
# Scalar values (environment, image, etc.) are REPLACED.
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
volumes:
|
|
||||||
## Data paths — bind-mount to host directories for easy access/backup.
|
|
||||||
## Uncomment and adjust paths as needed. These override the named
|
|
||||||
## volumes in the base docker-compose.yaml.
|
|
||||||
# - ./data/chatmail:/home/vmail
|
|
||||||
# - ./data/chatmail-dkimkeys:/etc/dkimkeys
|
|
||||||
# - ./data/chatmail-acme:/var/lib/acme
|
|
||||||
|
|
||||||
## Or mount data from an existing bare-metal install.
|
|
||||||
## Note: DKIM key ownership is fixed automatically on startup
|
|
||||||
## (the host's opendkim UID may differ from the container's).
|
|
||||||
# - /home/vmail:/home/vmail
|
|
||||||
# - /etc/dkimkeys:/etc/dkimkeys
|
|
||||||
# - /var/lib/acme:/var/lib/acme
|
|
||||||
|
|
||||||
## Mount your own chatmail.ini (skips auto-generation):
|
|
||||||
# - ./chatmail.ini:/etc/chatmail/chatmail.ini
|
|
||||||
|
|
||||||
## Custom website:
|
|
||||||
# - ./custom/www:/opt/chatmail-www
|
|
||||||
|
|
||||||
## Debug — mount scripts from the repo for live editing:
|
|
||||||
# - ./docker/files/setup_chatmail_docker.sh:/setup_chatmail_docker.sh
|
|
||||||
# - ./docker/files/entrypoint.sh:/entrypoint.sh
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
# Base compose file — do not edit. Put customizations (data paths, extra
|
|
||||||
# volumes, env overrides) in docker-compose.override.yaml instead.
|
|
||||||
# See docker/docker-compose.override.yaml.example for a starting point.
|
|
||||||
#
|
|
||||||
# Security note: this container uses network_mode:host (chatmail needs many
|
|
||||||
# ports: 25, 53, 80, 143, 443, 465, 587, 993, 3340, 8443) and cgroup:host
|
|
||||||
# (required for systemd). Together these give the container near-host-level
|
|
||||||
# access. This is acceptable for a dedicated mail server, but be aware that
|
|
||||||
# the container can bind any port and see all host network traffic.
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
build:
|
|
||||||
context: ./
|
|
||||||
dockerfile: docker/chatmail_relay.dockerfile
|
|
||||||
args:
|
|
||||||
GIT_HASH: ${GIT_HASH:-unknown}
|
|
||||||
image: chatmail-relay:latest
|
|
||||||
restart: unless-stopped
|
|
||||||
container_name: chatmail
|
|
||||||
# Required for systemd — use only one of the following:
|
|
||||||
cgroup: host # compose v2 only
|
|
||||||
# privileged: true # compose v1 (not tested)
|
|
||||||
tty: true # required for logs
|
|
||||||
tmpfs: # required for systemd
|
|
||||||
- /tmp
|
|
||||||
- /run
|
|
||||||
- /run/lock
|
|
||||||
logging:
|
|
||||||
driver: json-file
|
|
||||||
options:
|
|
||||||
max-size: "10m"
|
|
||||||
max-file: "3"
|
|
||||||
environment:
|
|
||||||
MAIL_DOMAIN: $MAIL_DOMAIN
|
|
||||||
CMDEPLOY_STAGES: ${CMDEPLOY_STAGES:-}
|
|
||||||
CHATMAIL_NOSYSCTL: ${CHATMAIL_NOSYSCTL:-True}
|
|
||||||
CHATMAIL_NOPORTCHECK: ${CHATMAIL_NOPORTCHECK:-True}
|
|
||||||
CHATMAIL_NOACME: ${CHATMAIL_NOACME:-}
|
|
||||||
network_mode: "host"
|
|
||||||
volumes:
|
|
||||||
## system (required)
|
|
||||||
- /sys/fs/cgroup:/sys/fs/cgroup:rw
|
|
||||||
## data (defaults — override in docker-compose.override.yaml)
|
|
||||||
- chatmail-data:/home/vmail
|
|
||||||
- chatmail-dkimkeys:/etc/dkimkeys
|
|
||||||
- chatmail-acme:/var/lib/acme
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
chatmail-data:
|
|
||||||
chatmail-dkimkeys:
|
|
||||||
chatmail-acme:
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# Build the chatmail Docker image with the current git hash baked in.
|
|
||||||
# Usage: ./docker/build.sh [extra docker-compose build args...]
|
|
||||||
#
|
|
||||||
# .git/ is excluded from the build context (.dockerignore) so the hash
|
|
||||||
# must be passed as a build arg from the host.
|
|
||||||
|
|
||||||
export GIT_HASH=$(git rev-parse --short HEAD)
|
|
||||||
exec docker compose build "$@"
|
|
||||||
@@ -1,105 +0,0 @@
|
|||||||
FROM jrei/systemd-debian:12 AS base
|
|
||||||
|
|
||||||
ENV LANG=en_US.UTF-8
|
|
||||||
|
|
||||||
RUN echo 'APT::Install-Recommends "0";' > /etc/apt/apt.conf.d/01norecommend && \
|
|
||||||
echo 'APT::Install-Suggests "0";' >> /etc/apt/apt.conf.d/01norecommend && \
|
|
||||||
apt-get update && \
|
|
||||||
apt-get install -y \
|
|
||||||
ca-certificates && \
|
|
||||||
DEBIAN_FRONTEND=noninteractive \
|
|
||||||
TZ=UTC \
|
|
||||||
apt-get install -y tzdata && \
|
|
||||||
apt-get install -y locales && \
|
|
||||||
sed -i -e "s/# $LANG.*/$LANG UTF-8/" /etc/locale.gen && \
|
|
||||||
dpkg-reconfigure --frontend=noninteractive locales && \
|
|
||||||
update-locale LANG=$LANG \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
||||||
RUN apt-get update && \
|
|
||||||
apt-get install -y \
|
|
||||||
git \
|
|
||||||
python3 \
|
|
||||||
python3-venv \
|
|
||||||
python3-virtualenv \
|
|
||||||
gcc \
|
|
||||||
python3-dev \
|
|
||||||
opendkim \
|
|
||||||
opendkim-tools \
|
|
||||||
curl \
|
|
||||||
rsync \
|
|
||||||
unbound \
|
|
||||||
unbound-anchor \
|
|
||||||
dnsutils \
|
|
||||||
postfix \
|
|
||||||
acl \
|
|
||||||
nginx \
|
|
||||||
libnginx-mod-stream \
|
|
||||||
fcgiwrap \
|
|
||||||
cron \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
||||||
# --- Build-time: install cmdeploy venv and run install stage ---
|
|
||||||
# Editable install so importlib.resources reads directly from the source tree.
|
|
||||||
# On container start only "configure,activate" stages run.
|
|
||||||
COPY . /opt/chatmail/
|
|
||||||
WORKDIR /opt/chatmail
|
|
||||||
|
|
||||||
RUN printf '[params]\nmail_domain = build.local\n' > /tmp/chatmail.ini
|
|
||||||
|
|
||||||
# Dummy git repo init: .git/ is excluded from the build context (.dockerignore)
|
|
||||||
# but setuptools calls `git ls-files` when building the sdist.
|
|
||||||
RUN git init -q && \
|
|
||||||
python3 -m venv /opt/cmdeploy && \
|
|
||||||
/opt/cmdeploy/bin/pip install --no-cache-dir \
|
|
||||||
-e chatmaild/ -e cmdeploy/
|
|
||||||
|
|
||||||
RUN CMDEPLOY_STAGES=install \
|
|
||||||
CHATMAIL_INI=/tmp/chatmail.ini \
|
|
||||||
CHATMAIL_NOSYSCTL=True \
|
|
||||||
CHATMAIL_NOPORTCHECK=True \
|
|
||||||
/opt/cmdeploy/bin/pyinfra @local \
|
|
||||||
/opt/chatmail/cmdeploy/src/cmdeploy/run.py -y
|
|
||||||
|
|
||||||
RUN cp -a www/ /opt/chatmail-www/
|
|
||||||
|
|
||||||
RUN rm -f /tmp/chatmail.ini
|
|
||||||
|
|
||||||
# Record image version (used in deploy fingerprint at runtime).
|
|
||||||
# GIT_HASH is passed as a build arg (from docker-compose or CI) so that
|
|
||||||
# .git/ can be excluded from the build context via .dockerignore.
|
|
||||||
ARG GIT_HASH=unknown
|
|
||||||
RUN echo "$GIT_HASH" > /etc/chatmail-image-version && \
|
|
||||||
echo "$GIT_HASH" > /etc/chatmail-version
|
|
||||||
# --- End build-time install ---
|
|
||||||
|
|
||||||
ENV CHATMAIL_INI=/etc/chatmail/chatmail.ini
|
|
||||||
ENV PATH="/opt/cmdeploy/bin:${PATH}"
|
|
||||||
RUN ln -s /etc/chatmail/chatmail.ini /opt/chatmail/chatmail.ini
|
|
||||||
|
|
||||||
ARG SETUP_CHATMAIL_SERVICE_PATH=/lib/systemd/system/setup_chatmail.service
|
|
||||||
COPY ./docker/files/setup_chatmail.service "$SETUP_CHATMAIL_SERVICE_PATH"
|
|
||||||
RUN ln -sf "$SETUP_CHATMAIL_SERVICE_PATH" "/etc/systemd/system/multi-user.target.wants/setup_chatmail.service"
|
|
||||||
|
|
||||||
# Remove default nginx site config at build time (not in entrypoint)
|
|
||||||
RUN rm -f /etc/nginx/sites-enabled/default
|
|
||||||
|
|
||||||
COPY --chmod=555 ./docker/files/setup_chatmail_docker.sh /setup_chatmail_docker.sh
|
|
||||||
COPY --chmod=555 ./docker/files/entrypoint.sh /entrypoint.sh
|
|
||||||
|
|
||||||
# Certificate monitoring as a proper systemd timer (not a background process)
|
|
||||||
COPY --chmod=555 ./docker/files/chatmail-certmon.sh /chatmail-certmon.sh
|
|
||||||
COPY ./docker/files/chatmail-certmon.service /lib/systemd/system/chatmail-certmon.service
|
|
||||||
COPY ./docker/files/chatmail-certmon.timer /lib/systemd/system/chatmail-certmon.timer
|
|
||||||
RUN ln -sf /lib/systemd/system/chatmail-certmon.timer /etc/systemd/system/timers.target.wants/chatmail-certmon.timer
|
|
||||||
|
|
||||||
HEALTHCHECK --interval=60s --timeout=10s --retries=3 \
|
|
||||||
CMD systemctl is-active dovecot postfix nginx unbound opendkim filtermail doveauth chatmail-metadata || exit 1
|
|
||||||
|
|
||||||
STOPSIGNAL SIGRTMIN+3
|
|
||||||
|
|
||||||
ENTRYPOINT ["/entrypoint.sh"]
|
|
||||||
|
|
||||||
CMD [ "--default-standard-output=journal+console", \
|
|
||||||
"--default-standard-error=journal+console" ]
|
|
||||||
|
|
||||||
@@ -1,116 +0,0 @@
|
|||||||
# Traefik reverse proxy + cert manager for chatmail.
|
|
||||||
# Use this instead of docker-compose.yaml when Traefik manages TLS certificates.
|
|
||||||
#
|
|
||||||
# Required .env vars:
|
|
||||||
# MAIL_DOMAIN=chat.example.com
|
|
||||||
# ACME_EMAIL=admin@example.com
|
|
||||||
#
|
|
||||||
# Usage:
|
|
||||||
# cp docker/example-traefik.env .env
|
|
||||||
# docker compose -f docker/docker-compose-traefik.yaml build
|
|
||||||
# docker compose -f docker/docker-compose-traefik.yaml up -d
|
|
||||||
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
build:
|
|
||||||
context: ../
|
|
||||||
dockerfile: docker/chatmail_relay.dockerfile
|
|
||||||
image: chatmail-relay:latest
|
|
||||||
restart: unless-stopped
|
|
||||||
container_name: chatmail
|
|
||||||
depends_on:
|
|
||||||
traefik-certs-dumper:
|
|
||||||
condition: service_started
|
|
||||||
cgroup: host
|
|
||||||
tty: true
|
|
||||||
tmpfs:
|
|
||||||
- /tmp
|
|
||||||
- /run
|
|
||||||
- /run/lock
|
|
||||||
logging:
|
|
||||||
driver: json-file
|
|
||||||
options:
|
|
||||||
max-size: "10m"
|
|
||||||
max-file: "3"
|
|
||||||
environment:
|
|
||||||
MAIL_DOMAIN: $MAIL_DOMAIN
|
|
||||||
CMDEPLOY_STAGES: ${CMDEPLOY_STAGES:-}
|
|
||||||
CHATMAIL_NOACME: "true"
|
|
||||||
PATH_TO_SSL: /var/lib/acme/live/${MAIL_DOMAIN}
|
|
||||||
ports:
|
|
||||||
- "25:25"
|
|
||||||
- "143:143"
|
|
||||||
- "465:465"
|
|
||||||
- "587:587"
|
|
||||||
- "993:993"
|
|
||||||
volumes:
|
|
||||||
- /sys/fs/cgroup:/sys/fs/cgroup:rw
|
|
||||||
- chatmail-data:/home
|
|
||||||
- chatmail-dkimkeys:/etc/dkimkeys
|
|
||||||
- traefik-certs:/var/lib/acme/live:ro
|
|
||||||
|
|
||||||
labels:
|
|
||||||
- traefik.enable=true
|
|
||||||
- traefik.http.services.chatmail.loadbalancer.server.scheme=https
|
|
||||||
- traefik.http.services.chatmail.loadbalancer.server.port=443
|
|
||||||
- traefik.http.services.chatmail.loadbalancer.serverstransport=insecure@file
|
|
||||||
- traefik.http.routers.chatmail.rule=Host(`${MAIL_DOMAIN}`) || Host(`mta-sts.${MAIL_DOMAIN}`) || Host(`www.${MAIL_DOMAIN}`)
|
|
||||||
- traefik.http.routers.chatmail.tls=true
|
|
||||||
- traefik.http.routers.chatmail.tls.certresolver=letsEncrypt
|
|
||||||
|
|
||||||
traefik:
|
|
||||||
image: traefik:v3.3
|
|
||||||
container_name: traefik
|
|
||||||
restart: unless-stopped
|
|
||||||
logging:
|
|
||||||
driver: json-file
|
|
||||||
options:
|
|
||||||
max-size: "10m"
|
|
||||||
max-file: "3"
|
|
||||||
command:
|
|
||||||
- "--configFile=/config.yaml"
|
|
||||||
- "--certificatesresolvers.letsEncrypt.acme.email=${ACME_EMAIL}"
|
|
||||||
network_mode: host
|
|
||||||
depends_on:
|
|
||||||
traefik-init:
|
|
||||||
condition: service_completed_successfully
|
|
||||||
volumes:
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
||||||
- ./traefik/config.yaml:/config.yaml:ro
|
|
||||||
- traefik-data:/data
|
|
||||||
- ./traefik/dynamic-configs:/dynamic/conf:ro
|
|
||||||
|
|
||||||
traefik-init:
|
|
||||||
image: alpine:latest
|
|
||||||
restart: "no"
|
|
||||||
entrypoint: sh -c 'touch /data/acme.json && chmod 600 /data/acme.json'
|
|
||||||
volumes:
|
|
||||||
- traefik-data:/data
|
|
||||||
|
|
||||||
traefik-certs-dumper:
|
|
||||||
image: ldez/traefik-certs-dumper:v2.10.0
|
|
||||||
restart: unless-stopped
|
|
||||||
logging:
|
|
||||||
driver: json-file
|
|
||||||
options:
|
|
||||||
max-size: "10m"
|
|
||||||
max-file: "3"
|
|
||||||
depends_on:
|
|
||||||
- traefik
|
|
||||||
entrypoint: sh -c '
|
|
||||||
apk add openssl
|
|
||||||
&& while ! [ -e /data/acme.json ] || ! [ "$$(jq ".[] | .Certificates | length" /data/acme.json | jq -s "add")" != "0" ]; do
|
|
||||||
sleep 1
|
|
||||||
; done
|
|
||||||
&& traefik-certs-dumper file --version v3 --watch --domain-subdir=true
|
|
||||||
--source /data/acme.json --dest /certs --post-hook "sh /post-hook.sh"'
|
|
||||||
volumes:
|
|
||||||
- traefik-data:/data:ro
|
|
||||||
- traefik-certs:/certs
|
|
||||||
- ./traefik/post-hook.sh:/post-hook.sh:ro
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
chatmail-data:
|
|
||||||
chatmail-dkimkeys:
|
|
||||||
traefik-data:
|
|
||||||
traefik-certs:
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
MAIL_DOMAIN="chat.example.com"
|
|
||||||
ACME_EMAIL="admin@example.com"
|
|
||||||
|
|
||||||
# CMDEPLOY_STAGES - default: "configure,activate". Set to "install,configure,activate" to force full reinstall.
|
|
||||||
# CMDEPLOY_STAGES="configure,activate"
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Check TLS certificate changes and reload services
|
|
||||||
After=setup_chatmail.service
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=oneshot
|
|
||||||
ExecStart=/bin/bash /chatmail-certmon.sh
|
|
||||||
PassEnvironment=MAIL_DOMAIN PATH_TO_SSL
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# Check if TLS certificates have changed and reload services if so.
|
|
||||||
# Called by chatmail-certmon.timer (systemd timer, default every 60s).
|
|
||||||
set -eo pipefail
|
|
||||||
|
|
||||||
PATH_TO_SSL="${PATH_TO_SSL:-/var/lib/acme/live/${MAIL_DOMAIN}}"
|
|
||||||
HASH_FILE="/run/chatmail-certmon.hash"
|
|
||||||
|
|
||||||
if [ ! -d "$PATH_TO_SSL" ]; then
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
current_hash=$(find "$PATH_TO_SSL" -type f -exec sha1sum {} \; | sort | sha1sum | awk '{print $1}')
|
|
||||||
previous_hash=""
|
|
||||||
if [ -f "$HASH_FILE" ]; then
|
|
||||||
previous_hash=$(cat "$HASH_FILE")
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -n "$current_hash" ] && [ "$current_hash" != "$previous_hash" ]; then
|
|
||||||
echo "[INFO] Certificate hash changed, reloading nginx, dovecot and postfix."
|
|
||||||
echo "$current_hash" > "$HASH_FILE"
|
|
||||||
# On first run (no previous hash), don't reload — services may not be up yet
|
|
||||||
if [ -n "$previous_hash" ]; then
|
|
||||||
systemctl reload nginx.service
|
|
||||||
systemctl reload dovecot.service
|
|
||||||
systemctl reload postfix.service
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Periodically check TLS certificate changes
|
|
||||||
|
|
||||||
[Timer]
|
|
||||||
OnBootSec=120
|
|
||||||
OnUnitActiveSec=60
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=timers.target
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
set -eo pipefail
|
|
||||||
|
|
||||||
SETUP_CHATMAIL_SERVICE_PATH="${SETUP_CHATMAIL_SERVICE_PATH:-/lib/systemd/system/setup_chatmail.service}"
|
|
||||||
|
|
||||||
# Whitelist only the env vars needed by setup_chatmail_docker.sh.
|
|
||||||
# Forwarding all env vars (via printenv) would leak Docker internals,
|
|
||||||
# orchestrator secrets, and other unrelated variables into systemd.
|
|
||||||
env_vars="MAIL_DOMAIN CMDEPLOY_STAGES CHATMAIL_INI CHATMAIL_NOSYSCTL CHATMAIL_NOPORTCHECK CHATMAIL_NOACME PATH_TO_SSL PATH"
|
|
||||||
sed -i "s|<envs_list>|$env_vars|g" "$SETUP_CHATMAIL_SERVICE_PATH"
|
|
||||||
|
|
||||||
exec /lib/systemd/systemd "$@"
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Run container setup commands
|
|
||||||
After=multi-user.target
|
|
||||||
ConditionPathExists=/setup_chatmail_docker.sh
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=oneshot
|
|
||||||
ExecStart=/bin/bash /setup_chatmail_docker.sh
|
|
||||||
RemainAfterExit=true
|
|
||||||
WorkingDirectory=/opt/chatmail
|
|
||||||
PassEnvironment=<envs_list>
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
set -euo pipefail
|
|
||||||
export CHATMAIL_INI="${CHATMAIL_INI:-/etc/chatmail/chatmail.ini}"
|
|
||||||
|
|
||||||
CMDEPLOY=/opt/cmdeploy/bin/cmdeploy
|
|
||||||
|
|
||||||
if [ -z "$MAIL_DOMAIN" ]; then
|
|
||||||
echo "ERROR: Environment variable 'MAIL_DOMAIN' must be set!" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
### MAIN
|
|
||||||
|
|
||||||
if [ ! -f /etc/dkimkeys/opendkim.private ]; then
|
|
||||||
/usr/sbin/opendkim-genkey -D /etc/dkimkeys -d "$MAIL_DOMAIN" -s opendkim
|
|
||||||
fi
|
|
||||||
# Fix ownership for bind-mounted keys (host opendkim UID may differ from container)
|
|
||||||
chown -R opendkim:opendkim /etc/dkimkeys
|
|
||||||
|
|
||||||
# Journald: forward to console for docker logs
|
|
||||||
grep -q '^ForwardToConsole=yes' /etc/systemd/journald.conf \
|
|
||||||
|| echo "ForwardToConsole=yes" >> /etc/systemd/journald.conf
|
|
||||||
systemctl restart systemd-journald
|
|
||||||
|
|
||||||
# Create chatmail.ini (skips if file already exists, e.g. volume-mounted)
|
|
||||||
mkdir -p "$(dirname "$CHATMAIL_INI")"
|
|
||||||
if [ ! -f "$CHATMAIL_INI" ]; then
|
|
||||||
$CMDEPLOY init --config "$CHATMAIL_INI" "$MAIL_DOMAIN"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# --- Deploy fingerprint: skip cmdeploy run if nothing changed ---
|
|
||||||
# On restart with identical image+config, systemd already brings up all
|
|
||||||
# enabled services — the full cmdeploy run is redundant (~30s saved).
|
|
||||||
# The install stage runs at image build time (Dockerfile), so only
|
|
||||||
# configure+activate are needed here.
|
|
||||||
IMAGE_VERSION_FILE="/etc/chatmail-image-version"
|
|
||||||
FINGERPRINT_FILE="/etc/chatmail/.deploy-fingerprint"
|
|
||||||
image_ver="none"
|
|
||||||
[ -f "$IMAGE_VERSION_FILE" ] && image_ver=$(cat "$IMAGE_VERSION_FILE")
|
|
||||||
config_hash=$(sha256sum "$CHATMAIL_INI" | cut -c1-16)
|
|
||||||
current_fp="${image_ver}:${config_hash}"
|
|
||||||
|
|
||||||
# CMDEPLOY_STAGES non-empty in env = operator override → always run.
|
|
||||||
# Otherwise, if fingerprint matches the last successful deploy, skip.
|
|
||||||
if [ -z "${CMDEPLOY_STAGES:-}" ] \
|
|
||||||
&& [ -f "$FINGERPRINT_FILE" ] \
|
|
||||||
&& [ "$(cat "$FINGERPRINT_FILE")" = "$current_fp" ]; then
|
|
||||||
echo "[INFO] No changes detected ($current_fp), skipping deploy."
|
|
||||||
else
|
|
||||||
export CMDEPLOY_STAGES="${CMDEPLOY_STAGES:-configure,activate}"
|
|
||||||
$CMDEPLOY run --config "$CHATMAIL_INI" --ssh-host @local
|
|
||||||
echo "$current_fp" > "$FINGERPRINT_FILE"
|
|
||||||
fi
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
log:
|
|
||||||
level: INFO
|
|
||||||
|
|
||||||
entryPoints:
|
|
||||||
web:
|
|
||||||
address: ":80"
|
|
||||||
http:
|
|
||||||
redirections:
|
|
||||||
entryPoint:
|
|
||||||
to: websecure
|
|
||||||
permanent: true
|
|
||||||
websecure:
|
|
||||||
address: ":443"
|
|
||||||
|
|
||||||
providers:
|
|
||||||
docker:
|
|
||||||
endpoint: "unix:///var/run/docker.sock"
|
|
||||||
exposedByDefault: false
|
|
||||||
file:
|
|
||||||
directory: /dynamic/conf
|
|
||||||
watch: true
|
|
||||||
|
|
||||||
certificatesResolvers:
|
|
||||||
letsEncrypt:
|
|
||||||
acme:
|
|
||||||
storage: /data/acme.json
|
|
||||||
caServer: "https://acme-v02.api.letsencrypt.org/directory"
|
|
||||||
tlschallenge: true
|
|
||||||
httpChallenge:
|
|
||||||
entryPoint: web
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
http:
|
|
||||||
serversTransports:
|
|
||||||
insecure:
|
|
||||||
insecureSkipVerify: true
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# Post-hook for traefik-certs-dumper: create symlinks from Traefik's
|
|
||||||
# cert dump format to the paths chatmail expects (fullchain, privkey).
|
|
||||||
CERTS_DIR="${CERTS_DIR:-/certs}"
|
|
||||||
|
|
||||||
for dir in "$CERTS_DIR"/*/; do
|
|
||||||
[ -d "$dir" ] || continue
|
|
||||||
cd "$dir"
|
|
||||||
[ -f "certificate.crt" ] && ln -sf certificate.crt fullchain
|
|
||||||
[ -f "privatekey.key" ] && ln -sf privatekey.key privkey
|
|
||||||
cd - > /dev/null
|
|
||||||
done
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
MAIL_DOMAIN="chat.example.com"
|
|
||||||
|
|
||||||
# CMDEPLOY_STAGES - default: "configure,activate". Set to "install,configure,activate" to force full reinstall.
|
|
||||||
# CMDEPLOY_STAGES="configure,activate"
|
|
||||||
|
|
||||||
# Skip acmetool when using an external certificate manager (e.g. Traefik, Caddy).
|
|
||||||
# CHATMAIL_NOACME="True"
|
|
||||||
Reference in New Issue
Block a user