bulb/README.md

36 lines
805 B
Markdown

# bulb
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:
```
bulb
```
To post a message:
```
bulb post Message text
bulb post -b <board-name> Message text
```
To read recent messages:
```
bulb read
bulb read -b <board-name>
bulb read -n <message-count>
```