Add setup instructions to README

This commit is contained in:
Sasha Koshka 2024-10-09 20:22:00 -04:00
parent c635830c37
commit e8d5f37a9e

View File

@ -3,6 +3,14 @@
A simple bulletin board for your server. Users of the system can post and read
messages using the "bulb" command. You can also set up multiple boards.
## Setup
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.
## Usage
To list available boards: