crab/readme.md
tylermurphy534 c0f8085da8 aur support
2022-11-08 22:07:02 -05:00

20 lines
No EOL
707 B
Markdown

# **Crab**
`Crab`, a.k.a `Cool Rust Authentication Binary` is a rusty replacement for sudo and doas on Linux systems
# Installation
### From Source
First run `cargo install --release` to compile the binary.
Then run `install.sh` as the root user to install files.
### Arch Based Systems
If you are on arch-linux, the pakage is avaliable on the AUR as `crab-git`.
# Configuration
Crab supports multiple users and persistence. Each line of the config is the username, then `true` of `false` if the crab authentication persists, seperated by a space.
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`.