miniwol/README.md

22 lines
871 B
Markdown
Raw Normal View History

2022-02-11 14:27:40 +00:00
# miniwol
2022-02-18 14:18:44 +00:00
Small web server to send Wake-on-LAN requests to its local network
## Features
- Fully static frontend without JS
- Binary includes everything except config
2022-02-18 14:34:33 +00:00
## Installation
2022-02-21 20:12:08 +00:00
Run `go install git.ulra.eu/adro/miniwol@latest`, resulting in a binary `~/go/bin/miniwol`.
2022-02-21 14:19:12 +00:00
Move this binary to e.G. `/usr/bin/miniwol` to run it like any command.
2022-02-18 14:34:33 +00:00
2022-02-21 15:30:48 +00:00
Examples include a simple systemd service to have it start automatically.
2022-02-18 14:34:33 +00:00
2022-02-18 14:18:44 +00:00
## Usage
2022-02-21 14:19:12 +00:00
Add an empty config. The program uses, in order of priority, `./config.toml`, `./config/config.toml` and `/etc/miniwol/config.toml`. Make sure miniwol can write to it as all persistant data is saved here.
2022-02-18 14:18:44 +00:00
2022-02-21 14:19:12 +00:00
Set a password using `miniwol setpass <password>`. This will also add any missing defaults to the config.
2022-02-18 14:34:33 +00:00
2022-02-18 14:48:52 +00:00
Run the webserver using `miniwol` or `miniwol web` .
2022-02-18 14:18:44 +00:00
2022-02-18 14:48:52 +00:00
Sessions are in-memory. Restarting the webserver clears all sessions.