From d6de68e91b5900e8945cc2c76e98e18d0eff5f19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=91cze=20Bence?= Date: Sat, 29 Mar 2025 00:33:09 +0100 Subject: [PATCH] document the new config variables --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f3c8161e..671a4443 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,8 @@ properties are needed in `mailu.env`: | `OIDC_VERIFY_SSL` | Disable TLS certificate verification for the OIDC client | `True` \| `False` | | `OIDC_CHANGE_PASSWORD_REDIRECT_ENABLED` | If enabled, OIDC users will have an button to get redirect to their OIDC provider to change their password | `True` \| `False` | | `OIDC_CHANGE_PASSWORD_REDIRECT_URL` | Defaults to provider issuer url appended by `/.well-known/change-password`. | [https://`host`/pw-change]() | +| `OIDC_USERNAME_CLAIM` | The OIDC claim used as the username. If the selected claim contains an email address, it will be used as is. If it is not an email (e.g., `sub`), the email address will be constructed as `@`. Defaults to `email`. | `email` \| `sub` +| `OIDC_USER_DOMAIN` | The domain used when constructing an email from a non-email username (e.g., when `OIDC_USERNAME_CLAIM=sub`). Ignored if `OIDC_USERNAME_CLAIM` is already an email. Defaults to the value of `DOMAIN`. | `example.com` Here is a snippet for easy copy paste: