File tree Expand file tree Collapse file tree 2 files changed +10
-13
lines changed
Expand file tree Collapse file tree 2 files changed +10
-13
lines changed Original file line number Diff line number Diff line change @@ -8,23 +8,27 @@ An API server for use with the associated [bot software][] and
88
99## Installing
1010
11- First, make a ` config.toml ` file from the provided ` config.example.toml ` file,
12- providing it with any settings tweaks you wish to apply.
13-
14- Then, install the server package in your Python environment of choice:
11+ Install the server package in your Python environment of choice:
1512
1613``` shell
1714pip install -U ' realm_api@git+https://github.com/realm-ttrpg/api-server.git'
1815```
1916
2017## Running
2118
22- In the same directory as your ` config.toml ` file:
23-
2419``` shell
2520python -m realm_api
2621```
2722
23+ ## Configuration
24+
25+ Settings are available via the following environment variables:
26+
27+ - ` DB_URL ` - Postgres connection string
28+ - ` REALM_HOST ` - Hostname/IP to bind to
29+ - ` REALM_PORT ` - Port to bind to
30+ - ` REDIS_HOST ` - Hostname for redis server
31+
2832[ bot software ] : https://github.com/realm-ttrpg/discord-bot
2933[ tabletop roleplaying games ] : https://en.wikipedia.org/wiki/Tabletop_role-playing_game
3034[ web interface ] : https://github.com/realm-ttrpg/web-interface
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments