mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
7cb8f90340
* create a wwwdev.sh entry point for developing the web part * rename script * fix README * add a note * don't depend on deltachat python package * avoid bailing out on jinja2 errors, and provide file-url for instant clickability * in webdev mode make page auto-refresh every 3 seconds
455 lines
13 KiB
Python
455 lines
13 KiB
Python
"""
|
|
Chat Mail pyinfra deploy.
|
|
"""
|
|
import importlib.resources
|
|
import configparser
|
|
from pathlib import Path
|
|
|
|
from pyinfra import host
|
|
from pyinfra.operations import apt, files, server, systemd
|
|
from pyinfra.facts.files import File
|
|
from pyinfra.facts.systemd import SystemdEnabled
|
|
from .acmetool import deploy_acmetool
|
|
|
|
|
|
def _install_chatmaild() -> None:
|
|
chatmaild_filename = "chatmaild-0.1.tar.gz"
|
|
chatmaild_path = importlib.resources.files(__package__).joinpath(
|
|
f"../../../dist/{chatmaild_filename}"
|
|
)
|
|
remote_path = f"/tmp/{chatmaild_filename}"
|
|
if Path(str(chatmaild_path)).exists():
|
|
files.put(
|
|
name="Upload chatmaild source package",
|
|
src=chatmaild_path.open("rb"),
|
|
dest=remote_path,
|
|
)
|
|
|
|
apt.packages(
|
|
name="apt install python3-aiosmtpd python3-pip python3-venv",
|
|
packages=["python3-aiosmtpd", "python3-pip", "python3-venv"],
|
|
)
|
|
|
|
# --no-deps because aiosmtplib is installed with `apt`.
|
|
server.shell(
|
|
name="install chatmaild with pip",
|
|
commands=[f"pip install --break-system-packages {remote_path}"],
|
|
)
|
|
|
|
# disable legacy doveauth-dictproxy.service
|
|
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
|
systemd.service(
|
|
name="Disable legacy doveauth-dictproxy.service",
|
|
service="doveauth-dictproxy.service",
|
|
running=False,
|
|
enabled=False,
|
|
)
|
|
|
|
# install systemd units
|
|
|
|
for fn in (
|
|
"doveauth",
|
|
"filtermail",
|
|
):
|
|
files.put(
|
|
name=f"Upload {fn}.service",
|
|
src=importlib.resources.files("chatmaild")
|
|
.joinpath(f"{fn}.service")
|
|
.open("rb"),
|
|
dest=f"/etc/systemd/system/{fn}.service",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
)
|
|
systemd.service(
|
|
name=f"Setup {fn} service",
|
|
service=f"{fn}.service",
|
|
running=True,
|
|
enabled=True,
|
|
restarted=True,
|
|
daemon_reload=True,
|
|
)
|
|
|
|
|
|
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
|
"""Configures OpenDKIM"""
|
|
need_restart = False
|
|
|
|
main_config = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
|
dest="/etc/opendkim.conf",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
)
|
|
need_restart |= main_config.changed
|
|
|
|
files.directory(
|
|
name="Add opendkim directory to /etc",
|
|
path="/etc/opendkim",
|
|
user="opendkim",
|
|
group="opendkim",
|
|
mode="750",
|
|
present=True,
|
|
)
|
|
|
|
keytable = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("opendkim/KeyTable"),
|
|
dest="/etc/dkimkeys/KeyTable",
|
|
user="opendkim",
|
|
group="opendkim",
|
|
mode="644",
|
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
)
|
|
need_restart |= keytable.changed
|
|
|
|
signing_table = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("opendkim/SigningTable"),
|
|
dest="/etc/dkimkeys/SigningTable",
|
|
user="opendkim",
|
|
group="opendkim",
|
|
mode="644",
|
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
)
|
|
need_restart |= signing_table.changed
|
|
|
|
files.directory(
|
|
name="Add opendkim socket directory to /var/spool/postfix",
|
|
path="/var/spool/postfix/opendkim",
|
|
user="opendkim",
|
|
group="opendkim",
|
|
mode="750",
|
|
present=True,
|
|
)
|
|
|
|
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
|
server.shell(
|
|
name="Generate OpenDKIM domain keys",
|
|
commands=[
|
|
f"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
|
],
|
|
_sudo=True,
|
|
_sudo_user="opendkim",
|
|
)
|
|
|
|
return need_restart
|
|
|
|
|
|
def _install_mta_sts_daemon() -> bool:
|
|
need_restart = False
|
|
|
|
config = files.put(
|
|
name="upload postfix-mta-sts-resolver config",
|
|
src=importlib.resources.files(__package__).joinpath(
|
|
"postfix/mta-sts-daemon.yml"
|
|
),
|
|
dest="/etc/mta-sts-daemon.yml",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
)
|
|
need_restart |= config.changed
|
|
|
|
server.shell(
|
|
name="install postfix-mta-sts-resolver with pip",
|
|
commands=[
|
|
"python3 -m venv /usr/local/lib/postfix-mta-sts-resolver",
|
|
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
|
],
|
|
)
|
|
|
|
systemd_unit = files.put(
|
|
name="upload mta-sts-daemon systemd unit",
|
|
src=importlib.resources.files(__package__).joinpath(
|
|
"postfix/mta-sts-daemon.service"
|
|
),
|
|
dest="/etc/systemd/system/mta-sts-daemon.service",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
)
|
|
need_restart |= systemd_unit.changed
|
|
|
|
return need_restart
|
|
|
|
|
|
def _configure_postfix(domain: str, debug: bool = False) -> bool:
|
|
"""Configures Postfix SMTP server."""
|
|
need_restart = False
|
|
|
|
main_config = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("postfix/main.cf.j2"),
|
|
dest="/etc/postfix/main.cf",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
config={"domain_name": domain},
|
|
)
|
|
need_restart |= main_config.changed
|
|
|
|
master_config = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("postfix/master.cf.j2"),
|
|
dest="/etc/postfix/master.cf",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
debug=debug,
|
|
)
|
|
need_restart |= master_config.changed
|
|
|
|
return need_restart
|
|
|
|
|
|
def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
|
|
"""Configures Dovecot IMAP server."""
|
|
need_restart = False
|
|
|
|
main_config = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("dovecot/dovecot.conf.j2"),
|
|
dest="/etc/dovecot/dovecot.conf",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
config={"hostname": mail_server},
|
|
debug=debug,
|
|
)
|
|
need_restart |= main_config.changed
|
|
auth_config = files.put(
|
|
src=importlib.resources.files(__package__).joinpath("dovecot/auth.conf"),
|
|
dest="/etc/dovecot/auth.conf",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
)
|
|
need_restart |= auth_config.changed
|
|
|
|
files.put(
|
|
src=importlib.resources.files(__package__)
|
|
.joinpath("dovecot/expunge.cron")
|
|
.open("rb"),
|
|
dest="/etc/cron.d/expunge",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
)
|
|
|
|
# as per https://doc.dovecot.org/configuration_manual/os/
|
|
# it is recommended to set the following inotify limits
|
|
for name in ("max_user_instances", "max_user_watches"):
|
|
key = f"fs.inotify.{name}"
|
|
server.sysctl(
|
|
name=f"Change {key}",
|
|
key=key,
|
|
value=65535,
|
|
persist=True,
|
|
)
|
|
|
|
return need_restart
|
|
|
|
|
|
def _configure_nginx(domain: str, debug: bool = False) -> bool:
|
|
"""Configures nginx HTTP server."""
|
|
need_restart = False
|
|
|
|
main_config = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("nginx/nginx.conf.j2"),
|
|
dest="/etc/nginx/nginx.conf",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
config={"domain_name": domain},
|
|
)
|
|
need_restart |= main_config.changed
|
|
|
|
autoconfig = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("nginx/autoconfig.xml.j2"),
|
|
dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
config={"domain_name": domain},
|
|
)
|
|
need_restart |= autoconfig.changed
|
|
|
|
mta_sts_config = files.template(
|
|
src=importlib.resources.files(__package__).joinpath("nginx/mta-sts.txt.j2"),
|
|
dest="/var/www/html/.well-known/mta-sts.txt",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
config={"domain_name": domain},
|
|
)
|
|
need_restart |= mta_sts_config.changed
|
|
|
|
# install CGI newemail script
|
|
#
|
|
cgi_dir = "/usr/lib/cgi-bin"
|
|
files.directory(
|
|
name=f"Ensure {cgi_dir} exists",
|
|
path=cgi_dir,
|
|
user="root",
|
|
group="root",
|
|
)
|
|
|
|
files.put(
|
|
name="Upload cgi newemail.py script",
|
|
src=importlib.resources.files("chatmaild").joinpath("newemail.py").open("rb"),
|
|
dest=f"{cgi_dir}/newemail.py",
|
|
user="root",
|
|
group="root",
|
|
mode="755",
|
|
)
|
|
|
|
return need_restart
|
|
|
|
|
|
def get_ini_settings(mail_domain, inipath):
|
|
parser = configparser.ConfigParser()
|
|
parser.read(inipath)
|
|
settings = {key: value.strip() for (key, value) in parser["config"].items()}
|
|
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
|
for value in settings.values():
|
|
value = value.lower()
|
|
if "merlinux" in value or "schmieder" in value or "@testrun.org" in value:
|
|
raise ValueError(
|
|
f"please set your own privacy contacts/addresses in {inipath}"
|
|
)
|
|
settings["mail_domain"] = mail_domain
|
|
return settings
|
|
|
|
|
|
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
|
"""Deploy a chat-mail instance.
|
|
|
|
:param mail_domain: domain part of your future email addresses
|
|
:param mail_server: the DNS name under which your mail server is reachable
|
|
:param dkim_selector:
|
|
"""
|
|
from .www import build_webpages
|
|
|
|
apt.update(name="apt update", cache_time=24 * 3600)
|
|
server.group(name="Create vmail group", group="vmail", system=True)
|
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
|
|
|
server.group(name="Create opendkim group", group="opendkim", system=True)
|
|
server.user(
|
|
name="Add postfix user to opendkim group for socket access",
|
|
user="postfix",
|
|
groups=["opendkim"],
|
|
system=True,
|
|
)
|
|
|
|
# Deploy acmetool to have TLS certificates.
|
|
deploy_acmetool(nginx_hook=True, domains=[mail_server, f"mta-sts.{mail_server}"])
|
|
|
|
apt.packages(
|
|
name="Install Postfix",
|
|
packages="postfix",
|
|
)
|
|
|
|
apt.packages(
|
|
name="Install Dovecot",
|
|
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
|
)
|
|
|
|
apt.packages(
|
|
name="Install OpenDKIM",
|
|
packages=[
|
|
"opendkim",
|
|
"opendkim-tools",
|
|
],
|
|
)
|
|
|
|
apt.packages(
|
|
name="Install nginx",
|
|
packages=["nginx"],
|
|
)
|
|
|
|
apt.packages(
|
|
name="Install fcgiwrap",
|
|
packages=["fcgiwrap"],
|
|
)
|
|
|
|
pkg_root = importlib.resources.files(__package__)
|
|
chatmail_ini = pkg_root.joinpath("../../../chatmail.ini").resolve()
|
|
config = get_ini_settings(mail_domain, chatmail_ini)
|
|
www_path = pkg_root.joinpath("../../../www").resolve()
|
|
|
|
build_dir = www_path.joinpath("build")
|
|
src_dir = www_path.joinpath("src")
|
|
build_webpages(src_dir, build_dir, config)
|
|
files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
|
|
|
|
_install_chatmaild()
|
|
debug = False
|
|
dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
|
|
postfix_need_restart = _configure_postfix(mail_domain, debug=debug)
|
|
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
|
nginx_need_restart = _configure_nginx(mail_domain)
|
|
|
|
systemd.service(
|
|
name="Start and enable OpenDKIM",
|
|
service="opendkim.service",
|
|
running=True,
|
|
enabled=True,
|
|
restarted=opendkim_need_restart,
|
|
)
|
|
|
|
systemd.service(
|
|
name="Start and enable MTA-STS daemon",
|
|
service="mta-sts-daemon.service",
|
|
daemon_reload=True,
|
|
running=True,
|
|
enabled=True,
|
|
restarted=mta_sts_need_restart,
|
|
)
|
|
|
|
systemd.service(
|
|
name="Start and enable Postfix",
|
|
service="postfix.service",
|
|
running=True,
|
|
enabled=True,
|
|
restarted=postfix_need_restart,
|
|
)
|
|
|
|
systemd.service(
|
|
name="Start and enable Dovecot",
|
|
service="dovecot.service",
|
|
running=True,
|
|
enabled=True,
|
|
restarted=dovecot_need_restart,
|
|
)
|
|
|
|
systemd.service(
|
|
name="Start and enable nginx",
|
|
service="nginx.service",
|
|
running=True,
|
|
enabled=True,
|
|
restarted=nginx_need_restart,
|
|
)
|
|
|
|
# This file is used by auth proxy.
|
|
# https://wiki.debian.org/EtcMailName
|
|
server.shell(
|
|
name="Setup /etc/mailname",
|
|
commands=[f"echo {mail_domain} >/etc/mailname; chmod 644 /etc/mailname"],
|
|
)
|
|
|
|
journald_conf = files.put(
|
|
name="Configure journald",
|
|
src=importlib.resources.files(__package__).joinpath("journald.conf"),
|
|
dest="/etc/systemd/journald.conf",
|
|
user="root",
|
|
group="root",
|
|
mode="644",
|
|
)
|
|
systemd.service(
|
|
name="Start and enable journald",
|
|
service="systemd-journald.service",
|
|
running=True,
|
|
enabled=True,
|
|
restarted=journald_conf,
|
|
)
|