diff --git a/.editorconfig b/.editorconfig index 982f3953..3ee41631 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,3 +8,7 @@ trim_trailing_whitespace = true [*.{scd,go}] indent_style = tab indent_size = 4 + +[*.yml] +indent_style = tab +indent_size = 2 diff --git a/.mkdocs.yml b/.mkdocs.yml new file mode 100644 index 00000000..a7509248 --- /dev/null +++ b/.mkdocs.yml @@ -0,0 +1,29 @@ +site_name: maddy documentation + +repo_url: https://github.com/foxcpp/maddy + +theme: readthedocs + +markdown_extensions: + - codehilite: + guess_lang: false + +nav: + - README.md + - Tutorials: + - tutorials/setting-up.md + - tutorials/manual-installation.md + - get.sh.md + - Manual pages: + - man/_generated_maddy.1.md + - man/_generated_maddy-auth.5.md + - man/_generated_maddy-config.5.md + - man/_generated_maddy-filters.5.md + - man/_generated_maddy-imap.5.md + - man/_generated_maddy-smtp.5.md + - man/_generated_maddy-storage.5.md + - man/_generated_maddy-targets.5.md + - man/_generated_maddy-tls.5.md + - Internals: + - internals/quirks.md + - internals/sqlite.md diff --git a/README.md b/README.md index 5cced0ce..249d1233 100644 --- a/README.md +++ b/README.md @@ -5,30 +5,31 @@ Simple, fast, secure all-in-one mail server. **⚠️ Disclaimer: maddy is in development, many planned features are -missing, bugs are waiting to eat your messages and incompatible +missing, bugs are waiting to eat your messages and incompatible changes happen from time to time** ## Features -* Comprehensive & secure +- Comprehensive & secure - IMAP4rev1 & SMTP server in one binary - [DKIM][dkim] signing and verification - [SPF][spf] policy enforcement - [DMARC][dmarc] policy enforcement - [MTA-STS][mtasts] policy enforcement -* Simple to configure +- Simple to configure - Two steps (excluding messing with DNS) to get your own _secure_ mail server running - Virtual users > system users -* Fast +- Fast - Optimized for concurrency - Single process model allows more efficient implementation -* Useful - - [Subaddressing][subaddr] support +- Useful + - [Subaddressing][subaddr] support - [DNSBL][dnsbl] checking support - Messages compression (LZ4, Zstd) - + Planned: + - [Backscatter][backscatter] filtering (BATV) (#106) - Address aliases (#82, #18) - Zero-configuration full-text search (foxcpp/go-imap-sql#21) @@ -40,19 +41,14 @@ Planned: ## Installation & configuration Detailed explaination of what you need to do to get it running can be found -[here][setup-tutorial]. +[here][setup-tutorial]. ## Documentation -Reference documentation is maintained as a set of man pages -in the [scdoc](https://git.sr.ht/~sircmpwn/scdoc) format. -Rendered pages can be browsed [here](https://foxcpp.dev/maddy-reference). - -Tutorials and misc articles can be found on -the [project wiki](https://github.com/foxcpp/maddy/wiki). +The full documentation is published [here](https://foxcpp.dev/maddy/) -Examples of more advanced configurations with explainations can be -found in the [examples](examples/) directory. +Examples of more advanced configurations with explainations can be found in the +[examples](examples/) directory in the source repository. ## Community @@ -79,4 +75,4 @@ The code is under MIT license. See [LICENSE](LICENSE) for more information. [dnsbl]: https://en.wikipedia.org/wiki/DNSBL [backscatter]: https://en.wikipedia.org/wiki/Backscatter_(e-mail) -[setup-tutorial]: https://github.com/foxcpp/maddy/wiki/Tutorial:-Setting-up-a-mail-server-with-maddy +[setup-tutorial]: https://foxcpp.dev/maddy/tutorial/setting-up/ diff --git a/dist/systemd/maddy.service b/dist/systemd/maddy.service index e326eea7..0b77abd9 100644 --- a/dist/systemd/maddy.service +++ b/dist/systemd/maddy.service @@ -2,7 +2,7 @@ Description=maddy mail server Documentation=man:maddy(1) Documentation=man:maddy.conf(5) -Documentation=https://github.com/foxcpp/maddy/wiki +Documentation=https://foxcpp.dev/maddy/ After=network.target [Service] diff --git a/dist/systemd/maddy@.service b/dist/systemd/maddy@.service index c5a820d5..704147f8 100644 --- a/dist/systemd/maddy@.service +++ b/dist/systemd/maddy@.service @@ -1,5 +1,8 @@ [Unit] Description=maddy mail server (using %i.conf) +Documentation=man:maddy(1) +Documentation=man:maddy.conf(5) +Documentation=https://foxcpp.dev/maddy/ After=network.target [Service]