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
  • 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
  • Migrating to a new build machine
• Setting up a reverse proxy
  • Linux
  • FreeBSD / pf
• Migrating to a new machine
  • Preliminary notes and assumptions
  • The six steps to migrate
• Technical overview
  • Directories of the relay repository
    • scripts/
    • cmdeploy/
    • chatmaild/
    • www/
  • Chatmail relay dependency diagram
  • Message between users on the same relay
  • Operational details of a chatmail relay
    • Mailbox directory layout
    • Active ports
    • Email domain authentication (DKIM)
    • TLS requirements
  • Architecture of cmdeploy
• Local testing with LXC/Incus
  • Prerequisites
  • Quick start
  • CLI reference
  • Container types
  • SSH configuration
  • .localchat DNS and name resolution
  • State outside the repository
  • TLS handling and underscore domains
  • Known limitations
• 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 trustable are chatmail relays?