Documentation index: every guide on this forum, by subject

[Progressiverobot]

Every documentation topic on this forum, by the category it sits in. Each one is written from the project's wiki and the operator documents at the release tag, for hMailServer 6.3.4, and links the pages it was written from. The long tail is in the wiki and the operator documents; the public documentation is the same material as one long page.

A question that none of these answers belongs in the category it is about, as a new topic; Read this before you post says what a support request needs.

Running hMailServer

General support

• Read this before you post: what a support request needs
• Where to post what: a map of the forum categories
• Diagnosing stalled mail: a sender that times out, and a message that never leaves
• Reading the logs: levels, files, the Logs page, following a connection, and fail2ban
• Backup and restore: what is in the archive, what is not, and restoring one mailbox
• Settings: what is not stock, when a save takes effect, and the three levels
• The Control Panel on Windows: every page, what it writes, and what applies when
• IMAP and POP3 on the server: capabilities, switches, shared mailboxes, search limits
• Troubleshooting by symptom: no mail in, no mail out, a service that will not start
• Every port hMailServer listens on or connects to, and the firewall rules to match

Installation, migration & upgrades

• Upgrading to 6.3.4: any 5.3 or later goes straight there
• Moving to new hardware, and why Windows to Linux is a rebuild
• Installing on Windows: wizard pages, service account, profile and the first hour
• Choosing a database, creating it, encrypting the link and leaving the built-in one
• Your first domain and mailbox, and the DNS records your domain needs
• Bringing mailboxes in: IMAP mirror, Google, Microsoft 365, mbox, Maildir and PST
• Unattended installs, winget and Chocolatey, and configuration from the environment
• Warm standby and high availability: what a second machine can and cannot do
• Message storage: compression, de-duplication, object storage and encryption at rest
• The update check and the live update: feed, verification, window and rollback
• Upgrading from 5.x, 6.2 or 6.3: the 24 changes without a switch, and rolling back

Linux

• hMailServer on Linux: what you get and what you do not
• First install on Linux: the order of operations, Ubuntu to Enterprise Linux
• The hmailserver command line on Linux: every verb, who runs it, the files, the unit
• In a container or on Kubernetes: the image, Compose, Helm and the environment
• Databases on Linux: PostgreSQL or MariaDB, the client, TLS and the upgrade floor

Webmail, portal & Control Deck

• The webmail portal at /portal
• The Control Deck: browser administration at /
• Calendars, contacts, the directory and shared address books over CalDAV and CardDAV
• Signing in: passwords, second factor, passkeys, single sign-on, recovery, devices
• The webmail in depth: search, offline mail, expiring messages, send-as and recovery
• Connecting a mail client: IMAP, POP3, SMTP submission, app passwords and the ports

TLS, certificates & deliverability

• Let's Encrypt certificates are automatic: the built-in ACME v2 client
• Being trusted by the servers you send to
• TLS on the listeners: your own certificate, versions, ciphers and client certificates
• Requiring TLS: MTA-STS and TLS-RPT, DANE with ACME, and remote domain policies
• DKIM rotation, DMARC and TLS reports, complaints, bounces and the reputation watch
• Outbound shaping and IP warm-up: one slow destination must not stall the queue
• End-to-end encryption: S/MIME authority, OpenPGP and WKD, zero access, sealed mail

Anti-spam & message filtering

• The anti-spam stack end to end: score, greylisting, SPF, DKIM, DMARC, DNSBL, SURBL
• Allow and block lists, digests, spam traps, country blocking and impersonation
• Viruses and dangerous attachments: ClamAV, custom scanners, the sandbox, sealed mail
• Mail flow rules, the outbound content policy and what a domain does to a message

Guides & tutorials

• Quotas, retention and the archive: how much mail the server keeps, and for how long
• Administrator roles end to end: the 27 permissions, giving a role, where each works
• How the service is built and what runs out first: pools, connections, large folders
• IP ranges, auto-ban, lockout, tarpits, sending limits, send-as and password storage
• Behind a gateway, load balancer or reverse proxy: relays, PROXY, XCLIENT and HTTPS
• Hardening a public mail server: secure defaults, checklist, sealed secrets and roles
• Compliance: eDiscovery, legal holds, personal data, erasure and the audit trail
• How email works, and what hMailServer is and is not
• Relocating an installation to another drive, and moving or renaming a mailbox

Automation & integration

Scripting & the COM API

• Event scripts: every event and its arguments, the limits, and the 6.3.4 security fix
• The COM API on Windows: object model, Save() since 6.3.4, roles and the Import Tool

REST API & integrations

• The REST API: turning it on, credentials, roles, one-time codes, OpenAPI and examples
• Active Directory and LDAP sign-in, directory synchronisation and OAuth2 bearer tokens
• hmctl and the PowerShell module: shell administration and accounts from a CSV file
• Integrating applications: the send API, mail in to a webhook, and outbound webhooks
• SCIM provisioning from Entra ID and Okta, and single sign-on for the organisation

Rules, Sieve & routing

• Rules and Sieve: what runs when, vacation replies and the Run function action
• Routes, relays and smart hosts, OAuth2 relaying, restricted delivery and recall
• Aliases, distribution lists, membership queries, mailing lists and public folders
• Journaling and dual delivery: a compliance copy, and what a journal rule does not see

Monitoring, metrics & logs

• Monitoring and health: Prometheus metrics, health probes, Grafana, OTLP and SNMPv3
• Alerts, the audit trail, syslog and the journal, and per-domain reports

Releases

The current release, its announcement and the release history are in Announcements & releases.