Skip to content

Commit 4cf1ee0

Browse files
steamwingsZander
andcommitted
Add OIDC instructions to MD files (#2)
Co-authored-by: Zander <[email protected]>
1 parent 9c7bf5f commit 4cf1ee0

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

docs/docker-deployment.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,16 @@ If you're using a provider other than AWS, you will also need some of the follow
140140
- `S3_REQUEST_CHECKSUM_CALCULATION`
141141
- `S3_RESPONSE_CHECKSUM_VALIDATION`
142142

143+
#### OIDC / OAuth2 Authentication
144+
145+
OIDC with a single provider is supported when the following variables are set.
146+
147+
- `OIDC_ISSUER`
148+
- `OIDC_CLIENT_ID`
149+
- `OIDC_CLIENT_SECRET`
150+
151+
If you'd like to hide the magic-link login flow, you can set `OIDC_REQUIRED=true`.
152+
143153
#### Multi-tenant mode
144154

145155
By default, when you run the Fizzy Docker image you'll be limited to creating a single account (although that account can have as many users as you like).

docs/kamal-deployment.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,14 @@ Optional for S3-compatible endpoints:
111111
- `S3_REQUEST_CHECKSUM_CALCULATION` (defaults to `when_supported`)
112112
- `S3_RESPONSE_CHECKSUM_VALIDATION` (defaults to `when_supported`)
113113

114+
### Configuring OIDC / OAuth2 authentication
115+
116+
To enable OAuth2 login, set:
117+
118+
- `OIDC_ISSUER`
119+
- `OIDC_CLIENT_ID`
120+
- `OIDC_CLIENT_SECRET`
121+
122+
Optional:
123+
124+
- `OIDC_REQUIRED` (defaults to `false`; set to `true` to hide magic link login)

0 commit comments

Comments
 (0)