summaryrefslogtreecommitdiff
path: root/readme.md
blob: 971c46927d7f551d9c6c9e96e02a3f89d343d32f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# **Crab**
`Crab`, a.k.a `Cool Rust Authentication Binary` is a rusty replacement for sudo or doas on Linux systems.

# Installation
### From Source
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 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.

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`.