crab/readme.md

23 lines
765 B
Markdown
Raw Normal View History

2022-11-09 00:44:31 +00:00
# **Crab**
2022-11-09 05:51:47 +00:00
`Crab`, a.k.a `Cool Rust Authentication Binary` is a rusty replacement for sudo or doas on Linux systems.
2022-11-09 00:44:31 +00:00
# Installation
2022-11-09 03:07:02 +00:00
### From Source
2022-11-09 16:46:26 +00:00
First run `cargo build --release` to compile the binary.
2022-11-09 05:51:47 +00:00
Then run `install.sh` as root to install crab.
2022-11-09 03:07:02 +00:00
2022-11-09 16:46:26 +00:00
Run `uninstall.sh` as root to uninstall crab.
2022-11-09 03:07:02 +00:00
### Arch Based Systems
2022-11-09 16:46:26 +00:00
If you are on an arch based distro, crab is avaliable on the [AUR](https://aur.archlinux.org/packages/crab) as `crab`.
2022-11-09 00:44:31 +00:00
# Configuration
2022-11-09 05:51:47 +00:00
Crab supports multiple users with persistence. Each line of the config is the username, then `true` of `false` if the crab authentication persists.
2022-11-09 00:44:31 +00:00
For Example
```
root true
tylerm false
```
2022-11-09 16:46:26 +00:00
The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`.