From ec5b8b2aeb66e9320227d5e89a711a9bd39d2516 Mon Sep 17 00:00:00 2001 From: Ryan Date: Sun, 7 Dec 2025 05:37:42 -0500 Subject: [PATCH] chore(readme): update OIDC and add wiki --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bea00a3..04def83 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Drag & drop uploads, ACL-aware sharing, OnlyOffice integration, and a clean UI - 🌍 **WebDAV** – Mount FileRise as a drive from macOS, Windows, Linux, or Cyberduck/WinSCP. - πŸ“Š **Storage / disk usage summary** – CLI scanner with snapshots, total usage, and per-volume breakdowns in the admin panel. - 🎨 **Polished UI** – Dark/light mode, responsive layout, in-browser previews & code editor. -- πŸ”‘ **Login + SSO** – Local users, TOTP 2FA, and OIDC (Auth0 / Authentik / Keycloak / etc.). +- πŸ”‘ **Login + SSO** – Local users, TOTP 2FA, and OIDC (Auth0 / Authentik / Keycloak / etc.) with optional auto-provisioning, IdP-admin role sync, and Pro user-group mapping. - πŸ‘₯ **Pro: user groups, client portals & storage explorer** – Group-based ACLs, brandable client upload portals, and an ncdu-style explorer to drill into folders, largest files, and clean up storage inline. Full list of features available at [Full Feature Wiki](https://github.com/error311/FileRise/wiki/Features) @@ -61,6 +61,18 @@ FileRise turns a folder on your server into a **web-based file explorer** with: Everything flows through a single ACL engine, so permissions are enforced consistently whether users are in the browser UI, using WebDAV, or hitting the API. +### Login & SSO (OIDC roles + groups) + +FileRise supports local accounts, TOTP 2FA, and modern OIDC providers (Auth0, Authentik, Keycloak, …). +Beyond β€œjust login”, OIDC can now drive **roles** and **Pro user groups**: + +- πŸ§‘β€πŸ’» **Auto-provision users** +- πŸ‘‘ **IdP-driven admin role** +- πŸ‘₯ **Pro: OIDC groups β†’ FileRise Pro user groups** +- πŸ§ͺ **Admin: OIDC connectivity test** + +➑️ Full docs: [OIDC / SSO setup](https://github.com/error311/FileRise/wiki/OIDC-and-SSO) + --- ## 2. Install (Docker – recommended)