From b24096dd5c4e46d7a9f4a6e4759755aafc1f3c1b Mon Sep 17 00:00:00 2001 From: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Date: Sun, 7 Jan 2024 20:45:11 +1300 Subject: [PATCH] Apply suggestions from code review --- CHANGELOG.md | 2 +- README.md | 2 +- docs/content/config/environment.md | 2 +- mailserver.env | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c576846..83f93172 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ All notable changes to this project will be documented in this file. The format ### Features - **Authentication with OIDC / OAuth 2.0** 🎉 - - DMS now supports authentication via OAuth2 (_`XOAUTH` or `OAUTHBEARER`_) from capable services (_like Roundcube_). + - DMS now supports authentication via OAuth2 (_via `XOAUTH2` or `OAUTHBEARER` SASL mechanisms_) from capable services (_like Roundcube_). - This does not replace the need for an `ACCOUNT_PROVISIONER` (`FILE` / `LDAP`), which is required for an account to receive or send mail. - Successful authentication (_via Dovecot PassDB_) still requires an existing account (_lookup via Dovecot UserDB_). diff --git a/README.md b/README.md index 4ab10fe0..3f52724d 100644 --- a/README.md +++ b/README.md @@ -48,4 +48,4 @@ If you have issues, please search through [the documentation][documentation::web - Support for [LetsEncrypt](https://letsencrypt.org/), manual and self-signed certificates - A [setup script](https://docker-mailserver.github.io/docker-mailserver/latest/config/setup.sh) for easy configuration and maintenance - SASLauthd with LDAP authentication -- OAuth2 authentication +- OAuth2 authentication (_via `XOAUTH2` or `OAUTHBEARER` SASL mechanisms_) diff --git a/docs/content/config/environment.md b/docs/content/config/environment.md index bd210c6c..e4e9cc51 100644 --- a/docs/content/config/environment.md +++ b/docs/content/config/environment.md @@ -60,7 +60,7 @@ Configures the provisioning source of user accounts (including aliases) for user - A third-party service must provide a valid token for the user which Dovecot validates with the authentication service provider. To enable this feature reference the [OAuth2 configuration example guide][docs::auth::oauth2-config-guide]. - User accounts must be provisioned to receive mail via one of the supported `ACCOUNT_PROVISIONER` providers. - - User provisioning via OAUTH2 is planned for the future, see [this tracking issue](https://github.com/docker-mailserver/docker-mailserver/issues/2713). + - User provisioning via OIDC is planned for the future, see [this tracking issue](https://github.com/docker-mailserver/docker-mailserver/issues/2713). [docs::auth::oauth2-config-guide]: ./advanced/auth-oauth2.md diff --git a/mailserver.env b/mailserver.env index e2afd0a6..17d72353 100644 --- a/mailserver.env +++ b/mailserver.env @@ -427,7 +427,7 @@ GETMAIL_POLL=5 # 1 => OAUTH2 authentication is enabled ENABLE_OAUTH2= -# Specify the user info endpoint URL of the oauth2 provider. The trailing slash is MANDATORY (at least for Authentik) +# Specify the user info endpoint URL of the oauth2 provider # Example: https://oauth2.example.com/userinfo/ OAUTH2_INTROSPECTION_URL=