ecf425470e
1224: RFC: Mailu directory structure r=mergify[bot] a=muhlemmer ## What type of PR? RFC / design documentation ## What does this PR do? Describes a proposal to restructure the `/mailu` directories to allow for easier and more clear configuration in replicated environments. It proposes the following layout: ```` /mailu ├── config │ ├── dovecot │ ├── postfix │ ├── rainloop │ ├── redis │ ├── roundcube │ │ └── gpg │ ├── rspamd │ └── share │ ├── certs │ └── dkim ├── data │ ├── admin │ ├── rainloop │ ├── roundcube │ └── rspamd ├── local │ ├── clamav │ └── mailqueue └── mail ```` Where in replicated environments: - `/mailu/config/`: should be a small, low performant and shared filesystem. - `/mailu/data`: should be avoided. More work will need to be done to configure external DB servers for relevant services. Ideally, this directory should only exist on docker-compose deployments. - `/mailu/local/`: Should exist only on local file systems of worker nodes. - `/mailu/mail`: A distributed filesystem with sufficient performance and storage requirements to hold and process all user mailboxes. Ideally only Maildir without indexes. Co-authored-by: Tim Möhlmann <muhlemmer@gmail.com> |
3 years ago | |
|---|---|---|
| .github | 3 years ago | |
| core | 3 years ago | |
| design | 5 years ago | |
| docs | 3 years ago | |
| optional | 3 years ago | |
| setup | 3 years ago | |
| tests | 3 years ago | |
| towncrier | 3 years ago | |
| webmails | 3 years ago | |
| .gitignore | 5 years ago | |
| .mergify.yml | 3 years ago | |
| AUTHORS.md | 4 years ago | |
| CHANGELOG.md | 3 years ago | |
| CODE_OF_CONDUCT.md | 7 years ago | |
| CONTRIBUTING.md | 5 years ago | |
| ISSUE_TEMPLATE.md | 4 years ago | |
| LICENSE.md | 8 years ago | |
| PULL_REQUEST_TEMPLATE.md | 3 years ago | |
| README.md | 3 years ago | |
| bors.toml | 3 years ago | |
| pyproject.toml | 5 years ago | |
README.md
Mailu is a simple yet full-featured mail server as a set of Docker images. It is free software (both as in free beer and as in free speech), open to suggestions and external contributions. The project aims at providing people with an easily setup, easily maintained and full-featured mail server while not shipping proprietary software nor unrelated features often found in popular groupware.
Most of the documentation is available on our Website, you can also try our demo server before setting up your own, and come talk to us on Matrix.
Features
Main features include:
- Standard email server, IMAP and IMAP+, SMTP and Submission
- Advanced email features, aliases, domain aliases, custom routing
- Web access, multiple Webmails and administration interface
- User features, aliases, auto-reply, auto-forward, fetched accounts
- Admin features, global admins, announcements, per-domain delegation, quotas
- Security, enforced TLS, DANE, MTA-STS, Letsencrypt!, outgoing DKIM, anti-virus scanner
- Antispam, auto-learn, greylisting, DMARC and SPF
- Freedom, all FOSS components, no tracker included
Contributing
Mailu is free software, open to suggestions and contributions. All components are free software and compatible with the MIT license. All specific configuration files, Dockerfiles and code are placed under the MIT license.