sashakoshka/bulb
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Better setup instructions in README

Browse Source
This commit is contained in:
Sasha Koshka 2024-10-09 20:27:35 -04:00
parent e8d5f37a9e
commit 27e9785a91
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -5,11 +5,20 @@ messages using the "bulb" command. You can also set up multiple boards.
## Setup ## 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 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 user `bulb`, with the setuid bit enabled. Then, create a list of boards (empty
at `/var/bulb/` which are also owned by `bulb`. This will allow all users to use text files) located at `/var/bulb/` which are also owned by `bulb`. This will
the program to post on boards without allowing them to directly edit their allow all users to use the program to post on boards without allowing them to
contents, thereby preventing them from mischeviously re-writing chat history. directly edit their contents, thereby preventing them from mischeviously
re-writing chat history.
## Usage ## Usage