# Bongo documentation

This directory is the maintained documentation for the Bongo development
tree. It replaces operational advice from the archived project website where
paths, dependencies, security policy, or implementation status no longer
match the current code.

Bongo 0.7 is still under development. A feature listed here is available in
the tree, but a public server should be staged and tested before it replaces
an existing mail system. The [roadmap](roadmap.md) distinguishes completed,
partial, and planned work.

## Start here

- [Architecture](architecture.md) describes the agents and data flow.
- [Administration](administration.md) covers setup, validation, services,
  accounts, and routine checks.
- [Directory layout](directory-layout.md) lists current FHS paths.
- [Ports](ports.md) distinguishes public, private, and optional listeners.
- [Protocols](protocols.md) gives the supported protocol overview.
- [Client compatibility](client-compatibility.md) describes realistic client
  expectations.
- [Storage and backup](storage.md) explains where mail and metadata live.
- [JMAP and the Store](jmap.md) defines the future canonical object model,
  protocol mappings, and migration contract.
- [Upstream Webmail integration](webmail-upstream.md) defines the pinned
  Bulwark submodule, upstreamable patch queue, Bongo settings plugin and the
  minimum JMAP boundary required before the 0.8 Web replacement.
- [Web PWA and Push staging](web-pwa.md) separates the installable 0.8 Web
  application from the complete 0.9 JMAP/VAPID background-notification
  contract.
- [Development](development.md) covers CMake, tests, sanitizers, and timezone
  maintenance.
- [Bongo 0.7.0 release test matrix](release-testing-0.7.md) is the mandatory
  three-pass gate before the 0.7.0 tag.
- [Roadmap](roadmap.md) merges the useful historical 1.0 goals with the
  current 0.7 through 1.0 plan.

## Security and mail operation

- [Guided setup](setup-wizard.md)
- [TLS policy](tls.md)
- [Authentication, TOTP, LDAP, and app passwords](authentication.md)
- [SMTP, submission, LMTP, and trusted relay](smtp.md)
- [IMAP compatibility](imap.md)
- [POP3 and POP3S](pop3.md)
- [Sieve filtering and ManageSieve](sieve.md)
- [Webmail and user administration](web.md)
- [CalDAV and CardDAV](dav.md)
- [Queue, routing, and delivery](queue.md)
- [Mail storage quotas](quotas.md)
- [SPF, DKIM, DMARC, and SRS](mail-authentication.md)
- [SpamAssassin and ClamAV](antispam.md)
- [HAProxy PROXY protocol](proxy-protocol.md)
- [External account collection](external-accounts.md)

Installed manual pages document individual commands and agents. Begin with
`bongo-setup(1)`, `bongo-config(1)`, `bongo-admin(1)`, `bongo-manager(1)`, and
`bongoagents(8)`.

## Historical material

The archived
[Bongo project documentation](https://github.com/bongo-project/bongo-project/tree/gh-pages/Documentation)
is a provenance source for the architecture and original 1.0 product goals.
The current roadmap retains goals which are still useful, including virtual
domains, calendar sharing, internationalisation, administration, diagnostics,
and a formal security review.

Do not use the historical site as an installation manual. Its Autotools,
Python 2/mod_python, managed LDAP, filesystem, browser, and SSL instructions
are obsolete. The current implementation remains a C server with a Python 3
Web interface. Experimental Ruby rewrites are not part of the product or its
roadmap.