diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 29 |
1 files changed, 24 insertions, 5 deletions
@@ -3,15 +3,34 @@ # Installation ### From Source -First run `cargo build --release` to compile the binary. -Then run `install.sh` as root to install crab. +To be able to build the package, you need cargo wich you can get either though rust or rust up. -Run `uninstall.sh` as root to uninstall crab. +To build, run the following commands below in the root directory of the repo. Make sure to run the shell script as root. +```bash +cargo build --release +./deployments/source/install.sh +``` + +To uninstall, just run the following script as root. +```bash +./deployments/source/uninstall.sh +``` ### Arch Based Systems If you are on an arch based distro, crab is avaliable on the [AUR](https://aur.archlinux.org/packages/crab) as `crab`. +``` +paru -S crab +``` # Configuration + +The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`. +```bash +cp /usr/share/crab/crab.conf /etc/crab.conf +chown root:root /etc/crab.conf +chmod 600 /etc/crab.conf +``` + 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 @@ -23,8 +42,8 @@ For Example ``` deny :docker permit nopass persist linus as root -permit :wheel persist #deny stallman +permit :wheel persist permit nvidia as fu ``` -The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`. +Please make sure when editing your config that not normal users can edit the file, but only root. If normal users can edit the config, they can add themselvs as permitted and get elevated privilages. |