diff options
| author | FxQnLr <[email protected]> | 2024-04-10 12:20:17 +0200 |
|---|---|---|
| committer | FxQnLr <[email protected]> | 2024-04-10 12:20:17 +0200 |
| commit | bd5ed2f47fe870776783a5b2a56c899126a51860 (patch) | |
| tree | 398fa227d8df143ebf5d4ecfe8b6f03f88022e65 /README.md | |
| parent | 3428a637ce420baef9aa9f9803e71bd587867005 (diff) | |
| download | webol-bd5ed2f47fe870776783a5b2a56c899126a51860.tar webol-bd5ed2f47fe870776783a5b2a56c899126a51860.tar.gz webol-bd5ed2f47fe870776783a5b2a56c899126a51860.zip | |
Closes #29. Usable Readme and hopefully versioned container
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 23 insertions, 4 deletions
| @@ -1,9 +1,28 @@ | |||
| 1 | # webol | 1 | # webol |
| 2 | 2 | ||
| 3 | DATABASE_URL: `String` | 3 | ## Config |
| 4 | Default `config.toml`: | ||
| 5 | ```toml | ||
| 6 | serveraddr = "0.0.0.0:7229" # String | ||
| 7 | pingtimeout = 10 # i64 | ||
| 8 | pingthreshold = 1 # i64 | ||
| 9 | timeoffset = 0 # i8 | ||
| 4 | 10 | ||
| 5 | WEBOL_APIKEY: `String` | 11 | [auth] |
| 12 | method = "none" # "none"|"key" | ||
| 13 | secret = "" # String | ||
| 14 | ``` | ||
| 6 | 15 | ||
| 7 | WEBOL_SERVERADDR: `Option<String>` (0.0.0.0:7229) | 16 | ## Docker |
| 8 | 17 | ||
| 9 | WEBOL_PINGTIMEOUT: `Option<i64>` (10) | 18 | minimal `docker-compose.yaml`: |
| 19 | ```yaml | ||
| 20 | services: | ||
| 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 | ``` | ||