Archive-Team
/
docker-mailserver
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Apply suggestions from code review

This commit is contained in:
Brennan Kinney 2024-01-07 20:45:11 +13:00 committed by GitHub
parent 5a6f2b1f03
commit b24096dd5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -9,7 +9,7 @@ All notable changes to this project will be documented in this file. The format
### Features ### Features
- **Authentication with OIDC / OAuth 2.0** 🎉 - **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. - 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_). - Successful authentication (_via Dovecot PassDB_) still requires an existing account (_lookup via Dovecot UserDB_).

2
README.md
View File

@ -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 - 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 - A [setup script](https://docker-mailserver.github.io/docker-mailserver/latest/config/setup.sh) for easy configuration and maintenance
- SASLauthd with LDAP authentication - SASLauthd with LDAP authentication
- OAuth2 authentication - OAuth2 authentication (_via `XOAUTH2` or `OAUTHBEARER` SASL mechanisms_)

2
docs/content/config/environment.md
View File

@ -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]. - 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 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 [docs::auth::oauth2-config-guide]: ./advanced/auth-oauth2.md

2
mailserver.env
View File

@ -427,7 +427,7 @@ GETMAIL_POLL=5
# 1 => OAUTH2 authentication is enabled # 1 => OAUTH2 authentication is enabled
ENABLE_OAUTH2= 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/ # Example: https://oauth2.example.com/userinfo/
OAUTH2_INTROSPECTION_URL= OAUTH2_INTROSPECTION_URL=