2017-04-03 08:44:19 +00:00
|
|
|
# Bulletin Butter & Jelly
|
2017-04-03 04:53:08 +00:00
|
|
|
|
2017-04-29 03:11:35 +00:00
|
|
|
BBJ is a trivial collection of python scripts and database queries that
|
|
|
|
|
miraculously shit out a fully functional, text-driven community bulletin board.
|
2017-09-06 22:05:19 +00:00
|
|
|
Requires Python 3.4 and up for the server and the official TUI client (clients/urwid/).
|
2017-04-29 03:07:18 +00:00
|
|
|
|
|
|
|
|
|
2017-04-29 03:11:35 +00:00
|
|
|
<center><h2>Look Ma, it boots !!11!</h2></center>
|
|
|
|
|
|
|
|
|
|
It's all driven by an API sitting on top of CherryPy. Currently it does not
|
|
|
|
|
serve HTML but this is planned for the (distant?) future.
|
|
|
|
|
|
|
|
|
|
The two official client implementations are a stand alone TUI client for
|
|
|
|
|
the unix terminal, and GNU Emacs. The API is simple and others are welcome
|
|
|
|
|
to join the party at some point.
|
2023-03-17 09:14:50 +00:00
|
|
|
|
|
|
|
|
## Docker
|
|
|
|
|
**Database**
|
|
|
|
|
|
|
|
|
|
Initialize with
|
|
|
|
|
```bash
|
|
|
|
|
/bin/bash ./setup.sh --dbset
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Mount to `/app/data.sqlite`
|
|
|
|
|
|
|
|
|
|
**Environment variables**
|
|
|
|
|
| Name | Default | Description |
|
|
|
|
|
|---------------|---------|---------------------------------------|
|
|
|
|
|
| PORT | 7099 | Port number to listen for connections |
|
|
|
|
|
| HOST | 0.0.0.0 | Host address to bind to |
|
|
|
|
|
| INSTANCE_NAME | BBJ | BBJ's instance name |
|
|
|
|
|
| ALLOW_ANON | true | Allow anonymous usage |
|
|
|
|
|
| DEBUG | false | Enable debugging |
|
|
|
|
|
| ADMIN | | Comma separated list of admin users |
|
