Tabbed and improved user docs

This commit is contained in:
Keval Kapdee 2023-12-26 19:26:12 +00:00
parent 58688a909f
commit 127b3e12c2
1 changed files with 50 additions and 39 deletions

View File

@ -17,12 +17,21 @@ The present OAuth2 support provides the capability for 3rd-party applications su
## Example (Authentik & Roundcube)
???+ example "Authentik"
This example assumes you have:
- A working DMS server set up
- An Authentik server set up ([documentation](https://goauthentik.io/docs/installation/))
- A Roundcube server set up (either [docker](https://hub.docker.com/r/roundcube/roundcubemail/) or [bare metal](https://github.com/roundcube/roundcubemail/wiki/Installation))
!!! example "Setup Instructions"
=== "1. Authentik"
1. Create a new OAuth2 provider
2. Note the client id and client secret
3. Set the allowed redirect url to the equivalent of `https://roundcube.example.com/index.php/login/oauth` for your RoundCube instance.
???+ example "Docker Mailserver `mailserver.env`"
=== "2. Docker Mailserver"
Edit the following values in `mailserver.env`:
```env
# -----------------------------------------------
# --- OAUTH2 Section ----------------------------
@ -45,7 +54,9 @@ The present OAuth2 support provides the capability for 3rd-party applications su
OAUTH2_INTROSPECTION_URL=https://authentik.example.com/application/o/userinfo/
```
???+ example "Roundcube `oauth2.inc.php` ([documentation](https://github.com/roundcube/roundcubemail/wiki/Configuration))"
=== "3. Roundcube"
Add the following to `oauth2.inc.php` ([documentation](https://github.com/roundcube/roundcubemail/wiki/Configuration)):
```php
$config['oauth_provider'] = 'generic';
$config['oauth_provider_name'] = 'Authentik';