mirror of
https://github.com/chatmail/relay.git
synced 2026-05-14 18:04:38 +00:00
Compare commits
8 Commits
j4n/docker
...
ipv4-only
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1651917a57 | ||
|
|
2ba19fd888 | ||
|
|
26c5e1e847 | ||
|
|
8ae2c475fb | ||
|
|
85223245e4 | ||
|
|
f152b0fca9 | ||
|
|
808eb3e53e | ||
|
|
bbacd74c9f |
@@ -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.6.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.5.2/filtermail-x86_64 -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
|
||||||
|
|||||||
196
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
196
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
@@ -4,7 +4,6 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- j4n/docker-pr
|
|
||||||
pull_request:
|
pull_request:
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- 'scripts/**'
|
- 'scripts/**'
|
||||||
@@ -12,67 +11,7 @@ on:
|
|||||||
- 'CHANGELOG.md'
|
- 'CHANGELOG.md'
|
||||||
- 'LICENSE'
|
- 'LICENSE'
|
||||||
|
|
||||||
env:
|
|
||||||
REGISTRY: ghcr.io
|
|
||||||
IMAGE_NAME: ${{ github.repository }}
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-docker:
|
|
||||||
name: Build Docker image
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
outputs:
|
|
||||||
image: ${{ steps.image-ref.outputs.image }}
|
|
||||||
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: foo/docker-pr -> :foo-docker-pr
|
|
||||||
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 }}
|
|
||||||
|
|
||||||
- name: Output image reference
|
|
||||||
id: image-ref
|
|
||||||
run: |
|
|
||||||
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
|
|
||||||
IMAGE="${{ env.REGISTRY }}/$(echo "${{ env.IMAGE_NAME }}" | tr '[:upper:]' '[:lower:]'):sha-${SHORT_SHA}"
|
|
||||||
echo "image=${IMAGE}" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
name: deploy on staging-ipv4.testrun.org, and run tests
|
name: deploy on staging-ipv4.testrun.org, and run tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -116,7 +55,6 @@ jobs:
|
|||||||
run: echo venv/bin >>$GITHUB_PATH
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
- name: upload TLS cert after rebuilding
|
- name: upload TLS cert after rebuilding
|
||||||
id: wait-for-vps
|
|
||||||
run: |
|
run: |
|
||||||
echo " --- wait until staging-ipv4.testrun.org VPS is rebuilt --- "
|
echo " --- wait until staging-ipv4.testrun.org VPS is rebuilt --- "
|
||||||
rm ~/.ssh/known_hosts
|
rm ~/.ssh/known_hosts
|
||||||
@@ -130,8 +68,8 @@ jobs:
|
|||||||
rsync -avz dkimkeys-restore/dkimkeys root@staging-ipv4.testrun.org:/etc/ || true
|
rsync -avz dkimkeys-restore/dkimkeys root@staging-ipv4.testrun.org:/etc/ || true
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
- name: setup dependencies
|
- name: setup dependencies
|
||||||
run: |
|
run: |
|
||||||
@@ -164,133 +102,3 @@ jobs:
|
|||||||
- name: cmdeploy dns
|
- name: cmdeploy dns
|
||||||
run: ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy dns -v --ssh-host localhost"
|
run: ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy dns -v --ssh-host localhost"
|
||||||
|
|
||||||
# --- Docker deploy (push only, runs even if bare failed) ---
|
|
||||||
|
|
||||||
- name: stop bare services
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging-ipv4.testrun.org 'systemctl stop postfix dovecot nginx opendkim unbound filtermail doveauth chatmail-metadata iroh-relay mtail fcgiwrap acmetool 2>/dev/null || true'
|
|
||||||
|
|
||||||
- name: install Docker on VPS
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging-ipv4.testrun.org 'apt-get update && apt-get install -y ca-certificates curl'
|
|
||||||
ssh root@staging-ipv4.testrun.org 'install -m 0755 -d /etc/apt/keyrings'
|
|
||||||
ssh root@staging-ipv4.testrun.org 'curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc && chmod a+r /etc/apt/keyrings/docker.asc'
|
|
||||||
ssh root@staging-ipv4.testrun.org 'echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian $(. /etc/os-release && echo $VERSION_CODENAME) stable" > /etc/apt/sources.list.d/docker.list'
|
|
||||||
ssh root@staging-ipv4.testrun.org 'apt-get update && apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin'
|
|
||||||
|
|
||||||
- name: prepare Docker bind mounts
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging-ipv4.testrun.org 'mkdir -p /srv/chatmail/certs /srv/chatmail/dkim'
|
|
||||||
ssh root@staging-ipv4.testrun.org 'cp -a /var/lib/acme/. /srv/chatmail/certs/ && cp -a /etc/dkimkeys/. /srv/chatmail/dkim/' || true
|
|
||||||
|
|
||||||
- name: upload chatmail.ini for Docker
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
# Reuse chatmail.ini already created by the bare-metal deploy steps
|
|
||||||
ssh root@staging-ipv4.testrun.org "cp relay/chatmail.ini /srv/chatmail/chatmail.ini"
|
|
||||||
|
|
||||||
- name: deploy with Docker
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
|
|
||||||
GHCR_IMAGE="${{ env.REGISTRY }}/$(echo "${{ env.IMAGE_NAME }}" | tr '[:upper:]' '[:lower:]'):sha-${SHORT_SHA}"
|
|
||||||
rsync -avz --exclude='.git' --exclude='venv' --exclude='__pycache__' ./ root@staging-ipv4.testrun.org:/srv/chatmail/relay/
|
|
||||||
# Login to GHCR on VPS and pull pre-built image
|
|
||||||
echo "${{ secrets.GITHUB_TOKEN }}" | ssh root@staging-ipv4.testrun.org 'docker login ghcr.io -u ${{ github.actor }} --password-stdin'
|
|
||||||
ssh root@staging-ipv4.testrun.org "docker pull ${GHCR_IMAGE}"
|
|
||||||
ssh root@staging-ipv4.testrun.org "cd /srv/chatmail/relay && CHATMAIL_IMAGE=${GHCR_IMAGE} MAIL_DOMAIN=staging-ipv4.testrun.org docker compose -f docker/docker-compose.yaml -f docker/docker-compose.ci.yaml up -d"
|
|
||||||
|
|
||||||
- name: wait for container healthy
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
# Stream journald inside the container
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail journalctl -f --no-pager' &
|
|
||||||
LOG_PID=$!
|
|
||||||
trap "kill $LOG_PID 2>/dev/null || true" EXIT
|
|
||||||
for i in $(seq 1 60); do
|
|
||||||
status=$(ssh root@staging-ipv4.testrun.org 'docker inspect --format={{.State.Health.Status}} chatmail 2>/dev/null' || echo "missing")
|
|
||||||
echo " [$i/60] status=$status"
|
|
||||||
if [ "$status" = "healthy" ]; then
|
|
||||||
echo "Container is healthy."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
if [ "$status" = "unhealthy" ]; then
|
|
||||||
echo "Container is unhealthy!"
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
sleep 5
|
|
||||||
done
|
|
||||||
echo "Container did not become healthy."
|
|
||||||
kill $LOG_PID 2>/dev/null || true
|
|
||||||
echo "--- failed units ---"
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail systemctl --failed --no-pager' || true
|
|
||||||
echo "--- service logs ---"
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail journalctl -u dovecot -u postfix -u nginx -u unbound --no-pager -n 50' || true
|
|
||||||
echo "--- listening ports ---"
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail ss -tlnp' || true
|
|
||||||
echo "--- chatmail.ini ---"
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail cat /etc/chatmail/chatmail.ini' || true
|
|
||||||
exit 1
|
|
||||||
|
|
||||||
- name: show container state
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
echo "--- listening ports ---"
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail ss -tlnp'
|
|
||||||
echo "--- chatmail.ini ---"
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail cat /etc/chatmail/chatmail.ini'
|
|
||||||
|
|
||||||
- name: Docker integration tests
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail cmdeploy test --slow --ssh-host @local'
|
|
||||||
|
|
||||||
- name: Docker DNS
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
# Reset zone file in case bare DNS already appended to it
|
|
||||||
git checkout .github/workflows/staging-ipv4.testrun.org-default.zone
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail chown opendkim:opendkim -R /etc/dkimkeys'
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker exec chatmail cmdeploy dns --ssh-host @local --zonefile /opt/chatmail/staging.zone --verbose'
|
|
||||||
ssh root@staging-ipv4.testrun.org 'docker cp chatmail:/opt/chatmail/staging.zone /tmp/staging.zone'
|
|
||||||
scp root@staging-ipv4.testrun.org:/tmp/staging.zone staging-generated.zone
|
|
||||||
cat staging-generated.zone >> .github/workflows/staging-ipv4.testrun.org-default.zone
|
|
||||||
cat .github/workflows/staging-ipv4.testrun.org-default.zone
|
|
||||||
scp .github/workflows/staging-ipv4.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging-ipv4.testrun.org.zone
|
|
||||||
ssh root@ns.testrun.org nsd-checkzone staging-ipv4.testrun.org /etc/nsd/staging-ipv4.testrun.org.zone
|
|
||||||
ssh root@ns.testrun.org systemctl reload nsd
|
|
||||||
|
|
||||||
- name: Docker final DNS check
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: ssh root@staging-ipv4.testrun.org 'docker exec chatmail cmdeploy dns -v --ssh-host @local'
|
|
||||||
|
|
||||||
# --- Cleanup ---
|
|
||||||
|
|
||||||
- name: add SSH keys
|
|
||||||
if: >-
|
|
||||||
!cancelled()
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: ssh root@staging-ipv4.testrun.org 'curl -s https://github.com/hpk42.keys https://github.com/j4n.keys >> .ssh/authorized_keys'
|
|
||||||
|
|||||||
196
.github/workflows/test-and-deploy.yaml
vendored
196
.github/workflows/test-and-deploy.yaml
vendored
@@ -4,7 +4,6 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- j4n/docker-pr
|
|
||||||
pull_request:
|
pull_request:
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- 'scripts/**'
|
- 'scripts/**'
|
||||||
@@ -12,67 +11,7 @@ on:
|
|||||||
- 'CHANGELOG.md'
|
- 'CHANGELOG.md'
|
||||||
- 'LICENSE'
|
- 'LICENSE'
|
||||||
|
|
||||||
env:
|
|
||||||
REGISTRY: ghcr.io
|
|
||||||
IMAGE_NAME: ${{ github.repository }}
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-docker:
|
|
||||||
name: Build Docker image
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
outputs:
|
|
||||||
image: ${{ steps.image-ref.outputs.image }}
|
|
||||||
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: foo/docker-pr -> :foo-docker-pr
|
|
||||||
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 }}
|
|
||||||
|
|
||||||
- name: Output image reference
|
|
||||||
id: image-ref
|
|
||||||
run: |
|
|
||||||
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
|
|
||||||
IMAGE="${{ env.REGISTRY }}/$(echo "${{ env.IMAGE_NAME }}" | tr '[:upper:]' '[:lower:]'):sha-${SHORT_SHA}"
|
|
||||||
echo "image=${IMAGE}" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
name: deploy on staging2.testrun.org, and run tests
|
name: deploy on staging2.testrun.org, and run tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -116,7 +55,6 @@ jobs:
|
|||||||
run: echo venv/bin >>$GITHUB_PATH
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
- name: upload TLS cert after rebuilding
|
- name: upload TLS cert after rebuilding
|
||||||
id: wait-for-vps
|
|
||||||
run: |
|
run: |
|
||||||
echo " --- wait until staging2.testrun.org VPS is rebuilt --- "
|
echo " --- wait until staging2.testrun.org VPS is rebuilt --- "
|
||||||
rm ~/.ssh/known_hosts
|
rm ~/.ssh/known_hosts
|
||||||
@@ -133,8 +71,8 @@ jobs:
|
|||||||
- name: add hpk42 key to staging server
|
- name: add hpk42 key to staging server
|
||||||
run: ssh root@staging2.testrun.org 'curl -s https://github.com/hpk42.keys >> .ssh/authorized_keys'
|
run: ssh root@staging2.testrun.org 'curl -s https://github.com/hpk42.keys >> .ssh/authorized_keys'
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
- run: |
|
- run: |
|
||||||
cmdeploy init staging2.testrun.org
|
cmdeploy init staging2.testrun.org
|
||||||
@@ -157,133 +95,3 @@ jobs:
|
|||||||
- name: cmdeploy dns
|
- name: cmdeploy dns
|
||||||
run: cmdeploy dns -v
|
run: cmdeploy dns -v
|
||||||
|
|
||||||
# --- Docker deploy (push only, runs even if bare failed) ---
|
|
||||||
|
|
||||||
- name: stop bare services
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging2.testrun.org 'systemctl stop postfix dovecot nginx opendkim unbound filtermail doveauth chatmail-metadata iroh-relay mtail fcgiwrap acmetool 2>/dev/null || true'
|
|
||||||
|
|
||||||
- name: install Docker on VPS
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging2.testrun.org 'apt-get update && apt-get install -y ca-certificates curl'
|
|
||||||
ssh root@staging2.testrun.org 'install -m 0755 -d /etc/apt/keyrings'
|
|
||||||
ssh root@staging2.testrun.org 'curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc && chmod a+r /etc/apt/keyrings/docker.asc'
|
|
||||||
ssh root@staging2.testrun.org 'echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian $(. /etc/os-release && echo $VERSION_CODENAME) stable" > /etc/apt/sources.list.d/docker.list'
|
|
||||||
ssh root@staging2.testrun.org 'apt-get update && apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin'
|
|
||||||
|
|
||||||
- name: prepare Docker bind mounts
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging2.testrun.org 'mkdir -p /srv/chatmail/certs /srv/chatmail/dkim'
|
|
||||||
ssh root@staging2.testrun.org 'cp -a /var/lib/acme/. /srv/chatmail/certs/ && cp -a /etc/dkimkeys/. /srv/chatmail/dkim/' || true
|
|
||||||
|
|
||||||
- name: upload chatmail.ini for Docker
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
# Reuse chatmail.ini already created by the bare-metal deploy steps
|
|
||||||
scp chatmail.ini root@staging2.testrun.org:/srv/chatmail/chatmail.ini
|
|
||||||
|
|
||||||
- name: deploy with Docker
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
|
|
||||||
GHCR_IMAGE="${{ env.REGISTRY }}/$(echo "${{ env.IMAGE_NAME }}" | tr '[:upper:]' '[:lower:]'):sha-${SHORT_SHA}"
|
|
||||||
rsync -avz --exclude='.git' --exclude='venv' --exclude='__pycache__' ./ root@staging2.testrun.org:/srv/chatmail/relay/
|
|
||||||
# Login to GHCR on VPS and pull pre-built image
|
|
||||||
echo "${{ secrets.GITHUB_TOKEN }}" | ssh root@staging2.testrun.org 'docker login ghcr.io -u ${{ github.actor }} --password-stdin'
|
|
||||||
ssh root@staging2.testrun.org "docker pull ${GHCR_IMAGE}"
|
|
||||||
ssh root@staging2.testrun.org "cd /srv/chatmail/relay && CHATMAIL_IMAGE=${GHCR_IMAGE} MAIL_DOMAIN=staging2.testrun.org docker compose -f docker/docker-compose.yaml -f docker/docker-compose.ci.yaml up -d"
|
|
||||||
|
|
||||||
- name: wait for container healthy
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
# Stream journald inside the container
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail journalctl -f --no-pager' &
|
|
||||||
LOG_PID=$!
|
|
||||||
trap "kill $LOG_PID 2>/dev/null || true" EXIT
|
|
||||||
for i in $(seq 1 60); do
|
|
||||||
status=$(ssh root@staging2.testrun.org 'docker inspect --format={{.State.Health.Status}} chatmail 2>/dev/null' || echo "missing")
|
|
||||||
echo " [$i/60] status=$status"
|
|
||||||
if [ "$status" = "healthy" ]; then
|
|
||||||
echo "Container is healthy."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
if [ "$status" = "unhealthy" ]; then
|
|
||||||
echo "Container is unhealthy!"
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
sleep 5
|
|
||||||
done
|
|
||||||
echo "Container did not become healthy."
|
|
||||||
kill $LOG_PID 2>/dev/null || true
|
|
||||||
echo "--- failed units ---"
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail systemctl --failed --no-pager' || true
|
|
||||||
echo "--- service logs ---"
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail journalctl -u dovecot -u postfix -u nginx -u unbound --no-pager -n 50' || true
|
|
||||||
echo "--- listening ports ---"
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail ss -tlnp' || true
|
|
||||||
echo "--- chatmail.ini ---"
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail cat /etc/chatmail/chatmail.ini' || true
|
|
||||||
exit 1
|
|
||||||
|
|
||||||
- name: show container state
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
echo "--- listening ports ---"
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail ss -tlnp'
|
|
||||||
echo "--- chatmail.ini ---"
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail cat /etc/chatmail/chatmail.ini'
|
|
||||||
|
|
||||||
- name: Docker integration tests
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail cmdeploy test --slow --ssh-host @local'
|
|
||||||
|
|
||||||
- name: Docker DNS
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: |
|
|
||||||
# Reset zone file in case bare DNS already appended to it
|
|
||||||
git checkout .github/workflows/staging.testrun.org-default.zone
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail chown opendkim:opendkim -R /etc/dkimkeys'
|
|
||||||
ssh root@staging2.testrun.org 'docker exec chatmail cmdeploy dns --ssh-host @local --zonefile /opt/chatmail/staging.zone --verbose'
|
|
||||||
ssh root@staging2.testrun.org 'docker cp chatmail:/opt/chatmail/staging.zone /tmp/staging.zone'
|
|
||||||
scp root@staging2.testrun.org:/tmp/staging.zone staging-generated.zone
|
|
||||||
cat staging-generated.zone >> .github/workflows/staging.testrun.org-default.zone
|
|
||||||
cat .github/workflows/staging.testrun.org-default.zone
|
|
||||||
scp .github/workflows/staging.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging2.testrun.org.zone
|
|
||||||
ssh root@ns.testrun.org nsd-checkzone staging2.testrun.org /etc/nsd/staging2.testrun.org.zone
|
|
||||||
ssh root@ns.testrun.org systemctl reload nsd
|
|
||||||
|
|
||||||
- name: Docker final DNS check
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: ssh root@staging2.testrun.org 'docker exec chatmail cmdeploy dns -v --ssh-host @local'
|
|
||||||
|
|
||||||
# --- Cleanup ---
|
|
||||||
|
|
||||||
- name: add SSH keys
|
|
||||||
if: >-
|
|
||||||
!cancelled()
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: ssh root@staging2.testrun.org 'curl -s https://github.com/hpk42.keys https://github.com/j4n.keys >> .ssh/authorized_keys'
|
|
||||||
|
|||||||
6
.gitignore
vendored
6
.gitignore
vendored
@@ -164,9 +164,3 @@ cython_debug/
|
|||||||
#.idea/
|
#.idea/
|
||||||
|
|
||||||
chatmail.zone
|
chatmail.zone
|
||||||
|
|
||||||
# docker
|
|
||||||
/data/
|
|
||||||
/custom/
|
|
||||||
docker/docker-compose.override.yaml
|
|
||||||
docker/.env
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import ipaddress
|
||||||
import os
|
import os
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
@@ -20,7 +21,10 @@ def read_config(inipath):
|
|||||||
class Config:
|
class Config:
|
||||||
def __init__(self, inipath, params):
|
def __init__(self, inipath, params):
|
||||||
self._inipath = inipath
|
self._inipath = inipath
|
||||||
self.mail_domain = params["mail_domain"]
|
if is_valid_ipv4(params["mail_domain"]):
|
||||||
|
self.mail_domain = f"[{params.get('mail_domain')}]"
|
||||||
|
else:
|
||||||
|
self.mail_domain = params["mail_domain"]
|
||||||
self.max_user_send_per_minute = int(params.get("max_user_send_per_minute", 60))
|
self.max_user_send_per_minute = int(params.get("max_user_send_per_minute", 60))
|
||||||
self.max_user_send_burst_size = int(params.get("max_user_send_burst_size", 10))
|
self.max_user_send_burst_size = int(params.get("max_user_send_burst_size", 10))
|
||||||
self.max_mailbox_size = params["max_mailbox_size"]
|
self.max_mailbox_size = params["max_mailbox_size"]
|
||||||
@@ -76,7 +80,7 @@ class Config:
|
|||||||
)
|
)
|
||||||
self.tls_cert_mode = "external"
|
self.tls_cert_mode = "external"
|
||||||
self.tls_cert_path, self.tls_key_path = parts
|
self.tls_cert_path, self.tls_key_path = parts
|
||||||
elif self.mail_domain.startswith("_"):
|
elif self.mail_domain.startswith("_") or is_valid_ipv4(params["mail_domain"]):
|
||||||
self.tls_cert_mode = "self"
|
self.tls_cert_mode = "self"
|
||||||
self.tls_cert_path = "/etc/ssl/certs/mailserver.pem"
|
self.tls_cert_path = "/etc/ssl/certs/mailserver.pem"
|
||||||
self.tls_key_path = "/etc/ssl/private/mailserver.key"
|
self.tls_key_path = "/etc/ssl/private/mailserver.key"
|
||||||
@@ -157,3 +161,12 @@ def get_default_config_content(mail_domain, **overrides):
|
|||||||
lines.append(line)
|
lines.append(line)
|
||||||
content = "\n".join(lines)
|
content = "\n".join(lines)
|
||||||
return content
|
return content
|
||||||
|
|
||||||
|
|
||||||
|
def is_valid_ipv4(address: str) -> bool:
|
||||||
|
"""Check if a mail_domain is an IPv4 address."""
|
||||||
|
try:
|
||||||
|
ipaddress.IPv4Address(address)
|
||||||
|
return True
|
||||||
|
except ValueError:
|
||||||
|
return False
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import secrets
|
|||||||
import string
|
import string
|
||||||
from urllib.parse import quote
|
from urllib.parse import quote
|
||||||
|
|
||||||
from chatmaild.config import Config, read_config
|
from chatmaild.config import Config, is_valid_ipv4, read_config
|
||||||
|
|
||||||
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
||||||
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
||||||
@@ -31,7 +31,15 @@ def create_dclogin_url(email, password):
|
|||||||
Uses ic=3 (AcceptInvalidCertificates) so chatmail clients
|
Uses ic=3 (AcceptInvalidCertificates) so chatmail clients
|
||||||
can connect to servers with self-signed TLS certificates.
|
can connect to servers with self-signed TLS certificates.
|
||||||
"""
|
"""
|
||||||
return f"dclogin:{quote(email, safe='@')}?p={quote(password, safe='')}&v=1&ic=3"
|
domain = email.split("@")[-1]
|
||||||
|
domain_without_brackets = domain.strip("[").strip("]")
|
||||||
|
if is_valid_ipv4(domain_without_brackets):
|
||||||
|
imap_host = "&ih=" + domain_without_brackets
|
||||||
|
smtp_host = "&sh=" + domain_without_brackets
|
||||||
|
else:
|
||||||
|
imap_host = ""
|
||||||
|
smtp_host = ""
|
||||||
|
return f"dclogin:{quote(email, safe='@[]')}?p={quote(password, safe='')}&v=1{imap_host}{smtp_host}&ic=3"
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
def print_new_account():
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
import io
|
import io
|
||||||
import os
|
import os
|
||||||
from contextlib import contextmanager
|
|
||||||
|
|
||||||
from pyinfra.operations import files, server, systemd
|
from pyinfra.operations import files, server, systemd
|
||||||
|
|
||||||
@@ -11,28 +10,6 @@ def has_systemd():
|
|||||||
return os.path.isdir("/run/systemd/system")
|
return os.path.isdir("/run/systemd/system")
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def blocked_service_startup():
|
|
||||||
"""Prevent services from auto-starting during package installation.
|
|
||||||
|
|
||||||
Installs a ``/usr/sbin/policy-rc.d`` that exits 101, blocking any
|
|
||||||
service from being started by the package manager. This avoids bind
|
|
||||||
conflicts and CPU/RAM spikes during initial setup. The file is removed
|
|
||||||
when the context exits.
|
|
||||||
"""
|
|
||||||
# For documentation about policy-rc.d, see:
|
|
||||||
# https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt
|
|
||||||
files.put(
|
|
||||||
src=get_resource("policy-rc.d"),
|
|
||||||
dest="/usr/sbin/policy-rc.d",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
yield
|
|
||||||
files.file("/usr/sbin/policy-rc.d", present=False)
|
|
||||||
|
|
||||||
|
|
||||||
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)
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import sys
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import pyinfra
|
import pyinfra
|
||||||
from chatmaild.config import read_config, write_initial_config
|
from chatmaild.config import read_config, write_initial_config, is_valid_ipv4
|
||||||
from packaging import version
|
from packaging import version
|
||||||
from termcolor import colored
|
from termcolor import colored
|
||||||
|
|
||||||
@@ -87,11 +87,11 @@ def run_cmd_options(parser):
|
|||||||
def run_cmd(args, out):
|
def run_cmd(args, out):
|
||||||
"""Deploy chatmail services on the remote server."""
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
|
||||||
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain.strip("[").strip("]")
|
||||||
sshexec = get_sshexec(ssh_host)
|
sshexec = get_sshexec(ssh_host)
|
||||||
require_iroh = args.config.enable_iroh_relay
|
require_iroh = args.config.enable_iroh_relay
|
||||||
strict_tls = args.config.tls_cert_mode == "acme"
|
strict_tls = args.config.tls_cert_mode == "acme"
|
||||||
if not args.dns_check_disabled:
|
if not args.dns_check_disabled and not is_valid_ipv4(args.config.mail_domain.strip("[").strip("]")):
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
||||||
if not dns.check_initial_remote_data(remote_data, strict_tls=strict_tls, print=out.red):
|
if not dns.check_initial_remote_data(remote_data, strict_tls=strict_tls, print=out.red):
|
||||||
return 1
|
return 1
|
||||||
@@ -101,14 +101,17 @@ 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:
|
if not args.dns_check_disabled and not is_valid_ipv4(args.config.mail_domain.strip("[").strip("]")):
|
||||||
env["CHATMAIL_ADDR_V4"] = remote_data.get("A") or ""
|
env["CHATMAIL_ADDR_V4"] = remote_data.get("A") or ""
|
||||||
env["CHATMAIL_ADDR_V6"] = remote_data.get("AAAA") 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 == "localhost":
|
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"):
|
||||||
@@ -313,7 +316,7 @@ def add_ssh_host_option(parser):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--ssh-host",
|
"--ssh-host",
|
||||||
dest="ssh_host",
|
dest="ssh_host",
|
||||||
help="Run commands on 'localhost' or on a specific SSH host "
|
help="Run commands on 'localhost', via '@docker', or on a specific SSH host "
|
||||||
"instead of chatmail.ini's mail_domain.",
|
"instead of chatmail.ini's mail_domain.",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -375,7 +378,9 @@ def get_parser():
|
|||||||
|
|
||||||
def get_sshexec(ssh_host: str, verbose=True):
|
def get_sshexec(ssh_host: str, verbose=True):
|
||||||
if ssh_host in ["localhost", "@local"]:
|
if ssh_host in ["localhost", "@local"]:
|
||||||
return LocalExec(verbose)
|
return LocalExec(verbose, docker=False)
|
||||||
|
elif ssh_host == "@docker":
|
||||||
|
return LocalExec(verbose, docker=True)
|
||||||
if verbose:
|
if verbose:
|
||||||
print(f"[ssh] login to {ssh_host}")
|
print(f"[ssh] login to {ssh_host}")
|
||||||
return SSHExec(ssh_host, verbose=verbose)
|
return SSHExec(ssh_host, verbose=verbose)
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
Chat Mail pyinfra deploy.
|
Chat Mail pyinfra deploy.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
@@ -13,7 +14,6 @@ from pyinfra import facts, host, logger
|
|||||||
from pyinfra.api import FactBase
|
from pyinfra.api import FactBase
|
||||||
from pyinfra.facts import hardware
|
from pyinfra.facts import hardware
|
||||||
from pyinfra.facts.files import Sha256File
|
from pyinfra.facts.files import Sha256File
|
||||||
from pyinfra.facts.server import Command
|
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from pyinfra.operations import apt, files, pip, server, systemd
|
from pyinfra.operations import apt, files, pip, server, systemd
|
||||||
|
|
||||||
@@ -593,7 +593,7 @@ def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -
|
|||||||
Out().red(f"Deploy failed: mtail_address {config.mtail_address} is not available (VPN up?).\n")
|
Out().red(f"Deploy failed: mtail_address {config.mtail_address} is not available (VPN up?).\n")
|
||||||
exit(1)
|
exit(1)
|
||||||
|
|
||||||
if host.get_fact(Command, "systemd-detect-virt -c || true") == "none":
|
if not os.environ.get("CHATMAIL_NOPORTCHECK"):
|
||||||
port_services = [
|
port_services = [
|
||||||
(["master", "smtpd"], 25),
|
(["master", "smtpd"], 25),
|
||||||
("unbound", 53),
|
("unbound", 53),
|
||||||
|
|||||||
@@ -1,30 +1,20 @@
|
|||||||
|
import os
|
||||||
import urllib.request
|
import urllib.request
|
||||||
|
|
||||||
from chatmaild.config import Config
|
from chatmaild.config import Config
|
||||||
from pyinfra import host
|
from pyinfra import host
|
||||||
from pyinfra.facts.deb import DebPackages
|
from pyinfra.facts.server import Arch, Sysctl
|
||||||
from pyinfra.facts.server import Arch, Command, Sysctl
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
from pyinfra.operations import apt, files, server, systemd
|
||||||
|
|
||||||
from cmdeploy.basedeploy import (
|
from cmdeploy.basedeploy import (
|
||||||
Deployer,
|
Deployer,
|
||||||
activate_remote_units,
|
activate_remote_units,
|
||||||
blocked_service_startup,
|
|
||||||
configure_remote_units,
|
configure_remote_units,
|
||||||
get_resource,
|
get_resource,
|
||||||
|
has_systemd,
|
||||||
)
|
)
|
||||||
|
|
||||||
DOVECOT_VERSION = "2.3.21+dfsg1-3"
|
|
||||||
|
|
||||||
DOVECOT_SHA256 = {
|
|
||||||
("core", "amd64"): "dd060706f52a306fa863d874717210b9fe10536c824afe1790eec247ded5b27d",
|
|
||||||
("core", "arm64"): "e7548e8a82929722e973629ecc40fcfa886894cef3db88f23535149e7f730dc9",
|
|
||||||
("imapd", "amd64"): "8d8dc6fc00bbb6cdb25d345844f41ce2f1c53f764b79a838eb2a03103eebfa86",
|
|
||||||
("imapd", "arm64"): "178fa877ddd5df9930e8308b518f4b07df10e759050725f8217a0c1fb3fd707f",
|
|
||||||
("lmtpd", "amd64"): "2f69ba5e35363de50962d42cccbfe4ed8495265044e244007d7ccddad77513ab",
|
|
||||||
("lmtpd", "arm64"): "89f52fb36524f5877a177dff4a713ba771fd3f91f22ed0af7238d495e143b38f",
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class DovecotDeployer(Deployer):
|
class DovecotDeployer(Deployer):
|
||||||
daemon_reload = False
|
daemon_reload = False
|
||||||
@@ -36,10 +26,11 @@ class DovecotDeployer(Deployer):
|
|||||||
|
|
||||||
def install(self):
|
def install(self):
|
||||||
arch = host.get_fact(Arch)
|
arch = host.get_fact(Arch)
|
||||||
with blocked_service_startup():
|
if has_systemd() and "dovecot.service" in host.get_fact(SystemdEnabled):
|
||||||
_install_dovecot_package("core", arch)
|
return # already installed and running
|
||||||
_install_dovecot_package("imapd", arch)
|
_install_dovecot_package("core", arch)
|
||||||
_install_dovecot_package("lmtpd", arch)
|
_install_dovecot_package("imapd", 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)
|
||||||
@@ -75,33 +66,37 @@ def _pick_url(primary, fallback):
|
|||||||
def _install_dovecot_package(package: str, arch: str):
|
def _install_dovecot_package(package: str, arch: str):
|
||||||
arch = "amd64" if arch == "x86_64" else arch
|
arch = "amd64" if arch == "x86_64" else arch
|
||||||
arch = "arm64" if arch == "aarch64" else arch
|
arch = "arm64" if arch == "aarch64" else arch
|
||||||
|
primary_url = f"https://download.delta.chat/dovecot/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
||||||
pkg_name = f"dovecot-{package}"
|
fallback_url = f"https://github.com/chatmail/dovecot/releases/download/upstream%2F2.3.21%2Bdfsg1/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
||||||
sha256 = DOVECOT_SHA256.get((package, arch))
|
|
||||||
if sha256 is None:
|
|
||||||
apt.packages(packages=[pkg_name])
|
|
||||||
return
|
|
||||||
|
|
||||||
installed_versions = host.get_fact(DebPackages).get(pkg_name, [])
|
|
||||||
if DOVECOT_VERSION in installed_versions:
|
|
||||||
return
|
|
||||||
|
|
||||||
url_version = DOVECOT_VERSION.replace("+", "%2B")
|
|
||||||
deb_base = f"{pkg_name}_{url_version}_{arch}.deb"
|
|
||||||
primary_url = f"https://download.delta.chat/dovecot/{deb_base}"
|
|
||||||
fallback_url = f"https://github.com/chatmail/dovecot/releases/download/upstream%2F{url_version}/{deb_base}"
|
|
||||||
url = _pick_url(primary_url, fallback_url)
|
url = _pick_url(primary_url, fallback_url)
|
||||||
deb_filename = f"/root/{deb_base}"
|
deb_filename = "/root/" + url.split("/")[-1]
|
||||||
|
|
||||||
|
match (package, arch):
|
||||||
|
case ("core", "amd64"):
|
||||||
|
sha256 = "dd060706f52a306fa863d874717210b9fe10536c824afe1790eec247ded5b27d"
|
||||||
|
case ("core", "arm64"):
|
||||||
|
sha256 = "e7548e8a82929722e973629ecc40fcfa886894cef3db88f23535149e7f730dc9"
|
||||||
|
case ("imapd", "amd64"):
|
||||||
|
sha256 = "8d8dc6fc00bbb6cdb25d345844f41ce2f1c53f764b79a838eb2a03103eebfa86"
|
||||||
|
case ("imapd", "arm64"):
|
||||||
|
sha256 = "178fa877ddd5df9930e8308b518f4b07df10e759050725f8217a0c1fb3fd707f"
|
||||||
|
case ("lmtpd", "amd64"):
|
||||||
|
sha256 = "2f69ba5e35363de50962d42cccbfe4ed8495265044e244007d7ccddad77513ab"
|
||||||
|
case ("lmtpd", "arm64"):
|
||||||
|
sha256 = "89f52fb36524f5877a177dff4a713ba771fd3f91f22ed0af7238d495e143b38f"
|
||||||
|
case _:
|
||||||
|
apt.packages(packages=[f"dovecot-{package}"])
|
||||||
|
return
|
||||||
|
|
||||||
files.download(
|
files.download(
|
||||||
name=f"Download {pkg_name}",
|
name=f"Download dovecot-{package}",
|
||||||
src=url,
|
src=url,
|
||||||
dest=deb_filename,
|
dest=deb_filename,
|
||||||
sha256sum=sha256,
|
sha256sum=sha256,
|
||||||
cache_time=60 * 60 * 24 * 365 * 10, # never redownload the package
|
cache_time=60 * 60 * 24 * 365 * 10, # never redownload the package
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.deb(name=f"Install {pkg_name}", src=deb_filename)
|
apt.deb(name=f"Install dovecot-{package}", src=deb_filename)
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
|
def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
|
||||||
@@ -139,25 +134,19 @@ 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
|
||||||
can_modify = host.get_fact(Command, "systemd-detect-virt -c || true") == "none"
|
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}"
|
||||||
value = host.get_fact(Sysctl)[key]
|
if host.get_fact(Sysctl)[key] > 65535:
|
||||||
if value > 65534:
|
# Skip updating limits if already sufficient
|
||||||
continue
|
# (enables running in incus containers where sysctl readonly)
|
||||||
if not can_modify:
|
continue
|
||||||
print(
|
server.sysctl(
|
||||||
"\n!!!! refusing to attempt sysctl setting in shared-kernel containers\n"
|
name=f"Change {key}",
|
||||||
f"!!!! dovecot: sysctl {key!r}={value}, should be >65534 for production setups\n"
|
key=key,
|
||||||
"!!!!"
|
value=65535,
|
||||||
|
persist=True,
|
||||||
)
|
)
|
||||||
continue
|
|
||||||
server.sysctl(
|
|
||||||
name=f"Change {key}",
|
|
||||||
key=key,
|
|
||||||
value=65535,
|
|
||||||
persist=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
timezone_env = files.line(
|
timezone_env = files.line(
|
||||||
name="Set TZ environment variable",
|
name="Set TZ environment variable",
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ listen = 0.0.0.0
|
|||||||
protocols = imap lmtp
|
protocols = imap lmtp
|
||||||
|
|
||||||
auth_mechanisms = plain
|
auth_mechanisms = plain
|
||||||
|
auth_username_chars = abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@[]
|
||||||
|
|
||||||
{% if debug == true %}
|
{% if debug == true %}
|
||||||
auth_verbose = yes
|
auth_verbose = 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.6.0/filtermail-{arch}"
|
url = f"https://github.com/chatmail/filtermail/releases/download/v0.5.2/filtermail-{arch}"
|
||||||
sha256sum = {
|
sha256sum = {
|
||||||
"x86_64": "3fd8b18282252c75a5bbfa603d8c1b65f6563e5e920bddf3e64e451b7cdb43ce",
|
"x86_64": "ce24ca0075aa445510291d775fb3aea8f4411818c7b885ae51a0fe18c5f789ce",
|
||||||
"aarch64": "2bd191de205f7fd60158dd8e3516ab7e3efb14627696f3d7dc186bdcd9e10a43",
|
"aarch64": "c5d783eefa5332db3d97a0e6a23917d72849e3eb45da3d16ce908a9b4e5a797d",
|
||||||
}[arch]
|
}[arch]
|
||||||
self.need_restart |= files.download(
|
self.need_restart |= files.download(
|
||||||
name="Download filtermail",
|
name="Download filtermail",
|
||||||
|
|||||||
@@ -54,14 +54,15 @@ smtpd_tls_exclude_ciphers = aNULL, RC4, MD5, DES
|
|||||||
tls_preempt_cipherlist = yes
|
tls_preempt_cipherlist = yes
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
||||||
myhostname = {{ config.mail_domain }}
|
|
||||||
alias_maps = hash:/etc/aliases
|
alias_maps = hash:/etc/aliases
|
||||||
alias_database = hash:/etc/aliases
|
alias_database = hash:/etc/aliases
|
||||||
|
|
||||||
# Postfix does not deliver mail for any domain by itself.
|
# Postfix does not deliver mail for any domain by itself.
|
||||||
# Primary domain is listed in `virtual_mailbox_domains` instead
|
# Primary domain is listed in `virtual_mailbox_domains` instead
|
||||||
# and handed over to Dovecot.
|
# and handed over to Dovecot.
|
||||||
mydestination =
|
mydestination = {{ config.mail_domain }}
|
||||||
|
local_transport = lmtp:unix:private/dovecot-lmtp
|
||||||
|
local_recipient_maps =
|
||||||
|
|
||||||
relayhost =
|
relayhost =
|
||||||
{% if disable_ipv6 %}
|
{% if disable_ipv6 %}
|
||||||
@@ -88,8 +89,6 @@ inet_protocols = ipv4
|
|||||||
inet_protocols = all
|
inet_protocols = all
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
|
||||||
virtual_mailbox_domains = {{ config.mail_domain }}
|
|
||||||
lmtp_header_checks = regexp:/etc/postfix/lmtp_header_cleanup
|
lmtp_header_checks = regexp:/etc/postfix/lmtp_header_cleanup
|
||||||
|
|
||||||
mua_client_restrictions = permit_sasl_authenticated, reject
|
mua_client_restrictions = permit_sasl_authenticated, reject
|
||||||
|
|||||||
@@ -80,7 +80,9 @@ filter unix - n n - - lmtp
|
|||||||
127.0.0.1:{{ config.postfix_reinject_port }} inet n - n - 100 smtpd
|
127.0.0.1:{{ config.postfix_reinject_port }} inet n - n - 100 smtpd
|
||||||
-o syslog_name=postfix/reinject
|
-o syslog_name=postfix/reinject
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
|
{% if "[" not in config.mail_domain %}
|
||||||
-o smtpd_milters=unix:opendkim/opendkim.sock
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
|
{% endif %}
|
||||||
-o cleanup_service_name=authclean
|
-o cleanup_service_name=authclean
|
||||||
|
|
||||||
# Local SMTP server for reinjecting incoming filtered mail
|
# Local SMTP server for reinjecting incoming filtered mail
|
||||||
|
|||||||
@@ -87,8 +87,9 @@ class SSHExec:
|
|||||||
class LocalExec:
|
class LocalExec:
|
||||||
FuncError = FuncError
|
FuncError = FuncError
|
||||||
|
|
||||||
def __init__(self, verbose=False):
|
def __init__(self, verbose=False, docker=False):
|
||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
|
self.docker = docker
|
||||||
|
|
||||||
def __call__(self, call, kwargs=None, log_callback=None):
|
def __call__(self, call, kwargs=None, log_callback=None):
|
||||||
if kwargs is None:
|
if kwargs is None:
|
||||||
@@ -100,6 +101,10 @@ class LocalExec:
|
|||||||
if not title:
|
if not title:
|
||||||
title = call.__name__
|
title = call.__name__
|
||||||
where = "locally"
|
where = "locally"
|
||||||
|
if self.docker:
|
||||||
|
if call == remote.rdns.perform_initial_checks:
|
||||||
|
kwargs["pre_command"] = "docker exec chatmail "
|
||||||
|
where = "in docker"
|
||||||
if self.verbose:
|
if self.verbose:
|
||||||
print_stderr(f"Running {where}: {title}(**{kwargs})")
|
print_stderr(f"Running {where}: {title}(**{kwargs})")
|
||||||
return self(call, kwargs, log_callback=print_stderr)
|
return self(call, kwargs, log_callback=print_stderr)
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import time
|
||||||
def test_tls_imap(benchmark, imap):
|
def test_tls_imap(benchmark, imap):
|
||||||
def imap_connect():
|
def imap_connect():
|
||||||
imap.connect()
|
imap.connect()
|
||||||
|
|||||||
@@ -8,11 +8,11 @@ from chatmaild.config import read_config
|
|||||||
from cmdeploy.cmdeploy import main
|
from cmdeploy.cmdeploy import main
|
||||||
|
|
||||||
|
|
||||||
def test_init(tmp_path, maildomain):
|
def test_init(tmp_path, maildomain_sanitized):
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
main(["init", "--config", str(inipath), maildomain])
|
main(["init", "--config", str(inipath), maildomain_sanitized])
|
||||||
config = read_config(inipath)
|
config = read_config(inipath)
|
||||||
assert config.mail_domain == maildomain
|
assert config.mail_domain.strip("[").strip("]") == maildomain_sanitized
|
||||||
|
|
||||||
|
|
||||||
def test_capabilities(imap):
|
def test_capabilities(imap):
|
||||||
@@ -89,18 +89,16 @@ def test_concurrent_logins_same_account(
|
|||||||
assert login_results.get()
|
assert login_results.get()
|
||||||
|
|
||||||
|
|
||||||
def test_no_vrfy(cmfactory, chatmail_config):
|
def test_no_vrfy(chatmail_config):
|
||||||
ac = cmfactory.get_online_account()
|
|
||||||
addr = ac.get_config("addr")
|
|
||||||
domain = chatmail_config.mail_domain
|
domain = chatmail_config.mail_domain
|
||||||
|
|
||||||
s = smtplib.SMTP(domain)
|
s = smtplib.SMTP(domain.strip("[").strip("]"))
|
||||||
s.starttls()
|
s.starttls()
|
||||||
|
|
||||||
s.putcmd("vrfy", f"wrongaddress@{chatmail_config.mail_domain}")
|
s.putcmd("vrfy", f"wrongaddress@{chatmail_config.mail_domain}")
|
||||||
result = s.getreply()
|
result = s.getreply()
|
||||||
print(result)
|
print(result)
|
||||||
s.putcmd("vrfy", addr)
|
s.putcmd("vrfy", f"echo@{chatmail_config.mail_domain}")
|
||||||
result2 = s.getreply()
|
result2 = s.getreply()
|
||||||
print(result2)
|
print(result2)
|
||||||
assert result[0] == result2[0] == 252
|
assert result[0] == result2[0] == 252
|
||||||
|
|||||||
@@ -10,31 +10,31 @@ def test_gen_qr_png_data(maildomain):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.mark.filterwarnings("ignore::urllib3.exceptions.InsecureRequestWarning")
|
@pytest.mark.filterwarnings("ignore::urllib3.exceptions.InsecureRequestWarning")
|
||||||
def test_fastcgi_working(maildomain, chatmail_config):
|
def test_fastcgi_working(maildomain_sanitized, chatmail_config):
|
||||||
url = f"https://{maildomain}/new"
|
url = f"https://{maildomain_sanitized}/new"
|
||||||
print(url)
|
print(url)
|
||||||
verify = chatmail_config.tls_cert_mode == "acme"
|
verify = chatmail_config.tls_cert_mode == "acme"
|
||||||
res = requests.post(url, verify=verify)
|
res = requests.post(url, verify=verify)
|
||||||
assert maildomain in res.json().get("email")
|
assert maildomain_sanitized in res.json().get("email")
|
||||||
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.filterwarnings("ignore::urllib3.exceptions.InsecureRequestWarning")
|
@pytest.mark.filterwarnings("ignore::urllib3.exceptions.InsecureRequestWarning")
|
||||||
def test_newemail_configure(maildomain, rpc, chatmail_config):
|
def test_newemail_configure(maildomain_sanitized, rpc, chatmail_config):
|
||||||
"""Test configuring accounts by scanning a QR code works."""
|
"""Test configuring accounts by scanning a QR code works."""
|
||||||
url = f"DCACCOUNT:https://{maildomain}/new"
|
url = f"DCACCOUNT:https://{maildomain_sanitized}/new"
|
||||||
for i in range(3):
|
for i in range(3):
|
||||||
account_id = rpc.add_account()
|
account_id = rpc.add_account()
|
||||||
if chatmail_config.tls_cert_mode == "self":
|
if chatmail_config.tls_cert_mode == "self":
|
||||||
# deltachat core's rustls rejects self-signed HTTPS certs during
|
# deltachat core's rustls rejects self-signed HTTPS certs during
|
||||||
# set_config_from_qr, so fetch credentials via requests instead
|
# set_config_from_qr, so fetch credentials via requests instead
|
||||||
res = requests.post(f"https://{maildomain}/new", verify=False)
|
res = requests.post(f"https://{maildomain_sanitized}/new", verify=False)
|
||||||
data = res.json()
|
data = res.json()
|
||||||
rpc.add_or_update_transport(account_id, {
|
rpc.add_or_update_transport(account_id, {
|
||||||
"addr": data["email"],
|
"addr": data["email"],
|
||||||
"password": data["password"],
|
"password": data["password"],
|
||||||
"imapServer": maildomain,
|
"imapServer": maildomain_sanitized,
|
||||||
"smtpServer": maildomain,
|
"smtpServer": maildomain_sanitized,
|
||||||
"certificateChecks": "acceptInvalidCertificates",
|
"certificateChecks": "acceptInvalidCertificates",
|
||||||
})
|
})
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -21,6 +21,8 @@ class TestSSHExecutor:
|
|||||||
assert out == out2
|
assert out == out2
|
||||||
|
|
||||||
def test_perform_initial(self, sshexec, maildomain):
|
def test_perform_initial(self, sshexec, maildomain):
|
||||||
|
if "[" in maildomain:
|
||||||
|
pytest.skip("Relay doesn't have a domain")
|
||||||
res = sshexec(
|
res = sshexec(
|
||||||
remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain)
|
remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain)
|
||||||
)
|
)
|
||||||
@@ -131,7 +133,7 @@ def test_authenticated_from(cmsetup, maildata):
|
|||||||
|
|
||||||
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
||||||
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
||||||
domain = cmsetup.maildomain
|
domain = cmsetup.maildomain.strip("[").strip("]")
|
||||||
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
sock.settimeout(10)
|
sock.settimeout(10)
|
||||||
try:
|
try:
|
||||||
@@ -143,7 +145,7 @@ def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
|||||||
msg = maildata(
|
msg = maildata(
|
||||||
"encrypted.eml", from_addr=from_addr, to_addr=recipient.addr
|
"encrypted.eml", from_addr=from_addr, to_addr=recipient.addr
|
||||||
).as_string()
|
).as_string()
|
||||||
conn = smtplib.SMTP(cmsetup.maildomain, 25, timeout=10)
|
conn = smtplib.SMTP(cmsetup.maildomain.strip("[").strip("]"), 25, timeout=10)
|
||||||
conn.starttls()
|
conn.starttls()
|
||||||
|
|
||||||
with conn as s:
|
with conn as s:
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ import imap_tools
|
|||||||
import pytest
|
import pytest
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from cmdeploy.cmdeploy import get_sshexec
|
|
||||||
from cmdeploy.remote import rshell
|
from cmdeploy.remote import rshell
|
||||||
|
from cmdeploy.cmdeploy import get_sshexec
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -15,7 +15,7 @@ def imap_mailbox(cmfactory, ssl_context):
|
|||||||
(ac1,) = cmfactory.get_online_accounts(1)
|
(ac1,) = cmfactory.get_online_accounts(1)
|
||||||
user = ac1.get_config("addr")
|
user = ac1.get_config("addr")
|
||||||
password = ac1.get_config("mail_pw")
|
password = ac1.get_config("mail_pw")
|
||||||
host = user.split("@")[1]
|
host = user.split("@")[1].strip("[").strip("]")
|
||||||
mailbox = imap_tools.MailBox(host, ssl_context=ssl_context)
|
mailbox = imap_tools.MailBox(host, ssl_context=ssl_context)
|
||||||
mailbox.login(user, password)
|
mailbox.login(user, password)
|
||||||
mailbox.dc_ac = ac1
|
mailbox.dc_ac = ac1
|
||||||
@@ -178,7 +178,7 @@ def test_hide_senders_ip_address(cmfactory, ssl_context):
|
|||||||
chat.send_text("testing submission header cleanup")
|
chat.send_text("testing submission header cleanup")
|
||||||
user2.wait_for_incoming_msg()
|
user2.wait_for_incoming_msg()
|
||||||
addr = user2.get_config("addr")
|
addr = user2.get_config("addr")
|
||||||
host = addr.split("@")[1]
|
host = addr.split("@")[1].strip("[").strip("]")
|
||||||
pw = user2.get_config("mail_pw")
|
pw = user2.get_config("mail_pw")
|
||||||
mailbox = imap_tools.MailBox(host, ssl_context=ssl_context)
|
mailbox = imap_tools.MailBox(host, ssl_context=ssl_context)
|
||||||
mailbox.login(addr, pw)
|
mailbox.login(addr, pw)
|
||||||
|
|||||||
@@ -61,8 +61,13 @@ def maildomain(chatmail_config):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
@pytest.fixture(scope="session")
|
||||||
def sshdomain(maildomain):
|
def maildomain_sanitized(maildomain):
|
||||||
return os.environ.get("CHATMAIL_SSH", maildomain)
|
return maildomain.strip("[").strip("]")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="session")
|
||||||
|
def sshdomain(maildomain_sanitized):
|
||||||
|
return os.environ.get("CHATMAIL_SSH", maildomain_sanitized)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -75,7 +80,7 @@ def maildomain2():
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def sshdomain2(maildomain2):
|
def sshdomain2(maildomain2):
|
||||||
return os.environ.get("CHATMAIL_SSH2", maildomain2)
|
return os.environ.get("CHATMAIL_SSH2", maildomain2.strip("[").strip("]"))
|
||||||
|
|
||||||
|
|
||||||
def pytest_report_header():
|
def pytest_report_header():
|
||||||
@@ -176,14 +181,14 @@ def ssl_context(chatmail_config):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def imap(maildomain, ssl_context):
|
def imap(maildomain_sanitized, ssl_context):
|
||||||
return ImapConn(maildomain, ssl_context=ssl_context)
|
return ImapConn(maildomain_sanitized, ssl_context=ssl_context)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def make_imap_connection(maildomain, ssl_context):
|
def make_imap_connection(maildomain_sanitized, ssl_context):
|
||||||
def make_imap_connection():
|
def make_imap_connection():
|
||||||
conn = ImapConn(maildomain, ssl_context=ssl_context)
|
conn = ImapConn(maildomain_sanitized, ssl_context=ssl_context)
|
||||||
conn.connect()
|
conn.connect()
|
||||||
return conn
|
return conn
|
||||||
|
|
||||||
@@ -227,14 +232,14 @@ class ImapConn:
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def smtp(maildomain, ssl_context):
|
def smtp(maildomain_sanitized, ssl_context):
|
||||||
return SmtpConn(maildomain, ssl_context=ssl_context)
|
return SmtpConn(maildomain_sanitized, ssl_context=ssl_context)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def make_smtp_connection(maildomain, ssl_context):
|
def make_smtp_connection(maildomain_sanitized, ssl_context):
|
||||||
def make_smtp_connection():
|
def make_smtp_connection():
|
||||||
conn = SmtpConn(maildomain, ssl_context=ssl_context)
|
conn = SmtpConn(maildomain_sanitized, ssl_context=ssl_context)
|
||||||
conn.connect()
|
conn.connect()
|
||||||
return conn
|
return conn
|
||||||
|
|
||||||
@@ -321,8 +326,8 @@ class ChatmailACFactory:
|
|||||||
"password": password,
|
"password": password,
|
||||||
# Setting server explicitly skips requesting autoconfig XML,
|
# Setting server explicitly skips requesting autoconfig XML,
|
||||||
# see https://datatracker.ietf.org/doc/draft-ietf-mailmaint-autoconfig/
|
# see https://datatracker.ietf.org/doc/draft-ietf-mailmaint-autoconfig/
|
||||||
"imapServer": domain,
|
"imapServer": domain.strip("[").strip("]"),
|
||||||
"smtpServer": domain,
|
"smtpServer": domain.strip("[").strip("]"),
|
||||||
}
|
}
|
||||||
if self.chatmail_config.tls_cert_mode == "self":
|
if self.chatmail_config.tls_cert_mode == "self":
|
||||||
transport["certificateChecks"] = "acceptInvalidCertificates"
|
transport["certificateChecks"] = "acceptInvalidCertificates"
|
||||||
@@ -454,7 +459,7 @@ class CMSetup:
|
|||||||
|
|
||||||
class CMUser:
|
class CMUser:
|
||||||
def __init__(self, maildomain, addr, password, ssl_context=None):
|
def __init__(self, maildomain, addr, password, ssl_context=None):
|
||||||
self.maildomain = maildomain
|
self.maildomain = maildomain.strip("[").strip("]")
|
||||||
self.addr = addr
|
self.addr = addr
|
||||||
self.password = password
|
self.password = password
|
||||||
self.ssl_context = ssl_context
|
self.ssl_context = ssl_context
|
||||||
|
|||||||
@@ -1,264 +0,0 @@
|
|||||||
Docker installation
|
|
||||||
===================
|
|
||||||
|
|
||||||
This section provides instructions for installing a chatmail relay
|
|
||||||
using Docker Compose.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
- Docker support is experimental, CI builds and tests the image automatically, but please report bugs.
|
|
||||||
- The image wraps the cmdeploy process detailed in the :doc:`getting_started` instructions in a Debian-systemd image with r/w access to `/sys/fs`
|
|
||||||
- Currently amd64-only (arm64 should work but is untested).
|
|
||||||
|
|
||||||
|
|
||||||
Setup Preparation
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
We use ``chat.example.org`` as the chatmail domain in the following
|
|
||||||
steps. Please substitute it with your own domain.
|
|
||||||
|
|
||||||
1. Install docker and docker compose v2 (check with `docker compose version`), install, e.g., on
|
|
||||||
- Debian 12 through the `official install instructions <https://docs.docker.com/engine/install/debian/#install-using-the-repository>`_
|
|
||||||
- Debian 13+ with `apt install docker docker-compose`
|
|
||||||
|
|
||||||
2. 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.
|
|
||||||
|
|
||||||
3. 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 and download the compose files::
|
|
||||||
|
|
||||||
mkdir -p /srv/chatmail-relay && cd /srv/chatmail-relay
|
|
||||||
wget https://raw.githubusercontent.com/chatmail/relay/refs/heads/main/docker/docker-compose.yaml
|
|
||||||
wget https://raw.githubusercontent.com/chatmail/relay/refs/heads/main/docker/docker-compose.override.yaml.example -O docker-compose.override.yaml
|
|
||||||
|
|
||||||
- or clone the chatmail repo and enter the docker directory::
|
|
||||||
|
|
||||||
git clone https://github.com/chatmail/relay
|
|
||||||
cd relay/docker
|
|
||||||
|
|
||||||
|
|
||||||
Customize and start
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
1. Set the fully qualified domain name of the relay::
|
|
||||||
|
|
||||||
echo 'MAIL_DOMAIN=chat.example.org' > .env
|
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
2. 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, but
|
|
||||||
you might also want to configure external TLS certificates there.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Finish install and test
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
You can test the installation with::
|
|
||||||
|
|
||||||
pip install cmping chat.example.org # or
|
|
||||||
uvx cmping chat.example.org # if you use https://docs.astral.sh/uv/
|
|
||||||
|
|
||||||
You should check and extend your DNS records for better interoperability::
|
|
||||||
|
|
||||||
# Show required DNS records
|
|
||||||
docker exec chatmail cmdeploy dns --ssh-host @local
|
|
||||||
|
|
||||||
You can check server status with::
|
|
||||||
|
|
||||||
docker exec chatmail cmdeploy status --ssh-host @local
|
|
||||||
|
|
||||||
You can run some benchmarks (can also run from any machine with cmdeploy installed)::
|
|
||||||
|
|
||||||
docker exec chatmail cmdeploy bench
|
|
||||||
|
|
||||||
You can run the test suite with::
|
|
||||||
|
|
||||||
docker exec chatmail cmdeploy test --ssh-host localhost
|
|
||||||
|
|
||||||
You can look at logs::
|
|
||||||
|
|
||||||
docker exec chatmail journalctl -fu postfix@-
|
|
||||||
|
|
||||||
|
|
||||||
Customization
|
|
||||||
-------------
|
|
||||||
|
|
||||||
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
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
If you want to go beyond simply setting the ``MAIL_DOMAIN`` in ``.env``, you
|
|
||||||
can use a regular `chatmail.ini` to give you full control.
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
External TLS certificates
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
If TLS certificates are managed outside the container (e.g. by certbot,
|
|
||||||
acmetool, or Traefik on the host), mount them into the container and set
|
|
||||||
``TLS_EXTERNAL_CERT_AND_KEY`` in ``docker-compose.override.yaml``.
|
|
||||||
Changed certificates are picked up automatically via inotify.
|
|
||||||
See the examples in the example override and :ref:`external-tls` in the getting started guide for details.
|
|
||||||
|
|
||||||
|
|
||||||
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/dkim data/certs data/mail
|
|
||||||
|
|
||||||
# DKIM keys
|
|
||||||
cp -a /etc/dkimkeys/* data/dkim/
|
|
||||||
|
|
||||||
# TLS certificates
|
|
||||||
rsync -a /var/lib/acme/ data/certs/
|
|
||||||
|
|
||||||
Note that ownership of dkim and acme is adjusted on container start.
|
|
||||||
|
|
||||||
For the mail directory::
|
|
||||||
|
|
||||||
rsync -a /home/vmail/ data/mail/
|
|
||||||
|
|
||||||
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/build.sh
|
|
||||||
|
|
||||||
The build bakes all binaries, Python packages, and the install stage
|
|
||||||
into the image. After building, only the ``docker/`` directory and a ``.env``
|
|
||||||
with ``MAIL_DOMAIN`` are needed to run the container. The `build.sh` passes the
|
|
||||||
git hash onto the docker build so it can be determined if there has been a
|
|
||||||
change that warrants a redeploy.
|
|
||||||
|
|
||||||
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
|
|
||||||
@@ -98,12 +98,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
|
||||||
|
|||||||
@@ -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 HEAD)
|
|
||||||
exec docker compose -f docker/docker-compose.yaml build "$@"
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Run container setup commands
|
|
||||||
After=multi-user.target
|
|
||||||
ConditionPathExists=/chatmail-init.sh
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=oneshot
|
|
||||||
ExecStart=/bin/bash /chatmail-init.sh
|
|
||||||
RemainAfterExit=true
|
|
||||||
WorkingDirectory=/opt/chatmail
|
|
||||||
PassEnvironment=<envs_list>
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,85 +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
|
|
||||||
|
|
||||||
# Generate DKIM keys if not mounted
|
|
||||||
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
|
|
||||||
|
|
||||||
# Create chatmail.ini, skip if mounted
|
|
||||||
mkdir -p "$(dirname "$CHATMAIL_INI")"
|
|
||||||
if [ ! -f "$CHATMAIL_INI" ]; then
|
|
||||||
$CMDEPLOY init --config "$CHATMAIL_INI" "$MAIL_DOMAIN"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Auto-detect IPv6: if the host has no IPv6 connectivity, set disable_ipv6
|
|
||||||
# in the ini so dovecot/postfix/nginx bind to IPv4 only.
|
|
||||||
# Uses network_mode:host so /proc/net/if_inet6 reflects the host's stack.
|
|
||||||
if [ ! -e /proc/net/if_inet6 ]; then
|
|
||||||
if grep -q '^disable_ipv6 = False' "$CHATMAIL_INI"; then
|
|
||||||
sed -i 's/^disable_ipv6 = False/disable_ipv6 = True/' "$CHATMAIL_INI"
|
|
||||||
echo "[INFO] IPv6 not available, set disable_ipv6 = True"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Inject external TLS paths from env var unless defined in chatmail.ini
|
|
||||||
if [ -n "${TLS_EXTERNAL_CERT_AND_KEY:-}" ]; then
|
|
||||||
if ! grep -q '^tls_external_cert_and_key' "$CHATMAIL_INI"; then
|
|
||||||
echo "tls_external_cert_and_key = $TLS_EXTERNAL_CERT_AND_KEY" >> "$CHATMAIL_INI"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Ensure mailboxes directory exists (chatmail-metadata needs it at startup,
|
|
||||||
# but Dovecot only creates it on first mail delivery)
|
|
||||||
mkdir -p "/home/vmail/mail/${MAIL_DOMAIN}"
|
|
||||||
chown vmail:vmail "/home/vmail/mail/${MAIL_DOMAIN}"
|
|
||||||
|
|
||||||
# --- Deploy fingerprint: skip cmdeploy run if nothing changed ---
|
|
||||||
# On restart with identical image+config, systemd already brings up all
|
|
||||||
# enabled services 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}"
|
|
||||||
|
|
||||||
# Skip DNS check when MAIL_DOMAIN is a bare IP address
|
|
||||||
SKIP_DNS=""
|
|
||||||
if [[ "$MAIL_DOMAIN" =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$ ]] || [[ "$MAIL_DOMAIN" =~ : ]]; then
|
|
||||||
SKIP_DNS="--skip-dns-check"
|
|
||||||
fi
|
|
||||||
$CMDEPLOY run --config "$CHATMAIL_INI" --ssh-host @local $SKIP_DNS
|
|
||||||
|
|
||||||
# Restore the build-time hash
|
|
||||||
cp /etc/chatmail-image-version /etc/chatmail-version
|
|
||||||
echo "$current_fp" > "$FINGERPRINT_FILE"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Signal success to Docker healthcheck
|
|
||||||
touch /run/chatmail-init.done
|
|
||||||
|
|
||||||
# Forward journald to console so `docker compose logs` works
|
|
||||||
grep -q '^ForwardToConsole=yes' /etc/systemd/journald.conf \
|
|
||||||
|| echo "ForwardToConsole=yes" >> /etc/systemd/journald.conf
|
|
||||||
systemctl restart systemd-journald
|
|
||||||
@@ -1,108 +0,0 @@
|
|||||||
# syntax=docker/dockerfile:1
|
|
||||||
FROM jrei/systemd-debian:12 AS base
|
|
||||||
|
|
||||||
ENV LANG=en_US.UTF-8
|
|
||||||
|
|
||||||
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
||||||
--mount=type=cache,target=/var/lib/apt/lists,sharing=locked \
|
|
||||||
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 && \
|
|
||||||
DEBIAN_FRONTEND=noninteractive TZ=UTC \
|
|
||||||
apt-get install -y \
|
|
||||||
ca-certificates \
|
|
||||||
gcc \
|
|
||||||
git \
|
|
||||||
python3 \
|
|
||||||
python3-dev \
|
|
||||||
python3-venv \
|
|
||||||
tzdata \
|
|
||||||
locales && \
|
|
||||||
sed -i -e "s/# $LANG.*/$LANG UTF-8/" /etc/locale.gen && \
|
|
||||||
dpkg-reconfigure --frontend=noninteractive locales && \
|
|
||||||
update-locale LANG=$LANG
|
|
||||||
|
|
||||||
# --- 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 dependency metadata first so pip install layer is cached
|
|
||||||
COPY cmdeploy/pyproject.toml /opt/chatmail/cmdeploy/pyproject.toml
|
|
||||||
COPY chatmaild/pyproject.toml /opt/chatmail/chatmaild/pyproject.toml
|
|
||||||
|
|
||||||
# Dummy scaffolding so editable install can discover packages
|
|
||||||
RUN mkdir -p /opt/chatmail/cmdeploy/src/cmdeploy \
|
|
||||||
/opt/chatmail/chatmaild/src/chatmaild && \
|
|
||||||
touch /opt/chatmail/cmdeploy/src/cmdeploy/__init__.py \
|
|
||||||
/opt/chatmail/chatmaild/src/chatmaild/__init__.py
|
|
||||||
|
|
||||||
# Dummy git repo: .git/ is excluded from the build context (.dockerignore)
|
|
||||||
# but setuptools calls `git ls-files` when building the sdist.
|
|
||||||
WORKDIR /opt/chatmail
|
|
||||||
RUN --mount=type=cache,target=/root/.cache/pip \
|
|
||||||
git init -q && \
|
|
||||||
python3 -m venv /opt/cmdeploy && \
|
|
||||||
/opt/cmdeploy/bin/pip install -e chatmaild/ -e cmdeploy/
|
|
||||||
|
|
||||||
# Full source copy (editable install's .egg-link still points here)
|
|
||||||
COPY . /opt/chatmail/
|
|
||||||
|
|
||||||
# Minimal chatmail.ini
|
|
||||||
RUN printf '[params]\nmail_domain = build.local\n' > /tmp/chatmail.ini
|
|
||||||
|
|
||||||
RUN CMDEPLOY_STAGES=install \
|
|
||||||
CHATMAIL_INI=/tmp/chatmail.ini \
|
|
||||||
/opt/cmdeploy/bin/pyinfra @local \
|
|
||||||
/opt/chatmail/cmdeploy/src/cmdeploy/run.py -y
|
|
||||||
|
|
||||||
RUN cp -a www/ /opt/chatmail-www/
|
|
||||||
|
|
||||||
# Remove build-only packages — not needed at runtime.
|
|
||||||
# Keep git: test_deployed_state needs `git rev-parse HEAD` to verify the
|
|
||||||
# deployed version hash matches /etc/chatmail-version.
|
|
||||||
RUN apt-get purge -y gcc python3-dev && \
|
|
||||||
apt-get autoremove -y && \
|
|
||||||
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.
|
|
||||||
# Two files: chatmail-image-version is the immutable build hash (survives
|
|
||||||
# deploys); chatmail-version is overwritten by cmdeploy run and restored
|
|
||||||
# from the image version after each deploy in chatmail-init.sh.
|
|
||||||
ARG GIT_HASH=unknown
|
|
||||||
RUN echo "$GIT_HASH" > /etc/chatmail-image-version && \
|
|
||||||
echo "$GIT_HASH" > /etc/chatmail-version
|
|
||||||
|
|
||||||
# Mock git HEAD so `git rev-parse HEAD` returns the source repo's commit hash.
|
|
||||||
# The .git/ dir was created by `git init` earlier (for setuptools); we just
|
|
||||||
# write the build hash into whatever branch HEAD points to.
|
|
||||||
RUN head_ref=$(sed 's/^ref: //' /opt/chatmail/.git/HEAD) && \
|
|
||||||
mkdir -p "/opt/chatmail/.git/$(dirname "$head_ref")" && \
|
|
||||||
echo "$GIT_HASH" > "/opt/chatmail/.git/$head_ref"
|
|
||||||
# --- End build-time install ---
|
|
||||||
|
|
||||||
ENV TZ=:/etc/localtime
|
|
||||||
ENV PATH="/opt/cmdeploy/bin:${PATH}"
|
|
||||||
RUN ln -s /etc/chatmail/chatmail.ini /opt/chatmail/chatmail.ini
|
|
||||||
|
|
||||||
ARG CHATMAIL_INIT_SERVICE_PATH=/lib/systemd/system/chatmail-init.service
|
|
||||||
COPY ./docker/chatmail-init.service "$CHATMAIL_INIT_SERVICE_PATH"
|
|
||||||
RUN ln -sf "$CHATMAIL_INIT_SERVICE_PATH" "/etc/systemd/system/multi-user.target.wants/chatmail-init.service"
|
|
||||||
|
|
||||||
# Remove default nginx site config at build time (not in entrypoint)
|
|
||||||
RUN rm -f /etc/nginx/sites-enabled/default
|
|
||||||
|
|
||||||
COPY --chmod=555 ./docker/chatmail-init.sh /chatmail-init.sh
|
|
||||||
COPY --chmod=555 ./docker/entrypoint.sh /entrypoint.sh
|
|
||||||
COPY --chmod=555 ./docker/healthcheck.sh /healthcheck.sh
|
|
||||||
|
|
||||||
HEALTHCHECK --interval=10s --start-period=180s --timeout=10s --retries=3 \
|
|
||||||
CMD /healthcheck.sh
|
|
||||||
|
|
||||||
STOPSIGNAL SIGRTMIN+3
|
|
||||||
|
|
||||||
ENTRYPOINT ["/entrypoint.sh"]
|
|
||||||
|
|
||||||
CMD [ "--default-standard-output=journal+console", \
|
|
||||||
"--default-standard-error=journal+console" ]
|
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
# Traefik reverse-proxy example — use as a compose override:
|
|
||||||
#
|
|
||||||
# docker compose -f docker-compose.yaml -f docker-compose-traefik.yaml up -d
|
|
||||||
#
|
|
||||||
# Traefik handles HTTP→HTTPS redirect and ACME certificate issuance.
|
|
||||||
# traefik-certs-dumper extracts the certificates to the filesystem so
|
|
||||||
# chatmail's Postfix/Dovecot/nginx can use them via TLS_EXTERNAL_CERT_AND_KEY.
|
|
||||||
#
|
|
||||||
# Prerequisites:
|
|
||||||
# mkdir -p traefik/data traefik/dynamic-configs
|
|
||||||
# touch traefik/data/acme.json && chmod 600 traefik/data/acme.json
|
|
||||||
# cp traefik/config.yaml.example traefik/config.yaml # see below
|
|
||||||
#
|
|
||||||
# Required .env variables (in addition to MAIL_DOMAIN):
|
|
||||||
# ACME_EMAIL=admin@example.org
|
|
||||||
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
environment:
|
|
||||||
# Point chatmail at the certs dumped by traefik-certs-dumper.
|
|
||||||
# The container's tls-cert-reload.path watches for changes.
|
|
||||||
TLS_EXTERNAL_CERT_AND_KEY: >-
|
|
||||||
/traefik-certs/${MAIL_DOMAIN}/certificate.crt
|
|
||||||
/traefik-certs/${MAIL_DOMAIN}/privatekey.key
|
|
||||||
volumes:
|
|
||||||
- traefik-certs:/traefik-certs:ro
|
|
||||||
depends_on:
|
|
||||||
- traefik-certs-dumper
|
|
||||||
labels:
|
|
||||||
- traefik.enable=true
|
|
||||||
- traefik.http.services.chatmail.loadbalancer.server.scheme=https
|
|
||||||
- traefik.http.services.chatmail.loadbalancer.server.port=443
|
|
||||||
- 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
|
|
||||||
network_mode: host
|
|
||||||
command:
|
|
||||||
- "--configFile=/config.yaml"
|
|
||||||
- "--certificatesresolvers.letsEncrypt.acme.email=${ACME_EMAIL}"
|
|
||||||
volumes:
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
||||||
- ./traefik/config.yaml:/config.yaml:ro
|
|
||||||
- ./traefik/data/acme.json:/acme.json
|
|
||||||
- ./traefik/dynamic-configs:/dynamic/conf:ro
|
|
||||||
|
|
||||||
traefik-certs-dumper:
|
|
||||||
image: ldez/traefik-certs-dumper:v2.10.0
|
|
||||||
restart: unless-stopped
|
|
||||||
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'
|
|
||||||
volumes:
|
|
||||||
- ./traefik/data/acme.json:/data/acme.json:ro
|
|
||||||
- traefik-certs:/certs
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
traefik-certs:
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# Used by .github/workflows/docker-ci.yaml
|
|
||||||
# The GHCR image is set via CHATMAIL_IMAGE env var at deploy time.
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
image: ${CHATMAIL_IMAGE:-chatmail-relay:latest}
|
|
||||||
volumes:
|
|
||||||
- /srv/chatmail/chatmail.ini:/etc/chatmail/chatmail.ini
|
|
||||||
- /srv/chatmail/dkim:/etc/dkimkeys
|
|
||||||
- /srv/chatmail/certs:/var/lib/acme
|
|
||||||
environment:
|
|
||||||
TLS_EXTERNAL_CERT_AND_KEY: /var/lib/acme/live/${MAIL_DOMAIN}/fullchain /var/lib/acme/live/${MAIL_DOMAIN}/privkey
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
# Local overrides: copy to docker-compose.override.yaml in this directory.
|
|
||||||
# Compose automatically merges this with docker-compose.yaml.
|
|
||||||
#
|
|
||||||
# cp docker-compose.override.yaml.example docker-compose.override.yaml
|
|
||||||
#
|
|
||||||
# Volumes are APPENDED to the base file's volumes list, environment and other scalar keys are MERGED by key.
|
|
||||||
services:
|
|
||||||
chatmail:
|
|
||||||
volumes:
|
|
||||||
## Data paths — bind-mount to host directories for easy access/backup.
|
|
||||||
|
|
||||||
# - ./data/dkim:/etc/dkimkeys
|
|
||||||
# - ./data/certs:/var/lib/acme
|
|
||||||
|
|
||||||
# - ./data/mail:/home/vmail
|
|
||||||
## Or mount from an existing bare-metal install.
|
|
||||||
# - /home/vmail:/home/vmail
|
|
||||||
|
|
||||||
## Mount your own chatmail.ini (skips auto-generation):
|
|
||||||
# - ./chatmail.ini:/etc/chatmail/chatmail.ini
|
|
||||||
|
|
||||||
## Custom website:
|
|
||||||
# - ./custom/www:/opt/chatmail-www
|
|
||||||
|
|
||||||
## Debug — mount scripts for live editing:
|
|
||||||
# - ./chatmail-init.sh:/chatmail-init.sh
|
|
||||||
# - ./entrypoint.sh:/entrypoint.sh
|
|
||||||
|
|
||||||
# environment:
|
|
||||||
## Mount certs (above) and set TLS_EXTERNAL_CERT_AND_KEY to in-container paths.
|
|
||||||
## A tls-cert-reload.path watcher inside the container reloads services
|
|
||||||
## when the cert file changes. However, inotify does not cross bind-mount
|
|
||||||
## boundaries, so host-side renewals (certbot, acmetool, etc.) must
|
|
||||||
## notify the container explicitly. Add this to your renewal hook:
|
|
||||||
##
|
|
||||||
## docker exec chatmail systemctl start tls-cert-reload.service
|
|
||||||
##
|
|
||||||
## Host acmetool (bare-metal migration): create mount above, and
|
|
||||||
## rsync -a /var/lib/acme/live data/certs
|
|
||||||
# TLS_EXTERNAL_CERT_AND_KEY: "/var/lib/acme/live/${MAIL_DOMAIN}/fullchain /var/lib/acme/live/${MAIL_DOMAIN}/privkey"
|
|
||||||
##
|
|
||||||
## (Untested) Traefik certs-dumper (see docker/docker-compose-traefik.yaml) - also add volume:
|
|
||||||
## - traefik-certs:/certs:ro
|
|
||||||
# TLS_EXTERNAL_CERT_AND_KEY: "/certs/${MAIL_DOMAIN}/certificate.crt /certs/${MAIL_DOMAIN}/privatekey.key"
|
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
# Base compose file — do not edit. Put customizations (data paths, extra
|
|
||||||
# volumes, env overrides) in docker-compose.override.yaml instead.
|
|
||||||
# See docker-compose.override.yaml.example in this directory for a starting point.
|
|
||||||
#
|
|
||||||
# Security notes: this container uses
|
|
||||||
# - network_mode:host chatmail needs many ports (25, 53, 80, 143, 443, 465,
|
|
||||||
# 587, 993, 3340, 8443) and needs to operate from the real IP, which bridging
|
|
||||||
# would make tricky
|
|
||||||
# - 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
|
|
||||||
# privileged: true # compose v1 (less restricted)
|
|
||||||
tty: true # required for logs
|
|
||||||
tmpfs: # required for systemd
|
|
||||||
- /tmp
|
|
||||||
- /run
|
|
||||||
- /run/lock
|
|
||||||
logging:
|
|
||||||
driver: none
|
|
||||||
environment:
|
|
||||||
MAIL_DOMAIN: $MAIL_DOMAIN
|
|
||||||
network_mode: "host"
|
|
||||||
volumes:
|
|
||||||
## system (required)
|
|
||||||
- /sys/fs/cgroup:/sys/fs/cgroup:rw
|
|
||||||
## data (defaults — override in docker-compose.override.yaml)
|
|
||||||
- mail:/home/vmail
|
|
||||||
- dkim:/etc/dkimkeys
|
|
||||||
- certs:/var/lib/acme
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
mail:
|
|
||||||
dkim:
|
|
||||||
certs:
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
set -eo pipefail
|
|
||||||
|
|
||||||
CHATMAIL_INIT_SERVICE_PATH="${CHATMAIL_INIT_SERVICE_PATH:-/lib/systemd/system/chatmail-init.service}"
|
|
||||||
|
|
||||||
env_vars="MAIL_DOMAIN CMDEPLOY_STAGES CHATMAIL_INI TLS_EXTERNAL_CERT_AND_KEY PATH"
|
|
||||||
sed -i "s|<envs_list>|$env_vars|g" "$CHATMAIL_INIT_SERVICE_PATH"
|
|
||||||
|
|
||||||
exec /lib/systemd/systemd "$@"
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
MAIL_DOMAIN=chat.example.com
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# returns 0 when chatmail-init succeeded and all expected services are running.
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
test -f /run/chatmail-init.done
|
|
||||||
|
|
||||||
# Core services
|
|
||||||
services="chatmail-metadata doveauth dovecot filtermail filtermail-incoming nginx postfix unbound"
|
|
||||||
|
|
||||||
# Optional services
|
|
||||||
for svc in iroh-relay turnserver; do
|
|
||||||
systemctl is-enabled "$svc" 2>/dev/null && services="$services $svc"
|
|
||||||
done
|
|
||||||
|
|
||||||
exec systemctl is-active $services
|
|
||||||
Reference in New Issue
Block a user