jdtron
/
bbj
forked from bbj/bbj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
244 Commits 4 Branches 0 Tags 1.5 MiB
Python 80.2%
Emacs Lisp 19%
Shell 0.6%
Dockerfile 0.1%
Go to file
jdtron 9b7ddddca2 Update readme 2023-03-17 10:14:50 +01:00
clients tildeverse 2019-02-26 10:51:20 -05:00
docs Set theme jekyll-theme-midnight 2018-11-09 12:17:09 -05:00
prototype initial commit of non-prototype 2017-04-02 02:35:58 -05:00
src Allow setting server admins from server's config.json 2018-08-05 19:13:41 -05:00
.dockerignore Add Docker resources 2023-03-17 10:03:56 +01:00
.gitignore update gitignore 2017-09-03 00:01:57 -05:00
Dockerfile Update default host 2023-03-17 10:12:27 +01:00
LICENSE Create LICENSE 2017-04-15 10:59:37 -05:00
Makefile Add Docker resources 2023-03-17 10:03:56 +01:00
README.md Update readme 2023-03-17 10:14:50 +01:00
config.json.example Fix config.json.example 2019-10-08 14:31:59 +00:00
dbupdate.py add new parameter to threads: last_author 2017-04-25 03:36:51 -05:00
docker-entrypoint.sh Add Docker resources 2023-03-17 10:03:56 +01:00
gendocs.sh i hate my life 2017-05-03 21:42:59 -05:00
mkendpoints.py some slight changes to docs 2017-05-03 22:22:20 -05:00
readme.png now lets work on that readme, eh? 2017-04-28 22:07:18 -05:00
schema.sql add new parameter to threads: last_author 2017-04-25 03:36:51 -05:00
server.py Fix stupid typo preventing new configs being made. 2018-08-14 22:19:20 -05:00
setup.sh fix up if's in setup.sh 2019-03-03 17:23:55 -05:00
todo.org Add basic search support (needs a little work, btw HI MODS) 2018-07-27 17:28:34 -05:00

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/).

AAAAAAAAAAAAAAAAAAAA

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