jdtron
/
bbj
forked from bbj/bbj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

This commit is contained in:
jdtron 2023-03-17 10:14:50 +01:00
parent 1dfcf1d9c3
commit 9b7ddddca2
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -13,3 +13,23 @@ serve HTML but this is planned for the (distant?) future.
The two official client implementations are a stand alone TUI client for 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 the unix terminal, and GNU Emacs. The API is simple and others are welcome
to join the party at some point. to join the party at some point.
## 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 |