summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authortylermurphy534 <tylermurphy534@gmail.com>2022-11-08 22:07:02 -0500
committertylermurphy534 <tylermurphy534@gmail.com>2022-11-08 22:07:02 -0500
commitc0f8085da8b79fc448bb6c1d7f1875228c42d5b0 (patch)
tree7e0a7a04cf5eda86befb02c73bddac3da4715b72 /readme.md
parentfix non root tamper persist files (diff)
downloadcrab-c0f8085da8b79fc448bb6c1d7f1875228c42d5b0.tar.gz
crab-c0f8085da8b79fc448bb6c1d7f1875228c42d5b0.tar.bz2
crab-c0f8085da8b79fc448bb6c1d7f1875228c42d5b0.zip
aur support
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index b659123..470f1e5 100644
--- a/readme.md
+++ b/readme.md
@@ -2,7 +2,12 @@
`Crab`, a.k.a `Cool Rust Authentication Binary` is a rusty replacement for sudo and doas on Linux systems
# Installation
-Run `build.sh` as the root user to build the rust binary, and install files.
+### 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.
@@ -12,4 +17,4 @@ For Example
root true
tylerm false
```
-The configuration file is stored in `/etc/crab.conf` \ No newline at end of file
+The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`. \ No newline at end of file