You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
2 weeks ago | |
---|---|---|
clients | 4 years ago | |
docs | 4 years ago | |
prototype | 6 years ago | |
src | 5 years ago | |
.dockerignore | 2 weeks ago | |
.gitignore | 6 years ago | |
Dockerfile | 2 weeks ago | |
LICENSE | 6 years ago | |
Makefile | 2 weeks ago | |
README.md | 2 weeks ago | |
config.json.example | 4 years ago | |
dbupdate.py | 6 years ago | |
docker-entrypoint.sh | 2 weeks ago | |
gendocs.sh | 6 years ago | |
mkendpoints.py | 6 years ago | |
readme.png | 6 years ago | |
schema.sql | 6 years ago | |
server.py | 5 years ago | |
setup.sh | 4 years ago | |
todo.org | 5 years ago |
README.md
Bulletin Butter & Jelly
BBJ is a trivial collection of python scripts and database queries that miraculously shit out a fully functional, text-driven community bulletin board. Requires Python 3.4 and up for the server and the official TUI client (clients/urwid/).
Look Ma, it boots !!11!
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.
Docker
Database
Initialize with
/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 |