Skip to content

Commit ebafb14

Browse files
committed
📝 Generic OIDC authentication docs
1 parent aaf4a2c commit ebafb14

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

docs/config.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,15 @@ REFRESH_TOKEN_EXPIRE_MINUTES=1440
1818

1919
### Configure OIDC Auth
2020

21-
> [!TIP]
22-
> By default, `OIDC_PROTOCOL` is `https` and `OIDC_REALM` is `master`
23-
2421
```yaml
22+
OIDC_DISCOVERY_URL="https://sso.yourdomain.lan/.well-known/openid-configuration"
2523
OIDC_CLIENT_ID="your-client-id"
2624
OIDC_CLIENT_SECRET="your-client-secret"
27-
OIDC_HOST="sso.yourdomain.lan"
28-
OIDC_REDIRECT_URI="your-redirect-uri"
29-
30-
# Optional,
31-
OIDC_PROTOCOL="https"
32-
OIDC_REALM="master"
25+
OIDC_REDIRECT_URI="https://trip.yourdomain.lan/auth"
3326
```
3427

3528
> [!CAUTION]
36-
> You might face a `SSLError` / `CERTIFICATE_VERIFY_FAILED` if you use `https` protocol. I invite you to check [Troubleshoot SSL Error](#tbshoot-cert) section
29+
> You might face a `SSLError` / `CERTIFICATE_VERIFY_FAILED`. I invite you to check [Troubleshoot SSL Error](#tbshoot-cert) section
3730
3831

3932
### Disable registration
@@ -64,7 +57,7 @@ One way to check if you're concerned by this is simply doing the following and c
6457
$ docker run --rm -it ghcr.io/itskovacs/trip:1 /bin/bash
6558
$ python3
6659
>>> import httpx
67-
>>> httpx.get("https://your-keycloak-host/")
60+
>>> httpx.get("https://sso.yourdomain.lan/")
6861
```
6962

7063
In case you're facing this issue, it's likely due to the fact that the container does not trust you custom certificate.

0 commit comments

Comments
 (0)