progressiverobot/hmailserver repository overview

⁠hMailServer - Progressive Robot's fork

Progressive Robot's fork of hMailServer: a free, open-source mail server. SMTP for sending and receiving, IMAP and POP3 for reading, ManageSieve, with SPF, DKIM, DMARC and ARC, TLS with certificates from ACME, webmail, and a REST API with a browser-based administration page, the Control Deck. AGPL-3.0-or-later. Maintained by Progressive Robot Ltd, separately from the original hMailServer.

Source, issues, releases and documentation: https://gitlab.com/hmailserver/hmailserver⁠

⁠This repository

A copy of the image each release's pipeline builds, pushes and signs at registry.gitlab.com/hmailserver/hmailserver: the same digests, with the same cosign signatures and SBOM attestations. One index for linux/amd64 and linux/arm64.

⁠Running it

The server keeps its accounts and settings in a database: PostgreSQL, or MySQL or MariaDB. The project's Compose file runs it beside PostgreSQL 18, with the two passwords as Compose secrets and the REST API over TLS. In an empty directory:

curl -O https://gitlab.com/hmailserver/hmailserver/-/raw/v6.3.7/hmailserver/source/Server/platform/packaging/docker/docker-compose.yml
mkdir secrets certs
printf '%s' 'a database password' > secrets/db_password
printf '%s' 'the administrator password' > secrets/admin_password
openssl req -x509 -newkey ec -pkeyopt ec_paramgen_curve:P-256 -nodes \
  -keyout certs/rest.key -out certs/rest.pem -subj /CN=mail -days 365
docker compose up -d

Then https://<host>:8045/ is the Control Deck: sign in as Administrator with that password. The Compose file names registry.gitlab.com/hmailserver/hmailserver:latest; progressiverobot/hmailserver:latest is the same image.

Ports: 25 (SMTP), 587 and 465 (submission), 143 and 993 (IMAP), 110 and 995 (POP3), 4190 (ManageSieve), 8045 (the REST API, the Control Deck and the webmail). Volumes: /var/lib/hmailserver, /var/log/hmailserver, /etc/hmailserver.

• The image, the Helm chart and updates: https://gitlab.com/hmailserver/hmailserver/-/blob/master/hmailserver/docs/ContainerImage.md⁠
• Every variable the image reads: https://gitlab.com/hmailserver/hmailserver/-/blob/master/hmailserver/docs/EnvironmentConfiguration.md⁠

⁠Checking an image

With cosign 2.4 or later:

cosign verify \
  --certificate-identity https://gitlab.com/hmailserver/hmailserver//.gitlab-ci.yml@refs/tags/v6.3.7 \
  --certificate-oidc-issuer https://gitlab.com \
  progressiverobot/hmailserver:6.3.7

Each platform's image is signed as well, and its CycloneDX SBOM is attested to it: cosign verify-attestation --type cyclonedx with the same identity, by the platform's digest, which docker manifest inspect progressiverobot/hmailserver:6.3.7 lists. ContainerImage.md, "Checking an image", has every command, and how to read the project's id from the certificates.

⁠Support

Issues: https://gitlab.com/hmailserver/hmailserver/-/issues⁠. Progressive Robot Ltd: https://www.progressiverobot.com⁠