From 6745a043a81ca9991434059717e6df2272489d73 Mon Sep 17 00:00:00 2001
From: fuomag9 <1580624+fuomag9@users.noreply.github.com>
Date: Mon, 6 Apr 2026 00:03:53 +0200
Subject: [PATCH] Document user roles (viewer/user/admin) in README

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6dec73b3..809a206b 100644
--- a/README.md
+++ b/README.md
@@ -120,6 +120,27 @@ docker compose up -d
 
 ---
 
+## User Roles
+
+CPM has three roles with increasing privileges:
+
+| Capability | Viewer | User | Admin |
+|------------|:------:|:----:|:-----:|
+| Log in to the dashboard | Yes | Yes | Yes |
+| View own profile | Yes | Yes | Yes |
+| Access forward-auth-protected apps (when granted) | Yes | Yes | Yes |
+| Manage proxy hosts, certificates, access lists | No | No | Yes |
+| Manage users, groups, and settings | No | No | Yes |
+| View analytics, audit log, and API docs | No | No | Yes |
+| Create and manage API tokens | No | No | Yes |
+| Access the REST API (`/api/v1/`) | No | No | Yes |
+
+New users default to the **user** role. The initial admin account is created from the `ADMIN_USERNAME` / `ADMIN_PASSWORD` environment variables.
+
+> **Forward Auth access** is separate from role — all roles must be explicitly granted access to each protected host via the forward auth access list.
+
+---
+
 ## Certificate Management
 
 Caddy automatically obtains Let's Encrypt certificates for all proxy hosts.
@@ -258,7 +279,6 @@ OAuth login appears on the login page alongside credentials. Users can link OAut
 
 ## Roadmap
 
-- [ ] Multi-user RBAC
 - [ ] Additional DNS providers (Route53, Namecheap, etc.)
 
 [Open an issue](https://github.com/fuomag9/caddy-proxy-manager/issues) for feature requests.