summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authortylermurphy534 <tylermurphy534@gmail.com>2022-11-11 09:56:48 -0500
committertylermurphy534 <tylermurphy534@gmail.com>2022-11-11 09:56:48 -0500
commitde24d5499ac83f426228b28b90bed8f26e68fb3b (patch)
tree7a37f98005e8337d078db9edf1fec89de4a98f04 /readme.md
parentupdate config format (diff)
downloadcrab-de24d5499ac83f426228b28b90bed8f26e68fb3b.tar.gz
crab-de24d5499ac83f426228b28b90bed8f26e68fb3b.tar.bz2
crab-de24d5499ac83f426228b28b90bed8f26e68fb3b.zip
doc string, refactor, config token error
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 971c469..7d6566d 100644
--- a/readme.md
+++ b/readme.md
@@ -12,11 +12,19 @@ Run `uninstall.sh` as root to uninstall crab.
If you are on an arch based distro, crab is avaliable on the [AUR](https://aur.archlinux.org/packages/crab) as `crab`.
# Configuration
-Crab supports multiple users with persistence. Each line of the config is the username, then `true` of `false` if the crab authentication persists.
+Each line in the configuration specifies a different rule. Each rule is applied from top to bottom,
+so the first onethat matches a user is what is used. The first word is either `permit` or `deny` to
+allow or deny a certain group. Then the tags `persist` and `nopass` can be added to allow authoriziation
+persistance or skipping respectively. Then a user can be specified by putting their name, or a group by a
+colon then the groups name. Finally, if you dont want to run that user as root, you can add `as` and then
+a user name to run the process as. All lines starting in a # will be ignored.
For Example
```
-root true
-tylerm false
+deny :docker
+permit nopass persist linus as root
+permit :wheel persist
+#deny stallman
+permit nvidia as fu
```
The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`.