Skip to content

Commit 8cda110

Browse files
committed
Update README with example moderators file
1 parent 961454c commit 8cda110

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,24 @@ Configuration options reference
397397

398398
#### authorization.moderatorsFile (string: "")
399399

400-
Absolute path for your moderators YAML file. If used, this file must contain a list of `usernames` and `emails` for users who have write access to the wiki. A user who has a match in either the `usernames` or `emails` list will have right access.
400+
Absolute path for your moderators YAML file. If used, this file must contain a list of `usernames` and `emails` for users who have write access to the wiki. A user who has a match in either the `usernames` or `emails` list will have right access. The moderators file may also include an attribute and value for managing moderators via LDAP roles.
401+
402+
Example moderators YAML file:
403+
404+
```
405+
---
406+
# A list of moderators usernames and emails
407+
usernames:
408+
- 'admin1'
409+
- 'admin2'
410+
emails:
411+
- 'admin@email.com'
412+
- 'anotheradmin@email.com'
413+
# LDAP moderator role
414+
ldap:
415+
attribute: 'businessCategory'
416+
value: 'A'
417+
```
401418

402419
If this field is left blank, all logged in users will have write access to the wiki.
403420

0 commit comments

Comments
 (0)