rdo/README.md
2025-08-13 11:23:36 +10:00

53 lines
1.3 KiB
Markdown

# RootDO
This project aims to be a very slim alternative to both sudo and doas.
### Installation
You can clone and build rdo with the following set of commands:
```sh
git clone https://mrrp.sx7n8.tech/soccera/rdo.git
cd rdo
make
rdo make install
```
After that, you'll have to configure rdo to allow you to use it.
To do this, edit `/etc/rdo.conf`, and set the group variable to the admin group you are in.
Then you're good to go!
To uninstall:
```sh
rdo make uninstall
```
### Usage
```sh
rdo [command]
```
Or, to get the password from stdin:
```sh
rdo - [command]
```
`rdo` will ask for your password and grant you a session, on successful authentication you will be able to use `rdo` for the time specified in `session_ttl`. You have 3 attempts to enter the correct password.
The configuration file has the following variables:
```
group=wheel
wrong_pw_sleep=1000
session_ttl=5
```
- `group`: The group of users that is allowed to execute rdo.
- `wrong_pw_sleep`: The amount of milliseconds to sleep at a wrong password attempt. Must be a positive integer. Set to 0 to disable. Defaults to 1000.
- `session_ttl`: The amount of minutes a session lasts. Must be a positive integer. Set to 0 to disable. Defaults to 5.
### License
This project is licensed under the GNU General Public License v3.0. See the `LICENSE` file for the full license text.