From bd5ed2f47fe870776783a5b2a56c899126a51860 Mon Sep 17 00:00:00 2001
From: FxQnLr <felixquinn03@gmail.com>
Date: Wed, 10 Apr 2024 12:20:17 +0200
Subject: Closes #29. Usable Readme and hopefully versioned container

---
 README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index eabc051..88f786a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,28 @@
 # webol
 
-DATABASE_URL: `String`
+## Config
+Default `config.toml`:
+```toml
+serveraddr = "0.0.0.0:7229" # String
+pingtimeout = 10 # i64
+pingthreshold = 1 # i64
+timeoffset = 0 # i8
 
-WEBOL_APIKEY: `String`
+[auth]
+method = "none" # "none"|"key"
+secret = "" # String
+```
 
-WEBOL_SERVERADDR: `Option<String>` (0.0.0.0:7229)
+## Docker
 
-WEBOL_PINGTIMEOUT: `Option<i64>` (10)
+minimal `docker-compose.yaml`:
+```yaml
+services:
+  webol:
+    image: ghcr.io/fxqnlr/webol:0.4.0
+    container_name: webol
+    restart: unless-stopped
+    volumes:
+      - ./devices:/devices
+    network_mode: host
+```
-- 
cgit v1.2.3