Explain needed environment variables and add example.env
This commit is contained in:
parent
9531b3f138
commit
0671719c1b
2 changed files with 18 additions and 1 deletions
15
README.md
15
README.md
|
@ -1,3 +1,16 @@
|
||||||
# bannana pho
|
# bannana pho
|
||||||
|
|
||||||
ring ring
|
[ring ring](https://gitlab.com/litecord/litecord)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Environment Variables:
|
||||||
|
|
||||||
|
(Also found in `example.env`)
|
||||||
|
|
||||||
|
| Variable | Description | Example |
|
||||||
|
|:--------------------:|:------------------------------------------------------------:|:----------------:|
|
||||||
|
| `LISTEN_ADDR` | Listen address of the websocket | `0.0.0.0:3621` |
|
||||||
|
| `REDIS_ADDR` | Redis database address (not yet used) | `127.0.0.1:6379` |
|
||||||
|
| `SECRET` | Shared Secret, can be anything, must be the same on Litecord | `deez nuts 420` |
|
||||||
|
| `HEARTBEAT_INTERVAL` | Rate of which Litecord will send a heartbeat (in seconds) | `1` |
|
4
example.env
Normal file
4
example.env
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
LISTEN_ADDR=
|
||||||
|
REDIS_ADDR=
|
||||||
|
SECRET=
|
||||||
|
HEARTBEAT_INTERVAL=
|
Loading…
Add table
Reference in a new issue