chatmail relay documentation

This documentation details how to setup, maintain and understand chatmail relays.

Contributions and feedback welcome through the https://github.com/chatmail/relay repository.

• Setting up a chatmail relay
  • Minimal requirements and prerequisites
  • Setup with scripts/cmdeploy
  • Docker installation
  • Next Steps
  • Other Helpful Commands
  • Modifying the home page
  • Refining the web pages
  • Custom web pages
  • Disable automatic address creation
  • Running a relay with self-signed certificates
  • Running a relay with externally managed certificates
• Setting up a reverse proxy
  • Linux
  • FreeBSD / pf
• Migrating the relay to a new server
  • Preliminary notes and assumptions
  • The six steps to migrate
• Migrating a local chatmail/relay repository to the server
• Technical overview
  • Directories of the relay repository
    • scripts/
    • cmdeploy/
    • chatmaild/
    • www/
  • Chatmail relay dependency diagram
  • Accepting and delivering mail
  • Operational details of a chatmail relay
    • Mailbox directory layout
    • Active ports
    • Email domain authentication (DKIM)
    • TLS requirements
  • Architecture of cmdeploy
• Configuring reverse DNS
  • Multi-homed setups
• Community developments
• Frequently asked questions
  • What is the difference between chatmail relays and classic email servers?
  • How about interoperability with classic email servers?
  • How are chatmail relays run? Can I run one myself?
  • How can I upgrade my chatmail relay?
  • How trustable are chatmail relays?
• Hosting without DNS records
  • Drawbacks
  • Email addresses