You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42Lines changed: 42 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,8 +73,50 @@ password can then be changed from the web interface
73
73
|`GONIC_MULTI_VALUE_ALBUM_ARTIST`|`-multi-value-album-artist`|**optional** setting for multi-valued album artist tags when scanning ([see more](#multi-valued-tags-v016)) |
74
74
|`GONIC_TRANSCODE_CACHE_SIZE`|`-transcode-cache-size`|**optional** size of the transcode cache in MB (0 = no limit) |
75
75
|`GONIC_TRANSCODE_EJECT_INTERVAL`|`-transcode-eject-interval`|**optional** interval (in minutes) to eject transcode cache (0 = never) |
|`GONIC_OIDC_FORWARD_HEADER`|`-oidc-forward-header`|**optional** header name containing OIDC token for oidc-forward method (default: `Authorization`) ([see more](#oidc-authentication)) |
82
+
|`GONIC_OIDC_ADMIN_ROLE`|`-oidc-admin-role`|**optional** role name for admin users in OIDC token roles claim (default: `gonic-admin`) ([see more](#oidc-authentication)) |
76
83
|`GONIC_EXPVAR`|`-expvar`|**optional** enable the /debug/vars endpoint (exposes useful debugging attributes as well as database stats) |
77
84
85
+
## oidc authentication
86
+
87
+
gonic supports OpenID Connect (OIDC) authentication as an alternative to password-based authentication. This allows integration with identity providers like Keycloak, Auth0, Okta, or any OIDC-compliant provider.
|`password`|**default** - traditional username/password authentication |
94
+
|`oidc`| full OIDC flow with authorization code exchange - users are redirected to identity provider for login, then redirected back to gonic with an authorization code |
95
+
|`oidc-forward`| for use behind an authenticating proxy - expects a valid JWT token in the specified header (useful with [oauth2-proxy](https://oauth2-proxy.github.io/oauth2-proxy/) or similar) |
- users are automatically created on first login using information from the OIDC token
117
+
- admin privileges are determined by the presence of the configured admin role in the token's roles claim
118
+
- user information is updated from the token on each login
119
+
78
120
## multi valued tags (v0.16+)
79
121
80
122
gonic can support potentially multi valued tags like `genres`, `artists`, and `albumartists`. in both cases gonic will individual entries in its database for each.
0 commit comments