freya/crab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Tyler Murphy 2022-11-09 11:46:26 -05:00
parent 26025c52fd
commit 65345247fb
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
readme.md
View file

@ -3,11 +3,13 @@
# Installation
### From Source
First run `cargo install --release` to compile the binary.
First run `cargo build --release` to compile the binary.
Then run `install.sh` as root to install crab.
Run `uninstall.sh` as root to uninstall crab.
### Arch Based Systems
If you are on arch-linux, crab is avaliable on the AUR as `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.
@ -17,4 +19,4 @@ For Example
root true
tylerm false
```
The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`.
The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`.

0
uninstall.sh Normal file → Executable file
View file