add documentation for groups in rights file

This config key is undocumented, seemingly by accident?
This commit is contained in:
Naman Sood
2026-07-01 22:53:36 -04:00
parent 69b265b539
commit b9327989ec

View File

@@ -2562,6 +2562,13 @@ permissions: RW
user: .+
collection: {user}/[^/]+
permissions: rw
# Allow reading and writing the collection named "common" for people in
# certain LDAP groups
[groupcal]
groups: members,directors
collection: common
permission: rw
```
The titles of the sections are ignored (but must be unique). The keys `user`
@@ -2569,6 +2576,10 @@ and `collection` contain regular expressions, that are matched against the
username and the path of the collection. Permissions from the first
matching section are used. If no section matches, access gets denied.
The `groups` key can be used to provide a comma-separated list of LDAP groups
which should be matched for access. In case a section has both `user` and
`groups`, either one matching will allow access in that section.
The username is empty for anonymous users. Therefore, the regex `.+` only
matches authenticated users and `.*` matches everyone (including anonymous
users).