summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFxQnLr <[email protected]>2024-04-11 09:20:04 +0200
committerGitHub <[email protected]>2024-04-11 09:20:04 +0200
commit6b05d1a437a49db98056de7b029923e8aedf1a5a (patch)
treebc70f14cae1760e91369705273904c0de1bfbf75 /README.md
parent907e5cb5bc48899b444f7fedd85af7b5974d9a2e (diff)
parent2476e182f61d209768635e8eca6e75b4acfbd007 (diff)
downloadwebol-6b05d1a437a49db98056de7b029923e8aedf1a5a.tar
webol-6b05d1a437a49db98056de7b029923e8aedf1a5a.tar.gz
webol-6b05d1a437a49db98056de7b029923e8aedf1a5a.zip
Merge pull request #32 from FxQnLr/0.4.0
0.4.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/README.md b/README.md
index eabc051..88f786a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,28 @@
1# webol 1# webol
2 2
3DATABASE_URL: `String` 3## Config
4Default `config.toml`:
5```toml
6serveraddr = "0.0.0.0:7229" # String
7pingtimeout = 10 # i64
8pingthreshold = 1 # i64
9timeoffset = 0 # i8
4 10
5WEBOL_APIKEY: `String` 11[auth]
12method = "none" # "none"|"key"
13secret = "" # String
14```
6 15
7WEBOL_SERVERADDR: `Option<String>` (0.0.0.0:7229) 16## Docker
8 17
9WEBOL_PINGTIMEOUT: `Option<i64>` (10) 18minimal `docker-compose.yaml`:
19```yaml
20services:
21 webol:
22 image: ghcr.io/fxqnlr/webol:0.4.0
23 container_name: webol
24 restart: unless-stopped
25 volumes:
26 - ./devices:/devices
27 network_mode: host
28```