Commit Graph

767 Commits

Author SHA1 Message Date
Noah Overcash bed51886f4
Merge branch 'master' into add-send-only-aliases 2025-03-31 21:08:12 -04:00
beertje44 229ebba1b8
docs: Dovecot Solr - Add compatibility note (#4433)
Co-authored-by: Casper <casperklein@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2025-03-31 11:00:57 +13:00
tranquillity-codes 8ca2bd212c
chore: Gender-neutral language (#4421)
Co-authored-by: itycodes <tranquillitycodes@proton.me>
2025-03-18 19:08:56 +01:00
Lasslos 6b1a566497
docs: Fail2Ban - Add example with required ENV to enable (#4402) 2025-03-06 08:29:39 +01:00
Georg Lauterbach ef66dd5d12
release: v15.0.0 (#4373)
Signed-off-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2025-03-01 12:14:57 +00:00
Brennan Kinney 41dd0727e4
docs(rspamd): Fix Web UI link (#4384) 2025-02-21 08:48:17 +01:00
Brennan Kinney bcee78e2c1
docs: Revise Rspamd page (#4360) 2025-02-16 23:17:29 +01:00
Brennan Kinney 07e558e4be
docs: Fix broken ref links (#4366) 2025-02-16 10:22:40 +01:00
Alessio Artoni ca877999ec
docs: Fix typo in DKIM and utils.sh (#4358) 2025-02-12 20:34:22 +01:00
Casper e116920f4d
Add missing "setup debug getmail" command and documentation (#4346) 2025-02-05 23:10:57 +01:00
Zlatibor Veljkovic 0e61f170fd
docs: `bind-smtp-network-interface.md` - Add bridge network config advice (#4330)
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2025-02-04 12:45:43 +13:00
Georg Lauterbach 3faa40bfb5
docs: add ARC example to Rspamd documentation (#4328)
Signed-off-by: georglauterbach <44545919+georglauterbach@users.noreply.github.com>
2025-02-02 21:35:50 +00:00
Brennan Kinney e6d519b6f8
docs: TLS (Caddy) - Revise advice on `tls internal` (#4305) 2025-01-06 09:02:02 +13:00
Wojciech Woźniak 24fb65ce7b
docs: Environment - Update Dovecot docs URL (#4296)
Co-authored-by: Casper <casperklein@users.noreply.github.com>
2024-12-28 18:00:27 +13:00
Pooyan Khanjankhani 259f2031fc
docs: Fix typo on usage page (#4294)
Co-authored-by: Casper <casperklein@users.noreply.github.com>
2024-12-23 14:38:46 +13:00
Brennan Kinney c15354058f
fix: SASLAuth - Drop services for `mysql`, `shadow`, `pam` auth mechanisms (#4259) 2024-11-20 17:19:58 +13:00
Georg Lauterbach 2bcc5cf9de
Rspamd documentation: update Abusix signup link (#4204) 2024-09-29 12:53:10 +02:00
Vetu a87d49e8f8
fix: typo in volume pathname (#4165) 2024-08-24 20:42:32 +02:00
Casper b2978fd760
breaking: Refactor `getmail` support (#4156)
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
2024-08-17 12:14:59 +02:00
Brennan Kinney a338c06639
docs: Add caveat for ENV `DMS_VMAIL_UID` value compatibility (#4143) 2024-08-01 08:57:36 +12:00
Brennan Kinney 0698ad9370
docs: Refactor pages for Account Management (#4122)
* docs: Relocate account / auth pages into a common section

* docs: Update references to relocated pages

* docs: Add account management overview page

Updates remaining links to account sections on this page instead (_for `accounts`, `aliases`, `quotas`_).

This page will cover the features and defer to separate pages for more specific content where relevant.

* docs: Correct relocated pages titles and links

* docs: Accounts (Dovecot Master) - Minor revisions

* docs: Fix highlighting roundcube PHP snippet in OAuth2 page

* docs: Accounts (File) - Refactor

- Manual method not necessary to document.
- Condense `setup` example guidance.
- Quotas / Aliases content migrated to Overview when not specific about file provisioner.

Some of the content is this commit is not a complete revision.

* chore: Temporary commit

* docs(refactor): Sub-addressing section

Much better docs on the sub-addressing feature supported by Postfix and Dovecot, along with the guidance with usage in Sieve.

* docs:  Revise accounts section

Add some context regarding DMS accounts and their distinction/overlap from the email address functionality, and it's relevant context for receiving/sending.

File provisioner, minor revisions to referencing associated config files and account management.

* docs: Minor adjustments

* docs: Refactor the quota section

Better documented with links and coverage over the workaround details we've implemented.

* docs: Revise the quota section

Minor revisions with phrasing, admonitions for structure and better explanation of the feature functionality/purpose.

* docs: Alias section refactor

Extensively covers known issues and technical details that have been discussed often enough.

The improvements should benefit both users and maintainers.

* docs: Refactor master accounts page

This rewrite should more clearly document the feature, along with a better example and additional links for reference.

* docs: OAuth2 revision

Minor update to this page:
- Links extracted to bottom of page as per convention.
- ENV file example converted to preferred `compose.yaml` ENV settings.

* docs: Sieve minor revisions

- Correct link to subaddressing section
- Make the config file example snippets intended filename less ambiguous.
- Minor rephrasng.

* docs: Revise accounts overview section

Revised the account section and added additional clarity for common confusion with relation to sender address and multi-domain support.

Top of the page now clarifies it's a technical reference and directs users to the related pages for configuration / caveats.

Technical Overview links to Dovecot docs were missing.

* docs: Another revision pass

File based provisioner docs:
- Sections indent with info admonitions.
- Accounts section expanded with config format and example.
- Quotas section expanded and shifted to bottom (alphabetical sort).
- Split into `setup` CLI and config reference groups.

Overview page:
- Sections indent with info admonitions.
- Revised content.

* docs(chore): Shift sub-addressing section

This is related to accounts and aliases, but not provisioners, thus extract out of the accounts parent section.

* docs: Document `postfix-accounts.cf` third column

This lacked documentation but was community contributed feature to allow further customization of a Dovecot Account.

It has caveats as DMS does not take these into consideration anywhere in scripts. Documenting officially for better awareness.

* docs: Revise and expand supplementary pages

Better outline the OAuth2 login process, the two supported login mechanisms and their docs/rfcs, along with documenting caveat with mail client compatibility.

Add a verification tip for the OAuth2 support, showing how `curl` can be used, along with caveat presently affecting the `curl` in DMS v14.

Additionally note the feature still isn't documented fully, providing the user with additional references for more information.

`ACCOUNT_PROVISIONER` ENV docs minimized. No `OIDC` provisioner plans, the OAuth2 docs page now mentions SCIM 2.0 API as the next step towards resolving that concern. The tip admonition was removed as it no longer provides value, instead we link to the Account Management overview page.

Dovecot Master Accounts docs page now lightly document the `setup` CLI and config format for the feature.

* docs: Fix broken anchor links

Some anchor links to different parts of our docs have gone stale. This branch also broke a few itself that I missed.

The build now only reports issues with anchor links to Content Tabs, which it must not be aware of during the build (_MKDocs Material specific feature?_)

* docs(lint): Fix indentation level

* chore: Add entry to `CHANGELOG.md` + corrections
2024-07-22 10:00:53 +12:00
Brennan Kinney 755540cacf
docs: `docker-build.md` - Update `DOVECOT_COMMUNITY_REPO` default (#4111) 2024-07-14 11:24:33 +02:00
Brennan Kinney 4778f15fda
docs: TLS typo fix (#4106)
- Caddy admonition - Missing `[` for annotating a link.
- Traefik - `docker-compose` => "Docker Compose"
2024-07-09 19:44:09 +02:00
Brennan Kinney 2d12bbb7fd
docs: Update `compose.yaml` for `dovecot-solr` guide (#4099)
The `image` field is used for the default tag, if it's not specified Compose will infer one in addition to any extra `tags` provided.

Better to use `image` for the tag assignment, and a clear `pull_policy` to prevent trying to pull a remote image of the same name.
2024-07-05 23:48:42 +12:00
Brennan Kinney 8a082be714
docs: Add info regarding DKIM key rotation and non-expiry (#4076)
Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
Co-authored-by: Casper <casperklein@users.noreply.github.com>
2024-06-19 08:39:06 +00:00
beertje44 40aab6bd18
docs: Add tutorial for configuring Dovecot FTS with Solr (#4070)
Describe how to use Apache Solr as a Dovecot FTS backend.

---------

Co-authored-by: Casper <casperklein@users.noreply.github.com>
Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2024-06-18 08:46:34 +02:00
Brennan Kinney 8e32635993
docs: Document fix for PROXY protocol with `postscreen` (#4066) 2024-06-15 14:26:33 +02:00
Noah Overcash e6a7f9ac1e
minor doc changes 2024-06-02 16:21:21 -04:00
Noah Overcash a479b2015d
Initial regexp-send-only alias implementation 2024-06-02 13:55:56 -04:00
Guillaume VARA 95d965fb76
docs(k8s): Advise `externalTrafficPolicy: Local` if no PROXY protocol configured (#4039)
Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2024-05-28 15:52:30 +00:00
Tobias Knecht a96a4e2768
Abusix docs links update. (#4038) 2024-05-28 13:20:15 +02:00
Jiří Štefka 993c7b044f
breaking: Drop Dovecot support for Solr (#4025) 2024-05-21 16:49:39 +02:00
Jiří Štefka 92b06c4020
docs(rspamd): Add guidance for setting WebUI password (#4023)
* fix(docs/rspamd): Add section on how to setup WebUI password

* Apply review suggestion

* Apply suggestions from code review

* Update rspamd.md

---------

Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2024-05-20 15:07:42 +02:00
pyy a780fb3311
docs: Add tip for disabling the default SPF service (#4019)
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2024-05-17 21:38:02 +12:00
F. Eber 10f72224ca
Update typo in kubernetes.md (#4003)
Added the missing "s" on "submissions", otherwise this error comes up:
The Service "mailserver" is invalid: spec.ports[2].name: Duplicate value: "submission"
2024-05-05 19:26:58 +02:00
Brennan Kinney 7822a97430
docs(FAQ): Add advice for restricting login by IP (#3999) 2024-05-02 07:48:05 +00:00
Brennan Kinney d00edd7209
docs: Revise fetchmail page (#3998) 2024-05-02 07:44:54 +00:00
Wael 83da191f3a
docs: Fix link for `getmail6` (#3996) 2024-05-02 12:08:29 +12:00
Fürst df360516ff
docs: Add config guide for relaying to and from a private DMS instance (#3973)
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Casper <casperklein@users.noreply.github.com>
2024-04-22 11:50:02 +12:00
Brennan Kinney ac22caf74e
docs: Updates to TLS page (Caddy, testing, etc) (#3981) 2024-04-20 11:25:02 +12:00
Tobia Bocchi 942920615c
docs: Fix typo on usage page (#3980) 2024-04-18 13:08:26 +12:00
Iztok Fister Jr d87e4d3bfd
docs: Fix typos (#3979) 2024-04-16 20:25:45 +00:00
fanqiaojun dc51850030
chore: remove repetitive words (#3977) 2024-04-15 19:48:55 +00:00
Georg Lauterbach 6733a172d7
docs: add FAQ entry about DNS servers and drop feature request on custom DNS servers for Rspamd (#3966)
* add FAQ entry about DNS servers

I also opted for including a quote from @polarthene which illustrates
how DNS servers are a difficult topic and should not be DMS'
responsibility.

* link to DNS FAQ from Rspamd page & drop feature request

The feature request annotation has been removed because we decided it's
not DMS responsibility to ensure correctly working DNS servers.
2024-03-31 02:14:02 +00:00
Georg Lauterbach 4f10089c90
docs: add note about custom F2B setup with PROXY protocol (#3964) 2024-03-29 14:07:13 +13:00
Inseo Song 082e076377
docs: Add relay host config guide for Gmail (#3958)
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2024-03-28 17:02:11 +13:00
Brennan Kinney cdcd86420e
docs: Add IPv6 troubleshooting tip (#3938)
Sometimes a user may have a configuration error and get halfway there. This should help point them in the right direction.
2024-03-14 15:24:33 +13:00
Georg Lauterbach 2133b51e78
docs: rewrite Kubernetes page (#3928) 2024-03-12 09:31:44 +01:00
Kirill Kirilenko 3649699197
fix: Move spam to mailbox associated to the `\Junk` special-use attribute (#3925)
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2024-03-07 11:13:22 +13:00
Brennan Kinney d227d6dc73
docs: Reference systemd timer example (`cerbot renew`) (#3921) 2024-03-05 20:33:04 +13:00