crab/readme.md

20 lines
707 B
Markdown
Raw Normal View History

2022-11-09 00:44:31 +00:00
# **Crab**
`Crab`, a.k.a `Cool Rust Authentication Binary` is a rusty replacement for sudo and doas on Linux systems
# Installation
2022-11-09 03:07:02 +00:00
### 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`.
2022-11-09 00:44:31 +00:00
# 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
```
2022-11-09 03:07:02 +00:00
The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`.