homepage-plus

docs/configs/settings.md

@@ -542,3 +542,42 @@ or per service widget (`services.yaml`) with:
 ```
 
 If either value is set to true, the error message will be hidden.
+
+## Identity Based Visibiltiy
+
+Basic user identity integration is implemeted via an `identity` section. An identity provider can be configured using the `provider` section with the given type. Currently the only provider supported is `proxy`, where the users identification and group membership are passed via HTTP Request headers (in plaintext). The expectation is that the application will be accessed only via an authenticating proxy (i.e traefik or nginx).
+
+The group and user headers are both configurable like so:
+
+```yaml
+identity:
+  provider:
+    type: proxy
+    groupHeader: "X-group-header"
+    userHeader: "X-user-header"
+```
+
+Identity based visibility can be configured on the service, bookmark, and widget level using the `allowUsers` and `allowGroups` list. The default is to allow all users and groups.
+
+```yaml
+- Example Servie:
+  allowGroups:
+    - Group1
+    - Group2
+    - Group3
+  allowUsers:
+    - User1
+    - User2
+    - User3
+```
+
+Identity visibility for groups can be set in the `groups` under `identity`. In general the `groups` tag follows the format of the `layout` section. For example:
+
+```yaml
+identity:
+  groups:
+    - My Service Group:
+      allowGroups: ["Group1", "Group2"]
+    - My Other Group:
+      allowGroups: ["Group1"]
+```