Better setup instructions in README

This commit is contained in:
Sasha Koshka 2024-10-09 20:27:35 -04:00
parent e8d5f37a9e
commit 27e9785a91

View File

@ -5,11 +5,20 @@ messages using the "bulb" command. You can also set up multiple boards.
## Setup
You can install the `bulb` command by running:
```
hare build cmd/bulb
```
And then installing the resulting executable.
The reccomended way to use this program is to have the executable owned by the
user `bulb`, with the setuid bit enabled. Then, create a list of boards located
at `/var/bulb/` which are also owned by `bulb`. This will allow all users to use
the program to post on boards without allowing them to directly edit their
contents, thereby preventing them from mischeviously re-writing chat history.
user `bulb`, with the setuid bit enabled. Then, create a list of boards (empty
text files) located at `/var/bulb/` which are also owned by `bulb`. This will
allow all users to use the program to post on boards without allowing them to
directly edit their contents, thereby preventing them from mischeviously
re-writing chat history.
## Usage