diff --git a/.gitignore b/.gitignore index 6e1054d0..c6260e93 100644 --- a/.gitignore +++ b/.gitignore @@ -164,3 +164,9 @@ cython_debug/ #.idea/ chatmail.zone + +# docker +/data/ +/custom/ +docker-compose.yaml +.env diff --git a/CHANGELOG.md b/CHANGELOG.md index e754da0d..4669c506 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,35 @@ ## untagged +- 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 markdown tabs blocks for rendering multilingual pages. Add russian language support to `index.md`, `privacy.md`, and `info.md`. + ([#614](https://github.com/chatmail/relay/pull/614)) + +- Fix [Issue 604](https://github.com/chatmail/relay/issues/604), now the `--ssh_host` argument of the `cmdeploy run` command works correctly and does not depend on `config.mail_domain`. + ([#614](https://github.com/chatmail/relay/pull/614)) + +- Add `--skip-dns-check` argument to `cmdeploy run` command, which disables DNS record checking before installation. + ([#614](https://github.com/chatmail/relay/pull/614)) + +- Add `--force` argument to `cmdeploy init` command, which recreates the `config.ini` file. + ([#614](https://github.com/chatmail/relay/pull/614)) + +- Add startup for `fcgiwrap.service` because sometimes it did not start automatically. + ([#614](https://github.com/chatmail/relay/pull/614)) + +- Add extended check when installing `unbound.service`. Now, if it is not shown who exactly is occupying port 53, but `unbound.service` is running, it is considered that the port is occupied by `unbound.service`. + ([#614](https://github.com/chatmail/relay/pull/614)) + +- Add configuration parameters + ([#614](https://github.com/chatmail/relay/pull/614)): + - `is_development_instance` - Indicates that this instance is installed as a temporary/test one (default: `True`) + - `use_foreign_cert_manager` - Use a third-party certificate manager instead of acmetool (default: `False`) + - `acme_email` - Email address used by acmetool to obtain Let's Encrypt certificates (default: empty) + - `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`) + - Expire push notification tokens after 90 days ([#583](https://github.com/chatmail/relay/pull/583)) diff --git a/README.md b/README.md index 7ba08fdb..5e1d579b 100644 --- a/README.md +++ b/README.md @@ -74,22 +74,23 @@ Please substitute it with your own domain. ``` git clone https://github.com/chatmail/relay cd relay - scripts/initenv.sh ``` -3. On your local PC, create chatmail configuration file `chatmail.ini`: +### Manual installation +1. On your local PC, create chatmail configuration file `chatmail.ini`: ``` + scripts/initenv.sh scripts/cmdeploy init chat.example.org # <-- use your domain ``` -4. Verify that SSH root login to your remote server works: +2. Verify that SSH root login to your remote server works: ``` ssh root@chat.example.org # <-- use your domain ``` -5. From your local PC, deploy the remote chatmail relay server: +3. From your local PC, deploy the remote chatmail relay server: ``` scripts/cmdeploy run @@ -99,6 +100,9 @@ Please substitute it with your own domain. which you should configure at your DNS provider (it can take some time until they are public). +### Docker installation +Installation using docker compose is presented [here](./docs/DOCKER_INSTALLATION_EN.md) + ### Other helpful commands To check the status of your remotely running chatmail service: diff --git a/chatmaild/src/chatmaild/config.py b/chatmaild/src/chatmaild/config.py index 0cac3ea4..ab9d77ac 100644 --- a/chatmaild/src/chatmaild/config.py +++ b/chatmaild/src/chatmaild/config.py @@ -33,6 +33,7 @@ def __init__(self, inipath, params): self.password_min_length = int(params["password_min_length"]) self.passthrough_senders = params["passthrough_senders"].split() self.passthrough_recipients = params["passthrough_recipients"].split() + self.is_development_instance = params.get("is_development_instance", "true").lower() == "true" self.filtermail_smtp_port = int(params["filtermail_smtp_port"]) self.filtermail_smtp_port_incoming = int( params["filtermail_smtp_port_incoming"] @@ -43,6 +44,12 @@ def __init__(self, inipath, params): ) self.mtail_address = params.get("mtail_address") self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true" + self.use_foreign_cert_manager = params.get("use_foreign_cert_manager", "false").lower() == "true" + self.acme_email = params["acme_email"] + self.change_kernel_settings = params.get("change_kernel_settings", "true").lower() == "true" + self.fs_inotify_max_user_instances_and_watchers = int( + params["fs_inotify_max_user_instances_and_watchers"] + ) self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true" if "iroh_relay" not in params: self.iroh_relay = "https://" + params["mail_domain"] diff --git a/chatmaild/src/chatmaild/ini/chatmail.ini.f b/chatmaild/src/chatmaild/ini/chatmail.ini.f index a99fb508..13926745 100644 --- a/chatmaild/src/chatmaild/ini/chatmail.ini.f +++ b/chatmaild/src/chatmaild/ini/chatmail.ini.f @@ -49,6 +49,9 @@ # Deployment Details # +# if set to "True" on main page will be showed dev banner +is_development_instance = True + # SMTP outgoing filtermail and reinjection filtermail_smtp_port = 10080 postfix_reinject_port = 10025 @@ -60,6 +63,22 @@ # if set to "True" IPv6 is disabled disable_ipv6 = False +# if you set "True", acmetool will not be installed and you will have to manage certificates yourself. +use_foreign_cert_manager = False + +# Your email adress, which will be used in acmetool to manage Let's Encrypt SSL certificates. Required if `use_foreign_cert_manager` param set as "False". +acme_email = + +# +# Kernel settings +# + +# if you set "True", the kernel settings will be configured according to the values below +change_kernel_settings = True + +# change fs.inotify.max_user_instances and fs.inotify.max_user_watches kernel settings +fs_inotify_max_user_instances_and_watchers = 65535 + # Defaults to https://iroh.{{mail_domain}} and running `iroh-relay` on the chatmail # service. # If you set it to anything else, the service will be disabled diff --git a/cmdeploy/pyproject.toml b/cmdeploy/pyproject.toml index 9f2257b5..adf53cf9 100644 --- a/cmdeploy/pyproject.toml +++ b/cmdeploy/pyproject.toml @@ -20,6 +20,7 @@ dependencies = [ "pytest-xdist", "execnet", "imap_tools", + "pymdown-extensions", ] [project.scripts] diff --git a/cmdeploy/src/cmdeploy/__init__.py b/cmdeploy/src/cmdeploy/__init__.py index cb894750..58491fb3 100644 --- a/cmdeploy/src/cmdeploy/__init__.py +++ b/cmdeploy/src/cmdeploy/__init__.py @@ -15,7 +15,7 @@ from pyinfra.api import FactBase from pyinfra.facts.files import File from pyinfra.facts.server import Sysctl -from pyinfra.facts.systemd import SystemdEnabled +from pyinfra.facts.systemd import SystemdEnabled, SystemdStatus from pyinfra.operations import apt, files, pip, server, systemd from .acmetool import deploy_acmetool @@ -395,20 +395,21 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool: config=config, ) - # as per https://doc.dovecot.org/configuration_manual/os/ + # as per https://doc.dovecot.org/2.3/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}" - if host.get_fact(Sysctl)[key] > 65535: - # Skip updating limits if already sufficient - # (enables running in incus containers where sysctl readonly) - continue - server.sysctl( - name=f"Change {key}", - key=key, - value=65535, - persist=True, - ) + if config.change_kernel_settings: + for name in ("max_user_instances", "max_user_watches"): + key = f"fs.inotify.{name}" + if host.get_fact(Sysctl)[key] == config.fs_inotify_max_user_instances_and_watchers: + # Skip updating limits if already sufficient + # (enables running in incus containers where sysctl readonly) + continue + server.sysctl( + name=f"Change {key}", + key=key, + value=config.fs_inotify_max_user_instances_and_watchers, + persist=True, + ) timezone_env = files.line( name="Set TZ environment variable", @@ -676,8 +677,10 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None: from cmdeploy.cmdeploy import Out process_on_53 = host.get_fact(Port, port=53) + if host.get_fact(SystemdStatus, services="unbound").get("unbound.service"): + process_on_53 = "unbound" if process_on_53 not in (None, "unbound"): - Out().red(f"Can't install unbound: port 53 is occupied by: {process_on_53}") + Out().red(f"Can't install unbound: port 53 is occupied by: {process_on_53}") exit(1) apt.packages( name="Install unbound", @@ -700,10 +703,12 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None: deploy_iroh_relay(config) # Deploy acmetool to have TLS certificates. - tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"] - deploy_acmetool( - domains=tls_domains, - ) + if not config.use_foreign_cert_manager: + tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"] + deploy_acmetool( + email = config.acme_email, + domains=tls_domains, + ) apt.packages( # required for setfacl for echobot @@ -783,6 +788,13 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None: enabled=True, restarted=nginx_need_restart, ) + + systemd.service( + name="Start and enable fcgiwrap", + service="fcgiwrap.service", + running=True, + enabled=True, + ) # This file is used by auth proxy. # https://wiki.debian.org/EtcMailName diff --git a/cmdeploy/src/cmdeploy/cmdeploy.py b/cmdeploy/src/cmdeploy/cmdeploy.py index 59187734..78b6ad02 100644 --- a/cmdeploy/src/cmdeploy/cmdeploy.py +++ b/cmdeploy/src/cmdeploy/cmdeploy.py @@ -32,17 +32,28 @@ def init_cmd_options(parser): action="store", help="fully qualified DNS domain name for your chatmail instance", ) + parser.add_argument( + "--force", + dest="recreate_ini", + action="store_true", + help="force reacreate ini file", + ) def init_cmd(args, out): """Initialize chatmail config file.""" mail_domain = args.chatmail_domain + inipath = args.inipath if args.inipath.exists(): - print(f"Path exists, not modifying: {args.inipath}") - return 1 - else: - write_initial_config(args.inipath, mail_domain, overrides={}) - out.green(f"created config file for {mail_domain} in {args.inipath}") + if not args.recreate_ini: + out.green(f"[WARNING] Path exists, not modifying: {inipath}") + return 0 + else: + out.yellow(f"[WARNING] Force argument was provided, deleting config file: {inipath}") + inipath.unlink() + + write_initial_config(inipath, mail_domain, overrides={}) + out.green(f"created config file for {mail_domain} in {inipath}") def run_cmd_options(parser): @@ -63,6 +74,12 @@ def run_cmd_options(parser): dest="ssh_host", help="specify an SSH host to deploy to; uses mail_domain from chatmail.ini by default", ) + parser.add_argument( + "--skip-dns-check", + dest="dns_check_disabled", + action="store_true", + help="disable checks nslookup for dns", + ) def run_cmd(args, out): @@ -70,9 +87,10 @@ def run_cmd(args, out): sshexec = args.get_sshexec() require_iroh = args.config.enable_iroh_relay - remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain) - if not dns.check_initial_remote_data(remote_data, print=out.red): - return 1 + if not args.dns_check_disabled: + remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain) + if not dns.check_initial_remote_data(remote_data, print=out.red): + return 1 env = os.environ.copy() env["CHATMAIL_INI"] = args.inipath @@ -89,6 +107,9 @@ def run_cmd(args, out): try: retcode = out.check_call(cmd, env=env) if retcode == 0: + server_deployed_message = f"Chatmail server started: https://{args.config.mail_domain}/" + delimiter_line = "=" * len(server_deployed_message) + out.green(f"{delimiter_line}\n{server_deployed_message}\n{delimiter_line}") out.green("Deploy completed, call `cmdeploy dns` next.") elif not remote_data["acme_account_url"]: out.red("Deploy completed but letsencrypt not configured") @@ -251,8 +272,17 @@ def red(self, msg, file=sys.stderr): def green(self, msg, file=sys.stderr): print(colored(msg, "green"), file=file) - def __call__(self, msg, red=False, green=False, file=sys.stdout): - color = "red" if red else ("green" if green else None) + def yellow(self, msg, file=sys.stderr): + print(colored(msg, "yellow"), file=file) + + def __call__(self, msg, red=False, green=False, yellow=False, file=sys.stdout): + color = None + if red: + color = "red" + elif green: + color = "green" + elif yellow: + color = "yellow" print(colored(msg, color), file=file) def check_call(self, arg, env=None, quiet=False): @@ -331,8 +361,9 @@ def main(args=None): return parser.parse_args(["-h"]) def get_sshexec(): - print(f"[ssh] login to {args.config.mail_domain}") - return SSHExec(args.config.mail_domain, verbose=args.verbose) + host = args.ssh_host if hasattr(args, "ssh_host") and args.ssh_host else args.config.mail_domain + print(f"[ssh] login to {host}") + return SSHExec(host, verbose=args.verbose) args.get_sshexec = get_sshexec diff --git a/cmdeploy/src/cmdeploy/www.py b/cmdeploy/src/cmdeploy/www.py index 9dd404ba..2d54d9ea 100644 --- a/cmdeploy/src/cmdeploy/www.py +++ b/cmdeploy/src/cmdeploy/www.py @@ -25,7 +25,8 @@ def prepare_template(source): assert source.exists(), source render_vars = {} render_vars["pagename"] = "home" if source.stem == "index" else source.stem - render_vars["markdown_html"] = markdown.markdown(source.read_text()) + # tabs usage for multiple languages https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/tab/ + render_vars["markdown_html"] = markdown.markdown(source.read_text(), extensions=['pymdownx.blocks.tab']) page_layout = source.with_name("page-layout.html").read_text() return render_vars, page_layout diff --git a/docker/chatmail_server.dockerfile b/docker/chatmail_server.dockerfile new file mode 100644 index 00000000..72c4a042 --- /dev/null +++ b/docker/chatmail_server.dockerfile @@ -0,0 +1,102 @@ +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=Europe/London \ + 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 \ + openssh-client \ + openssh-server \ + 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 \ + && for pkg in core imapd lmtpd; do \ + case "$pkg" in \ + core) sha256="43f593332e22ac7701c62d58b575d2ca409e0f64857a2803be886c22860f5587" ;; \ + imapd) sha256="8d8dc6fc00bbb6cdb25d345844f41ce2f1c53f764b79a838eb2a03103eebfa86" ;; \ + lmtpd) sha256="2f69ba5e35363de50962d42cccbfe4ed8495265044e244007d7ccddad77513ab" ;; \ + esac; \ + url="https://download.delta.chat/dovecot/dovecot-${pkg}_2.3.21%2Bdfsg1-3_amd64.deb"; \ + file="/tmp/$(basename "$url")"; \ + curl -fsSL "$url" -o "$file"; \ + echo "$sha256 $file" | sha256sum -c -; \ + apt-get install -y "$file"; \ + rm -f "$file"; \ + done \ + && rm -rf /var/lib/apt/lists/* + +RUN systemctl enable \ + ssh \ + fcgiwrap + +RUN sed -i 's/^#PasswordAuthentication .*/PasswordAuthentication no/' /etc/ssh/sshd_config && \ + sed -i 's/^#PermitRootLogin .*/PermitRootLogin prohibit-password/' /etc/ssh/sshd_config && \ + ssh-keygen -P "" -t rsa -b 2048 -f /root/.ssh/id_rsa && \ + mkdir -p /root/.ssh && \ + cat /root/.ssh/id_rsa.pub >> /root/.ssh/authorized_keys && \ + SSH_USER_CONFIG="/root/.ssh/config" && \ + echo "Host localhost" > "$SSH_USER_CONFIG" && \ + echo " HostName localhost" >> "$SSH_USER_CONFIG" && \ + echo " User root" >> "$SSH_USER_CONFIG" && \ + echo " StrictHostKeyChecking no" >> "$SSH_USER_CONFIG" && \ + echo " UserKnownHostsFile /dev/null" >> "$SSH_USER_CONFIG" + ## TODO: deny access for all insteed root form 127.0.0.1 https://unix.stackexchange.com/a/406264 + +WORKDIR /opt/chatmail + +ARG SETUP_CHATMAIL_SERVICE_PATH=/lib/systemd/system/setup_chatmail.service +COPY ./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" + +COPY --chmod=555 ./files/setup_chatmail_docker.sh /setup_chatmail_docker.sh +COPY --chmod=555 ./files/update_ini.sh /update_ini.sh +COPY --chmod=555 ./files/entrypoint.sh /entrypoint.sh + +## TODO: add git clone. +## Problem: how correct save only required files inside container.... +# RUN git clone https://github.com/chatmail/relay.git -b master . \ +# && ./scripts/initenv.sh + +# EXPOSE 443 25 587 143 993 + +VOLUME ["/sys/fs/cgroup", "/home"] + +STOPSIGNAL SIGRTMIN+3 + +ENTRYPOINT ["/entrypoint.sh"] + +CMD [ "--default-standard-output=journal+console", \ + "--default-standard-error=journal+console" ] + +## TODO: Add installation and configuration of chatmaild inside the Dockerfile. +## This is required to ensure repeatable deployment. +## In the current MVP, the chatmaild server is updated on every container restart. diff --git a/docker/docker-compose-default.yaml b/docker/docker-compose-default.yaml new file mode 100644 index 00000000..61e7765f --- /dev/null +++ b/docker/docker-compose-default.yaml @@ -0,0 +1,58 @@ +services: + chatmail: + build: + context: ./docker + dockerfile: chatmail_server.dockerfile + tags: + - chatmail-relay:latest + image: chatmail-relay:latest + restart: unless-stopped + container_name: chatmail + cgroup: host # required for systemd + 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: + CHANGE_KERNEL_SETTINGS: "False" + ACME_EMAIL: + + MAX_MESSAGE_SIZE: "50M" + # DEBUG_COMMANDS_ENABLED: "true" + # FORCE_REINIT_INI_FILE: "true" + # USE_FOREIGN_CERT_MANAGER: "True" + # ENABLE_CERTS_MONITORING: "true" + # CERTS_MONITORING_TIMEOUT: 10 + # IS_DEVELOPMENT_INSTANCE: "True" + ports: + - "25:25" + - "587:587" + - "143:143" + - "993:993" + - "443:443" + volumes: + ## system + - /sys/fs/cgroup:/sys/fs/cgroup:rw # required for systemd + - ./:/opt/chatmail + - ./data/acme:/var/lib/acme + + ## data + - ./data/chatmail:/home + - ./data/chatmail-dkimkeys:/etc/dkimkeys + - ./data/chatmail-echobot:/run/echobot + - ./data/chatmail-acme:/var/lib/acme + + ## custom resources + # - ./custom/www/src/index.md:/opt/chatmail/www/src/index.md + + ## debug + # - ./docker/files/setup_chatmail_docker.sh:/setup_chatmail_docker.sh + # - ./docker/files/entrypoint.sh:/entrypoint.sh + # - ./docker/files/update_ini.sh:/update_ini.sh diff --git a/docker/docker-compose-traefik.yaml b/docker/docker-compose-traefik.yaml new file mode 100644 index 00000000..1601578f --- /dev/null +++ b/docker/docker-compose-traefik.yaml @@ -0,0 +1,115 @@ +services: + chatmail: + build: + context: ./docker + dockerfile: chatmail_server.dockerfile + tags: + - chatmail-relay:latest + image: chatmail-relay:latest + restart: unless-stopped + container_name: chatmail + depends_on: + - traefik-certs-dumper + cgroup: host # required for systemd + 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: #all possible variables you can check inside README and /chatmaild/src/chatmaild/ini/chatmail.ini.f + MAIL_DOMAIN: $MAIL_DOMAIN + # MAX_MESSAGE_SIZE: "50M" + # DEBUG_COMMANDS_ENABLED: "true" + # FORCE_REINIT_INI_FILE: "true" + USE_FOREIGN_CERT_MANAGER: "true" + CHANGE_KERNEL_SETTINGS: "false" + PATH_TO_SSL_CONTAINER: $PATH_TO_SSL_CONTAINER + ENABLE_CERTS_MONITORING: "true" + # CERTS_MONITORING_TIMEOUT: 60 + # IS_DEVELOPMENT_INSTANCE: "true" + ports: + - "25:25" + - "587:587" + - "143:143" + - "993:993" + volumes: + ## system + - /sys/fs/cgroup:/sys/fs/cgroup:rw # required for systemd + - ./:/opt/chatmail + - ${PATH_TO_SSL_HOST}:${PATH_TO_SSL_CONTAINER}:ro + + ## data + - ./data/chatmail:/home + # - ./data/chatmail-dkimkeys:/etc/dkimkeys + # - ./data/chatmail-echobot:/run/echobot + # - ./data/chatmail-acme:/var/lib/acme + + ## custom resources + # - ./custom/www/src/index.md:/opt/chatmail/www/src/index.md + + ## debug + # - ./docker/files/setup_chatmail_docker.sh:/setup_chatmail_docker.sh + # - ./docker/files/entrypoint.sh:/entrypoint.sh + # - ./docker/files/update_ini.sh:/update_ini.sh + + labels: + - traefik.enable=true + - traefik.http.services.chatmail-relay.loadbalancer.server.scheme=https + - traefik.http.services.chatmail-relay.loadbalancer.server.port=443 + - traefik.http.services.chatmail-relay.loadbalancer.serverstransport=insecure@file + - traefik.http.routers.chatmail-relay.rule=Host(`${MAIL_DOMAIN}`) || Host(`mta-sts.${MAIL_DOMAIN}`) || Host(`www.${MAIL_DOMAIN}`) + - traefik.http.routers.chatmail-relay.service=chatmail-relay + - traefik.http.routers.chatmail-relay.tls=true + - traefik.http.routers.chatmail-relay.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 + # ports: + # - "80:80" + # - "443:443" + volumes: + - /var/run/docker.sock:/var/run/docker.sock + - ./data/traefik/config.yaml:/config.yaml + - ./data/traefik/acme.json:/acme.json + - ./data/traefik/dynamic-configs:/dynamic/conf + + network_mode: host + + 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 /data/letsencrypt/certs --post-hook "sh /post-hook.sh"' + environment: + CERTS_DIR: /data/letsencrypt/certs + volumes: + - ./data/traefik/letsencrypt:/data/letsencrypt + - ./data/traefik/acme.json:/data/acme.json + - ./data/traefik/post-hook.sh:/post-hook.sh diff --git a/docker/example.env b/docker/example.env new file mode 100644 index 00000000..bb63a055 --- /dev/null +++ b/docker/example.env @@ -0,0 +1,4 @@ +MAIL_DOMAIN="chat.example.com" + +PATH_TO_SSL_HOST="/opt/traefik/data/letsencrypt/certs/${MAIL_DOMAIN}" +PATH_TO_SSL_CONTAINER="/var/lib/acme/live/${MAIL_DOMAIN}" diff --git a/docker/files/entrypoint.sh b/docker/files/entrypoint.sh new file mode 100755 index 00000000..b704c2e3 --- /dev/null +++ b/docker/files/entrypoint.sh @@ -0,0 +1,20 @@ +#!/bin/bash +set -eo pipefail + +if [ "${USE_FOREIGN_CERT_MANAGER,,}" == "true" ]; then + if [ ! -f "$PATH_TO_SSL_CONTAINER/fullchain" ]; then + echo "Error: file '$PATH_TO_SSL_CONTAINER/fullchain' does not exist. Exiting..." > /dev/stderr + exit 1 + fi + if [ ! -f "$PATH_TO_SSL_CONTAINER/privkey" ]; then + echo "Error: file '$PATH_TO_SSL_CONTAINER/privkey' does not exist. Exiting..." > /dev/stderr + exit 1 + fi +fi + +SETUP_CHATMAIL_SERVICE_PATH="${SETUP_CHATMAIL_SERVICE_PATH:-/lib/systemd/system/setup_chatmail.service}" + +env_vars=$(printenv | cut -d= -f1 | xargs) +sed -i "s||$env_vars|g" $SETUP_CHATMAIL_SERVICE_PATH + +exec /lib/systemd/systemd $@ diff --git a/docker/files/setup_chatmail.service b/docker/files/setup_chatmail.service new file mode 100644 index 00000000..2a0a48bc --- /dev/null +++ b/docker/files/setup_chatmail.service @@ -0,0 +1,14 @@ +[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= + +[Install] +WantedBy=multi-user.target diff --git a/docker/files/setup_chatmail_docker.sh b/docker/files/setup_chatmail_docker.sh new file mode 100755 index 00000000..7e101791 --- /dev/null +++ b/docker/files/setup_chatmail_docker.sh @@ -0,0 +1,74 @@ +#!/bin/bash + +set -eo pipefail +export INI_FILE="${INI_FILE:-chatmail.ini}" +export ENABLE_CERTS_MONITORING="${ENABLE_CERTS_MONITORING:-true}" +export CERTS_MONITORING_TIMEOUT="${CERTS_MONITORING_TIMEOUT:-60}" +export PATH_TO_SSL_CONTAINER="${PATH_TO_SSL_CONTAINER:-/var/lib/acme/live/${MAIL_DOMAIN}}" +export CHANGE_KERNEL_SETTINGS=${CHANGE_KERNEL_SETTINGS:-"False"} + +if [ -z "$MAIL_DOMAIN" ]; then + echo "ERROR: Environment variable 'MAIL_DOMAIN' must be set!" >&2 + exit 1 +fi + +debug_commands() { + echo "Executing debug commands" + # git config --global --add safe.directory /opt/chatmail + # ./scripts/initenv.sh +} + +calculate_hash() { + find "$PATH_TO_SSL_CONTAINER" -type f -exec sha1sum {} \; | sort | sha1sum | awk '{print $1}' +} + +monitor_certificates() { + if [ "$ENABLE_CERTS_MONITORING" != "true" ]; then + echo "Certs monitoring disabled." + exit 0 + fi + + current_hash=$(calculate_hash) + previous_hash=$current_hash + + while true; do + current_hash=$(calculate_hash) + if [[ "$current_hash" != "$previous_hash" ]]; then + # TODO: add an option to restart at a specific time interval + echo "[INFO] Certificate's folder hash was changed, restarting nginx, dovecot and postfix services." + systemctl restart nginx.service + systemctl reload dovecot.service + systemctl reload postfix.service + previous_hash=$current_hash + fi + sleep $CERTS_MONITORING_TIMEOUT + done +} + +### MAIN + +if [ "$DEBUG_COMMANDS_ENABLED" == "true" ]; then + debug_commands +fi + +if [ "$FORCE_REINIT_INI_FILE" == "true" ]; then + INI_CMD_ARGS=--force +fi + +/usr/sbin/opendkim-genkey -D /etc/dkimkeys -d $MAIL_DOMAIN -s opendkim +chown opendkim:opendkim /etc/dkimkeys/opendkim.private +chown opendkim:opendkim /etc/dkimkeys/opendkim.txt + +# TODO: Move to debug_commands after git clone is moved to dockerfile. +git config --global --add safe.directory /opt/chatmail +./scripts/initenv.sh + +./scripts/cmdeploy init --config "${INI_FILE}" $INI_CMD_ARGS $MAIL_DOMAIN +bash /update_ini.sh + +./scripts/cmdeploy run --ssh-host localhost --skip-dns-check + +echo "ForwardToConsole=yes" >> /etc/systemd/journald.conf +systemctl restart systemd-journald + +monitor_certificates & diff --git a/docker/files/update_ini.sh b/docker/files/update_ini.sh new file mode 100644 index 00000000..c5d65661 --- /dev/null +++ b/docker/files/update_ini.sh @@ -0,0 +1,79 @@ +#!/bin/bash +set -eo pipefail + +INI_FILE="${INI_FILE:-chatmail.ini}" + +if [ ! -f "$INI_FILE" ]; then + echo "Error: file $INI_FILE not found." >&2 + exit 1 +fi + +TMP_FILE="$(mktemp)" + +convert_to_bytes() { + local value="$1" + if [[ "$value" =~ ^([0-9]+)([KkMmGgTt])$ ]]; then + local num="${BASH_REMATCH[1]}" + local unit="${BASH_REMATCH[2]}" + case "$unit" in + [Kk]) echo $((num * 1024)) ;; + [Mm]) echo $((num * 1024 * 1024)) ;; + [Gg]) echo $((num * 1024 * 1024 * 1024)) ;; + [Tt]) echo $((num * 1024 * 1024 * 1024 * 1024)) ;; + esac + elif [[ "$value" =~ ^[0-9]+$ ]]; then + echo "$value" + else + echo "Error: incorrect size format: $value." >&2 + return 1 + fi +} + +process_specific_params() { + local key=$1 + local value=$2 + local destination_file=$3 + + if [[ "$key" == "max_message_size" ]]; then + converted=$(convert_to_bytes "$value") || exit 1 + if grep -q -e "## .* = .* bytes" "$destination_file"; then + sed "s|## .* = .* bytes|## $value = $converted bytes|g" "$destination_file"; + else + echo "## $value = $converted bytes" >> "$destination_file" + fi + echo "$key = $converted" >> "$destination_file" + else + echo "$key = $value" >> "$destination_file" + fi +} + +while IFS= read -r line; do + if [[ "$line" =~ ^[[:space:]]*#.* || "$line" =~ ^[[:space:]]*$ ]]; then + echo "$line" >> "$TMP_FILE" + continue + fi + + if [[ "$line" =~ ^([a-z0-9_]+)[[:space:]]*=[[:space:]]*(.*)$ ]]; then + key="${BASH_REMATCH[1]}" + current_value="${BASH_REMATCH[2]}" + env_var_name=$(echo "$key" | tr 'a-z' 'A-Z') + env_value="${!env_var_name}" + + if [[ -n "$env_value" ]]; then + process_specific_params "$key" "$env_value" "$TMP_FILE" + else + echo "$line" >> "$TMP_FILE" + fi + else + echo "$line" >> "$TMP_FILE" + fi +done < "$INI_FILE" + +PERMS=$(stat -c %a "$INI_FILE") +OWNER=$(stat -c %u "$INI_FILE") +GROUP=$(stat -c %g "$INI_FILE") + +chmod "$PERMS" "$TMP_FILE" +chown "$OWNER":"$GROUP" "$TMP_FILE" + +mv "$TMP_FILE" "$INI_FILE" diff --git a/docs/DOCKER_INSTALLATION_EN.md b/docs/DOCKER_INSTALLATION_EN.md new file mode 100644 index 00000000..c6c44bb8 --- /dev/null +++ b/docs/DOCKER_INSTALLATION_EN.md @@ -0,0 +1,310 @@ +# Known issues and limitations + +- Installation using acmetool (`docker-compose-default.yaml`) may NOT work. In this case, use installation via traefik (`docker-compose-traefik.yaml`). Personally, during my tests, I encountered the error `could not install DNS challenge, no hooks succeeded;`, which I was unable to fix. +- Chatmail will be reinstalled every time the container is started (longer the first time, faster on subsequent starts). This is how the original installer works because it wasn’t designed for Docker. At the end of the documentation, there’s a [proposed solution](#locking-the-chatmail-version). +- Requires cgroups v2 configured in the system. Operation with cgroups v1 has not been tested. +- Yes, of course, using systemd inside a container is a hack, and it would be better to split it into several services, but since this is an MVP, it turned out to be easier to do it this way initially than to rewrite the entire deployment system. +- The Docker image is only suitable for amd64. If you need to run it on a different architecture, try modifying the Dockerfile (specifically the part responsible for installing dovecot). + +# Docker installation +This section provides instructions for installing Chatmail using docker-compose. + +## 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.com. 3600 IN A 198.51.100.5 + chat.example.com. 3600 IN AAAA 2001:db8::5 + www.chat.example.com. 3600 IN CNAME chat.example.com. + mta-sts.chat.example.com. 3600 IN CNAME chat.example.com. + ``` + +2. clone the repository on your server. + + ```shell + git clone https://github.com/chatmail/relay + cd relay + ``` + +## Installation +When installing via Docker, there are several options: + +- Use the built-in nginx and acmetool in Chatmail container to host the chat and manage certificates. +- Use third-party tools for certificate management. + +For the third-party certificate manager example, traefik will be used, but you can use whatever is more convenient for you. + +1. Copy the file `./docker/docker-compose-default.yaml` or `./docker/docker-compose-traefik.yaml` and rename it to `docker-compose.yaml`. This is necessary because `docker-compose.yaml` is in `.gitignore` and won’t cause conflicts when updating the git repository. + +```shell +cp ./docker/docker-compose-default.yaml docker-compose.yaml +## or +# cp ./docker/docker-compose-traefik.yaml docker-compose.yaml +``` + +2. Copy `./docker/example.env` and rename it to `.env`. This file stores variables used in `docker-compose.yaml`. Required only when installing with traefik; if using the default setup, you can skip this step. + +```shell +cp ./docker/example.env .env +``` + +3. Configure kernel parameters because they cannot be changed inside the container, specifically `fs.inotify.max_user_instances` and `fs.inotify.max_user_watches`. Run the following: + +```shell +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 +``` + +4. Configure container environment variables. Below is the list of variables used during deployment: + +- `MAIL_DOMAIN` – The domain name of the future server. (required) +- `DEBUG_COMMANDS_ENABLED` – Run debug commands before installation. (default: `false`) +- `FORCE_REINIT_INI_FILE` – Recreate the ini configuration file on startup. (default: `false`) +- `USE_FOREIGN_CERT_MANAGER` – Use a third-party certificate manager. (default: `false`) +- `INI_FILE` – Path to the ini configuration file. (default: `./chatmail.ini`) +- `PATH_TO_SSL_CONTAINER` – Path to where the certificates are stored. (default: `/var/lib/acme/live/${MAIL_DOMAIN}`) +- `ENABLE_CERTS_MONITORING` – Enable certificate monitoring if `USE_FOREIGN_CERT_MANAGER=true`. If certificates change, services will be automatically restarted. (default: `false`) +- `CERTS_MONITORING_TIMEOUT` – Interval in seconds to check if certificates have changed. (default: `'60'`) + +You can also use any variables from the [ini configuration file](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/ini/chatmail.ini.f); they must be in uppercase. + +Mandatory variables for deployment via Docker: + +- `CHANGE_KERNEL_SETTINGS` – Change kernel settings (`fs.inotify.max_user_instances` and `fs.inotify.max_user_watches`) on startup. Changing kernel settings inside the container is not possible! (default: `False`) + +5. Configure environment variables in the `.env` file. These variables are used in the `docker-compose.yaml` file to pass repeated values. + +6. Build the Docker image: + +```shell +docker compose build chatmail +``` + +
+Additional steps for configuring with traefik + +> [!note] +> If you are using the default installation without traefik – skip these steps and go to step 7 (running docker compose). + +Before starting traefik, configuration files must be prepared; otherwise, it will not start correctly. + +First, run these commands in the console, replacing their values with the correct ones: + +```shell +export YOUR_EMAIL=your_email@gmail.com +mkdir -p "./data/traefik" +cd "./data/traefik" +``` + +1. Create a traefik configuration file: + +```shell +cat > config.yaml << EOF +log: + level: TRACE + +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 + +serverstransport: + insecureskipverify: true + +certificatesResolvers: + letsEncrypt: + acme: + email: $YOUR_EMAIL + storage: /acme.json + caServer: "https://acme-v02.api.letsencrypt.org/directory" + tlschallenge: true + httpChallenge: + entryPoint: web +EOF +``` + +2. Create a post-hook script: + +```shell +cat > post-hook.sh << 'EOF' +CERTS_DIR=${CERTS_DIR:-"/data/letsencrypt/certs"} + +for dir in "$CERTS_DIR"/*/; do + cd "$dir" + if [ -f "certificate.crt" ]; then + ln -sf certificate.crt fullchain + fi + if [ -f "privatekey.key" ]; then + ln -sf privatekey.key privkey + fi + cd - +done +EOF +``` + +3. Create the `acme.json` file: + +```shell +touch acme.json +sudo chown 0:0 ./acme.json # required +sudo chmod 600 ./acme.json # required +``` + +4. Create insecure config: + +```shell +mkdir dynamic-configs +cat > ./dynamic-configs/insecure.yaml << 'EOF' +http: + serversTransports: + insecure: + insecureSkipVerify: true +EOF +cd ../.. +``` + +
+ +7. Start docker compose and wait for the installation to finish: + +```shell +docker compose up -d # start service +docker compose logs -f chatmail # view container logs, press CTRL+C to exit +``` + +8. After installation is complete, you can open `https://` in your browser. + +## Using custom files + +When using Docker, you can apply modified configuration files to make the installation more personalized. This is usually needed for the `www/src` section so that the Chatmail landing page is customized to your taste, but it can be used for any other cases as well. + +To replace files correctly: + +1. Create the `./custom` directory. It is in `.gitignore`, so it won’t cause conflicts when updating. + +```shell +mkdir -p ./custom +``` + +2. Modify the required file. For example, `index.md`: + +```shell +mkdir -p ./custom/www/src +nano ./custom/www/src/index.md +``` + +3. In `docker-compose.yaml`, add the file mount in the `volumes` section: + +```yaml +services: + chatmail: + volumes: + ... + ## custom resources + - ./custom/www/src/index.md:/opt/chatmail/www/src/index.md +``` + +4. Restart the service: + +```shell +docker compose down +docker compose up -d +``` + +## Locking the Chatmail version + +> [!note] +> These steps are optional and should only be done if you are not satisfied that the service is installed each time the container starts. + +Since the current Docker version installs the Chatmail service every time the container starts, you can lock the container version after installation as follows: + +1. Commit the current state of the configured container: + +```shell +docker container commit chatmail configured-chatmail:$(date +'%Y-%m-%d') +docker image ls | grep configured-chatmail +``` + +2. Change the entrypoint for the container in `docker-compose.yaml` to: + +```yaml +services: + chatmail: + image: + volumes: + ... + ## custom resources + - ./custom/setup_chatmail_docker.sh:/setup_chatmail_docker.sh +``` + +3. Create the file `./custom/setup_chatmail_docker.sh` with the new configuration: + +```shell +mkdir -p ./custom +cat > ./custom/setup_chatmail_docker.sh << 'EOF' +#!/bin/bash + +set -eo pipefail + +export ENABLE_CERTS_MONITORING="${ENABLE_CERTS_MONITORING:-true}" +export CERTS_MONITORING_TIMEOUT="${CERTS_MONITORING_TIMEOUT:-60}" +export PATH_TO_SSL_CONTAINER="${PATH_TO_SSL_CONTAINER:-/var/lib/acme/live/${MAIL_DOMAIN}}" + +calculate_hash() { + find "$PATH_TO_SSL_CONTAINER" -type f -exec sha1sum {} \; | sort | sha1sum | awk '{print $1}' +} + +monitor_certificates() { + if [ "$ENABLE_CERTS_MONITORING" != "true" ]; then + echo "Certs monitoring disabled." + exit 0 + fi + + current_hash=$(calculate_hash) + previous_hash=$current_hash + + while true; do + current_hash=$(calculate_hash) + if [[ "$current_hash" != "$previous_hash" ]]; then + # TODO: add an option to restart at a specific time interval + echo "[INFO] Certificate's folder hash was changed, restarting nginx, dovecot and postfix services." + systemctl restart nginx.service + systemctl reload dovecot.service + systemctl reload postfix.service + previous_hash=$current_hash + fi + sleep $CERTS_MONITORING_TIMEOUT + done +} + +monitor_certificates & +EOF +``` + +4. Restart the service: + +```shell +docker compose down +docker compose up -d +``` diff --git a/docs/DOCKER_INSTALLATION_RU.md b/docs/DOCKER_INSTALLATION_RU.md new file mode 100644 index 00000000..36d1913a --- /dev/null +++ b/docs/DOCKER_INSTALLATION_RU.md @@ -0,0 +1,284 @@ +# Известные проблемы и ограничения +- Установка с помощью acmetool (`docker-compose-default.yaml`) может НЕ работать. В таком случае используйте установку через traefik (`docker-compose-traefik.yaml`). Лично у меня при тестах ошибка была `could not install DNS challenge, no hooks succeeded;`, которую исправить не удалось. +- Chatmail будет переустановлен при каждом запуске контейнера (при первом - долго, при последующих быстрее). Так устроен изначальный установщик, потому что он не был заточен под docker. В конце документации [представлено](#фиксирование-версии-chatmail) возможное решение +- Требуется настроенный в системе cgroups v2. Работа с cgroups v1 не тестировалась. +- Да, понятно дело что systemd использовать в контейнере костыль и надо это всё разнести на несколько сервисов, но это MVP и в первом приближении оказалось сделать проще так, чем переписывать всю систему развертывания. +- docker образ подходит только для amd64, если нужно запустить на другой архитектуре, попробуйте изменить dockerfile (конкретно ту часть что ответсвенна за установку dovecot) + +# Docker installation +Здесь представлена инструкция по установке chatmail с помощью docker-compose. + +## Предварительная настройка +We use `chat.example.org` as the chatmail domain in the following steps. +Please substitute it with your own domain. + +1. Настройте начальные записи DNS.Ниже приведен пример в привычном формате файла зоны BIND сTTL 1 час (3600 секунд). + Замените домен и IP-адреса на свои. + + ``` + chat.example.com. 3600 IN A 198.51.100.5 + chat.example.com. 3600 IN AAAA 2001:db8::5 + www.chat.example.com. 3600 IN CNAME chat.example.com. + mta-sts.chat.example.com. 3600 IN CNAME chat.example.com. + ``` + +2. Склонируйте репозиторий на свой сервер. + + ```shell + git clone https://github.com/chatmail/relay + cd relay + ``` + +## Installation +При установке через docker есть несколько вариантов: +- использовать встроенный в chatmail контейнер nginx и acmetool для хостинга чата и управления сертификатами. +- использовать сторонние инструменты для менеджмента сертификатов + +В качестве примера для стороннего менеджера сертификатов будет использоваться traefik, но вы можете использовать то что удобнее вам. + +1. Скопировать файл `./docker/docker-compose-default.yaml` или `./docker/docker-compose-traefik.yaml` и переименовать в `docker-compose.yaml`. Это нужно потому что `docker-compose.yaml` находится в `.gitignore` и не будет создавать конфликты при обновлении гит репозитория. +```shell +cp ./docker/docker-compose-default.yaml docker-compose.yaml +## or +# cp ./docker/docker-compose-traefik.yaml docker-compose.yaml +``` + +2. Скопировать `./docker/example.env` и переименовать в `.env`. Здесь хранятся переменные, которые используятся в `docker-compose.yaml`. Нужен только для установки совместно с traefik, если используется default - можно пропустить +```shell +cp ./docker/example.env .env +``` + +3. Настроить параметры ядра, потому что внутри контейнера их нельзя изменить, а конкретно `fs.inotify.max_user_instances` и `fs.inotify.max_user_watches`. Для этого выполнить следующее: +```shell +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 +``` + +4. Настроить переменные окружения контейнера. Ниже перечислен список переменных учавствующих при развертывании. +- `MAIL_DOMAIN` - Доменное имя будущего сервера. (required) +- `DEBUG_COMMANDS_ENABLED` - Выполнить debug команды перед установкой. (default: `false`) +- `FORCE_REINIT_INI_FILE` - Пересоздавать ini файл конфигурации при запуске. (default: `false`) +- `USE_FOREIGN_CERT_MANAGER` - Использовать сторонний менеджер сертификатов. (default: `false`) +- `INI_FILE` - путь к ini файлу конфигурации. (default: `./chatmail.ini`) +- `PATH_TO_SSL_CONTAINER` - Путь где располагаются сертификаты. (default: `/var/lib/acme/live/${MAIL_DOMAIN}`) +- `ENABLE_CERTS_MONITORING` - Включить мониторинг сертификатов, если `USE_FOREIGN_CERT_MANAGER=true`. Если сертфикаты изменятся сервисы будут автоматически перезапущены. (default: `false`) +- `CERTS_MONITORING_TIMEOUT` - Раз во сколько секунд проверять что изменились сертификаты. (default: `'60'`) + +Также могут быть использованы все переменные из [ini файла конфигурации](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/ini/chatmail.ini.f), они обязаны быть в uppercase формате. + +Ниже перечислены переменные, которые обязательны быть выставлены при развертывании через docker: +- `CHANGE_KERNEL_SETTINGS` - Менять настройки ядра (`fs.inotify.max_user_instances` и `fs.inotify.max_user_watches`) при запуске. При запуске в контейнере смена настроек ядра не может быть выполнена! (default: `False`) + +5. Настроить переменные окружения в `.env` файле. Эти переменные используются в `docker-compose.yaml` файле, чтобы передавать повторяющиеся значения. + +6. Собрать docker образ +```shell +docker compose build chatmail +``` + +
+ +Дополнительные шаги для конфигурации работы с traefik + +> [!note] +> Если вы используете default установку, без использования traefik - пропустите эти шаги и переходите к шагу 7 (запуск docker compose) + +Перед запуском traefik необходимо подготовить файлы конфигурации, иначе он запустится некорректно. + +Сначала выполните эти команды в консоли, заменив значения в них на корректные. +```shell +export YOUR_EMAIL=your_email@gmail.com +mkdir -p "./data/traefik" +cd "./data/traefik" +``` + +1. Создать файл конфигурации traefik +```shell +cat > config.yaml << EOF +log: + level: TRACE + +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 + +serverstransport: + insecureskipverify: true + +certificatesResolvers: + letsEncrypt: + acme: + email: $YOUR_EMAIL + storage: /acme.json + caServer: "https://acme-v02.api.letsencrypt.org/directory" + tlschallenge: true + httpChallenge: + entryPoint: web +EOF +``` + +2. Создать post-hook скрипт +```shell +cat > post-hook.sh << 'EOF' +CERTS_DIR=${CERTS_DIR:-"/data/letsencrypt/certs"} + +for dir in "$CERTS_DIR"/*/; do + cd "$dir" + if [ -f "certificate.crt" ]; then + ln -sf certificate.crt fullchain + fi + if [ -f "privatekey.key" ]; then + ln -sf privatekey.key privkey + fi + cd - +done +EOF +``` + +3. Создать `acme.json` файл +```shell +touch acme.json +sudo chown 0:0 ./acme.json # это обязательно +sudo chmod 600 ./acme.json # это обязательно +``` + +4. Создать insecure config +```shell +mkdir dynamic-configs +cat > ./dynamic-configs/insecure.yaml << 'EOF' +http: + serversTransports: + insecure: + insecureSkipVerify: true +EOF +cd ../.. +``` + +
+ +7. Запустить docker compose и дождаться завершения установки +```shell +docker compose up -d # запуск сервиса +docker compose logs -f chatmail # просмотр логов контейнера. Для выхода нажать CTRL+C +``` + +8. По окончанию установки можно открыть в браузер `https://` + +## Использование кастомных файлов +При использовании docker есть возможность использовать измененые файлы конфигурации, чтобы сделать установку более персонализированной. Обычно это требуется для секции `www/src`, чтобы ознакомительная страница Chatmail была сделана на ваш вкус. Но также это можно использовать и для любых других случаев. + +Для того чтобы корректно выполнить подмену файлов необходимо +1. создать каталог `./custom`, он находится в `.gitignore`, поэтому при обновлении не вызовет конфликтов. +```shell +mkdir -p ./custom +``` + +2. Изменить нужный файл. Для примера возьмем `index.md` +```shell +mkdir -p ./custom/www/src +nano ./custom/www/src/index.md +``` + +3. В `docker-compose.yaml` добавить монтирование файла с помощью секции `volumes` +```yaml +services: + chatmail: + volumes: + ... + ## custom resources + - ./custom/www/src/index.md:/opt/chatmail/www/src/index.md +``` + +4. Перезапустить сервис +```shell +docker compose down +docker compose up -d +``` + +## Фиксирование версии Chatmail +> [!note] +> Это опциональные шаги, их делать требуется только если вас не устраивает что сервис устанавливается каждый раз при запуске + +Поскольку в текущей версии docker chatmail сервис устанавливается каждый раз запуске контейнера, чтобы этого не происходило можно зафиксировать версию контейнера после установки. Делается это следующим образом: + +1. Зафиксировать текущее состояние сконфигурированного контейнера +```shell +docker container commit chatmail configured-chatmail:$(date +'%Y-%m-%d') +docker image ls | grep configured-chatmail +``` + +2. Изменить entrypoint для контейнера в `docker-compose.yaml` на +```yaml +services: + chatmail: + image: + volumes: + ... + ## custom resources + - ./custom/setup_chatmail_docker.sh:/setup_chatmail_docker.sh +``` + +3. Создать файл `./custom/setup_chatmail_docker.sh` с новым файлом конфигурации +```shell +mkdir -p ./custom +cat > ./custom/setup_chatmail_docker.sh << 'EOF' +#!/bin/bash + +set -eo pipefail + +export ENABLE_CERTS_MONITORING="${ENABLE_CERTS_MONITORING:-true}" +export CERTS_MONITORING_TIMEOUT="${CERTS_MONITORING_TIMEOUT:-60}" +export PATH_TO_SSL_CONTAINER="${PATH_TO_SSL_CONTAINER:-/var/lib/acme/live/${MAIL_DOMAIN}}" + +calculate_hash() { + find "$PATH_TO_SSL_CONTAINER" -type f -exec sha1sum {} \; | sort | sha1sum | awk '{print $1}' +} + +monitor_certificates() { + if [ "$ENABLE_CERTS_MONITORING" != "true" ]; then + echo "Certs monitoring disabled." + exit 0 + fi + + current_hash=$(calculate_hash) + previous_hash=$current_hash + + while true; do + current_hash=$(calculate_hash) + if [[ "$current_hash" != "$previous_hash" ]]; then + # TODO: add an option to restart at a specific time interval + echo "[INFO] Certificate's folder hash was changed, restarting nginx, dovecot and postfix services." + systemctl restart nginx.service + systemctl reload dovecot.service + systemctl reload postfix.service + previous_hash=$current_hash + fi + sleep $CERTS_MONITORING_TIMEOUT + done +} + +monitor_certificates & +EOF +``` + +4. Перезапустить сервис +```shell +docker compose down +docker compose up -d +``` diff --git a/www/src/index.md b/www/src/index.md index e167c740..8613772b 100644 --- a/www/src/index.md +++ b/www/src/index.md @@ -1,7 +1,8 @@ - -## Dear [Delta Chat](https://get.delta.chat) users and newcomers ... +/// tab | 🇬🇧 English + +## Dear [Delta Chat](https://get.delta.chat) users and newcomers ... {% if config.mail_domain != "nine.testrun.org" %} Welcome to instant, interoperable and [privacy-preserving](privacy.html) messaging :) @@ -23,7 +24,34 @@ you can also **scan this QR code** with Delta Chat: 🐣 **Choose** your Avatar and Name 💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee) +/// + +/// tab | 🇷🇺 Русский + +## Уважаемые пользователи и новички [Delta Chat](https://get.delta.chat)... {% if config.mail_domain != "nine.testrun.org" %} +Добро пожаловать в мир мгновенного, совместимого и [конфиденциального](privacy.html) обмена сообщениями :) +{% else %} +Вы находитесь на сервере по умолчанию ({{ config.mail_domain }}) +для пользователей Delta Chat. Подробную информацию о том, как он избегает хранения личной информации, +см. в нашей [политике конфиденциальности](privacy.html). +{% endif %} + +Создать чат-профиль на {{config.mail_domain}} + +Если вы открыли эту страницу на устройстве, +где нет приложения Delta Chat, вы можете +**отсканировать этот QR-код** с помощью Delta Chat: + + + + +🐣 **Выберите** аватар и имя + +💬 **Начните** чат с любыми контактами Delta Chat через [QR-приглашения](https://delta.chat/ru/help#howtoe2ee) +/// + +{% if config.is_development_instance == True %}
Note: this is only a temporary development chatmail service
{% endif %} diff --git a/www/src/info.md b/www/src/info.md index 1fd7eb5e..fc928db4 100644 --- a/www/src/info.md +++ b/www/src/info.md @@ -1,3 +1,6 @@ + + +/// tab | 🇬🇧 English ## More information @@ -41,3 +44,47 @@ This chatmail provider is run by a small voluntary group of devs and sysadmins, who [publically develop chatmail provider setups](https://github.com/deltachat/chatmail). Chatmail setups aim to be very low-maintenance, resource efficient and interoperable with any other standards-compliant e-mail service. +/// + +/// tab | 🇷🇺 Русский + +## Дополнительная информация + +{{ config.mail_domain }} предоставляет малозатратный, ресурсосберегающий и совместимый с другими системами почтовый сервис для всех. За `chatmail` фактически скрывается +обычный почтовый адрес, как и любой другой, но оптимизированный +для использования в чатах, особенно DeltaChat. + +### Ограничения по скорости и хранению + +* Незашифрованные сообщения блокируются для получателей вне + {{config.mail_domain}}, но добавление контакта через [QR-коды приглашения](https://delta.chat/en/help#howtoe2ee) + позволяет свободно обмениваться сообщениями между с ним. + +* Вы можете отправлять до {{ config.max_user_send_per_minute }} сообщений в минуту. + +- Вы можете хранить до [{{ config.max_mailbox_size }} сообщений на сервере](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server). + +* Сообщения в любом случае будут удалены с сервера через {{ config.delete_mails_after }} дней после поступления на сервер. + Или раньше, если хранилище превышает допустимый объем. + +### Удаление аккаунта + +Если вы удалите профиль {{ config.mail_domain }} через приложение Delta Chat, +соответствующая учетная запись на сервере и все связанные с ней данные +будут автоматически удалены через {{ config.delete_inactive_users_after }} дней. + +Если вы используете несколько устройств, +вам необходимо удалить профиль чата на каждом из них, +чтобы все данные аккаунта были удалены с сервера. + +Если у вас есть дополнительные вопросы или запросы по поводу удаления аккаунта, +пожалуйста, отправьте сообщение со своей учетной записи на {{ config.privacy_mail }}. + +### Кто операторы? Какое ПО используется? + +Этот chatmail провайдер управляется небольшой группой добровольцев — разработчиков и системных администраторов, +которые [публично разрабатывают инфраструктуру chatmail провайдеров](https://github.com/deltachat/chatmail). +Chatmail стремится быть максимально простыми в обслуживании, ресурсосберегающими и +совместимыми с любым другим почтовым сервисом, соответствующим стандартам. + +/// diff --git a/www/src/main.css b/www/src/main.css index 772b2e9d..6acf12a3 100644 --- a/www/src/main.css +++ b/www/src/main.css @@ -84,3 +84,57 @@ code { color: white !important; font-weight: bold; } + +.tabbed-set { + position: relative; + display: flex; + flex-wrap: wrap; + margin: 1em 0; + border-radius: 0.1rem; +} + +.tabbed-set > input { + display: none; +} + +.tabbed-set label { + width: auto; + padding: 0.9375em 1.25em 0.78125em; + font-weight: 700; + font-size: 0.84em; + white-space: nowrap; + border-bottom: 0.15rem solid transparent; + border-top-left-radius: 0.1rem; + border-top-right-radius: 0.1rem; + cursor: pointer; + transition: background-color 250ms, color 250ms; +} + +.tabbed-set .tabbed-content { + width: 100%; + display: none; + box-shadow: 0 -.05rem #ddd; +} + +.tabbed-set input { + position: absolute; + opacity: 0; +} + +.tabbed-set input:checked:nth-child(n+1) + label { + color: red; + border-color: red; +} + +@media screen { + .tabbed-set input:nth-child(n+1):checked + label + .tabbed-content { + order: 99; + display: block; + } +} + +@media print { + .tabbed-content { + display: contents; + } +} diff --git a/www/src/page-layout.html b/www/src/page-layout.html index 4fe178eb..28ffde56 100644 --- a/www/src/page-layout.html +++ b/www/src/page-layout.html @@ -9,7 +9,7 @@ {{ config.mail_domain }} {{ pagename }} - + diff --git a/www/src/privacy.md b/www/src/privacy.md index a6626960..cde7d030 100644 --- a/www/src/privacy.md +++ b/www/src/privacy.md @@ -1,3 +1,6 @@ + + +/// tab | 🇬🇧 English # Privacy Policy for {{ config.mail_domain }} @@ -267,5 +270,199 @@ as of *October 2024*. Due to the further development of our service and offers or due to changed legal or official requirements, it may become necessary to revise this data protection declaration from time to time. +/// + +/// tab | 🇷🇺 Русский + +# Политика конфиденциальности для {{ config.mail_domain }} + +{% if config.mail_domain == "nine.testrun.org" %} +Добро пожаловать на `{{config.mail_domain}}` — это основной сервер Chatmail для новых пользователей Delta Chat. +Он поддерживается небольшой командой системных администраторов на добровольной основе. +Альтернативные сервера вы можете найти [здесь](https://delta.chat/en/chatmail). +{% endif %} + +## Кратко: Личные данные не запрашиваются и не собираются + +Этот сервер Chatmail не запрашивает и не сохраняет личную информацию. +Серверы Chatmail существуют исключительно для надёжной передачи (временного хранения и доставки) зашифрованных сообщений между устройствами пользователей, использующих мессенджер Delta Chat. + +Технически, Chatmail-сервер можно представить как «маршрутизатор сообщений» с поддержкой сквозного шифрования в масштабе интернета. + +В отличие от классических почтовых сервисов (например, Gmail), +Chatmail-серверы не запрашивают личные данные и не хранят письма постоянно. +Они ближе по устройству к серверам Signal, +однако не используют номера телефонов и могут безопасно и автоматически взаимодействовать как с другими Chatmail-серверами, так и с обычной электронной почтой. + +Отличия от традиционных почтовых серверов: + +- безусловное удаление сообщений через {{ config.delete_mails_after }} дней; +- невозможность отправки незашифрованных сообщений; +- отсутствие хранения IP-адресов; +- IP-адреса не обрабатываются в связке с адресами электронной почты. + +Из-за отсутствия обработки персональных данных +данный сервер, возможно, формально не обязан иметь политику конфиденциальности. + +Тем не менее, ниже приведена юридическая информация +для удобства специалистов по защите данных и юристов, изучающих работу Chatmail. + +--- + +## 1. Название и контактная информация + +Ответственный за обработку ваших персональных данных: + +``` +{{ config.privacy_postal }} +``` + +Эл. почта: {{ config.privacy_mail }} + +Назначен ответственный по защите данных: + +``` +{{ config.privacy_pdo }} +``` + +--- + +## 2. Обработка при использовании чата и электронной почты + +Мы предоставляем сервисы, оптимизированные для работы с приложением [Delta Chat](https://delta.chat), +и обрабатываем только те данные, которые необходимы для настройки и технической реализации доставки сообщений. +Цель обработки — дать пользователям возможность читать, писать, управлять, удалять, отправлять и получать сообщения. + +Для этого мы используем серверное ПО, обеспечивающее передачу сообщений. + +Обрабатываются следующие данные: + +- Исходящие и входящие сообщения (SMTP) временно хранятся до их доставки получателю; +- Сообщения доступны получателю через IMAP до их удаления пользователем или по истечении установленного срока + (*обычно 4–8 недель*); +- Протоколы IMAP и SMTP защищены паролем, уникальным для каждого аккаунта; +- Пользователи могут самостоятельно просматривать или удалять сообщения через любой стандартный IMAP-клиент; +- Также возможно подключение к «службе передачи в реальном времени», + которая устанавливает P2P-соединение между устройствами и позволяет отправлять временные сообщения, + которые *никогда* не сохраняются на сервере — даже в зашифрованном виде. + +### 2.1 Создание аккаунта + +Аккаунт создаётся одним из двух способов: + +- с помощью QR-кода приглашения, + отсканированного через приложение Delta Chat; + +- автоматически, при создании и регистрации аккаунта в {{ config.mail_domain }} через приложение Delta Chat. + +В любом случае, обрабатывается только созданный адрес электронной почты. +Номера телефонов, другие адреса электронной почты или любые другие идентификаторы не требуются. +Правовое основание для обработки — +статья 6 (1) пункт b Общего регламента по защите данных (GDPR), +так как вы заключаете пользовательский договор, пользуясь нашим сервисом. + +### 2.2 Обработка почтовых сообщений + +Кроме того, мы обрабатываем данные, +необходимые для обеспечения стабильной работы инфраструктуры сервера, +доставки сообщений и предотвращения злоупотреблений. + +- Поэтому может потребоваться обработка содержимого и/или метаданных + (например, заголовков писем и технической информации SMTP) во время передачи; + +- Мы храним логи передаваемых сообщений ограниченное время — + они используются для устранения проблем с доставкой и ошибок ПО. + +Также мы вводим ограничения для защиты системы от перегрузок: + +- ограничения скорости (rate limits), +- лимиты на объём хранения, +- ограничения на размер сообщений, +- любые другие меры, необходимые для стабильной работы сервера и предотвращения злоупотреблений. + +Обработка вышеуказанных данных необходима для предоставления сервиса. +Правовое основание — статья 6 (1) пункт b GDPR. +Обработка данных в целях безопасности и предотвращения злоупотреблений основана на статье 6 (1) пункт f GDPR, +и соответствует нашим законным интересам. + +Мы не используем собранные данные для определения вашей личности. + +--- + +## 3. Обработка при посещении сайта + +При посещении нашего сайта браузер вашего устройства +автоматически передаёт определённую информацию на сервер, +где она временно сохраняется в так называемых лог-файлах. +Эти данные автоматически удаляются (обычно через *7 дней*). + +Среди собираемых данных: + +- тип используемого браузера, +- операционная система, +- дата и время доступа, +- страна и IP-адрес, +- запрашиваемый файл или ресурс, +- объём переданных данных, +- статус доступа (успешно, ошибка и т.п.), +- страница, с которой был сделан запрос. + +Хостинг нашего сайта осуществляется внешним провайдером. +Личные данные, собираемые на сайте, хранятся на его серверах. +Провайдер обрабатывает данные строго по нашим инструкциям, +в пределах заключённого договора на обработку данных (ст. 28 GDPR). + +Цели обработки: + +- обеспечение стабильного подключения к сайту; +- удобство использования сайта; +- контроль безопасности и стабильности системы; +- административные цели. + +Правовое основание — статья 6 (1) пункт f GDPR. +Собранные данные не используются для установления вашей личности. + +--- + +## 4. Передача данных + +Мы не сохраняем личные данные, +но письма, ожидающие доставки, могут содержать личную информацию. +Такие данные не передаются третьим лицам, за исключением следующих случаев: + +a) при наличии вашего явного согласия (ст. 6 п.1 п. a GDPR); + +b) если передача необходима для защиты прав, интересов или правовой позиции (ст. 6 п.1 п. f GDPR); + +c) если это требуется по закону (ст. 6 п.1 п. c GDPR); + +d) если это необходимо для исполнения договора с вами (ст. 6 п.1 п. b GDPR); + +e) если обработка осуществляется сервис-провайдером по нашему поручению, + с которым заключён договор (ст. 28 GDPR), + предусматривающий меры безопасности и контроль с нашей стороны. + +--- + +## 5. Права субъектов данных + +Ваши права закреплены в статьях 12–23 GDPR. +Так как сервер не хранит персональные данные — даже в зашифрованном виде — +предоставление информации или подача возражений не требуются. +Удаление данных можно выполнить напрямую через приложение Delta Chat. + +Если у вас есть вопросы или жалобы, напишите нам: +{{ config.privacy_mail }} + +Также вы можете обратиться в надзорный орган по месту вашего проживания, +работы или к органу, ответственному за нашу деятельность: +`{{ config.privacy_supervisor }}`. + +--- +## 6. Актуальность политики конфиденциальности +Настоящая политика действует с *октября 2024 года*. +В случае изменений в услугах или законодательства +она может быть обновлена. +///