miniwol/README.md

25 lines
941 B
Markdown
Raw Permalink 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-18 14:48:52 +00:00
Option 1: Run `go build` in this repository, results in a binary `./miniwol`.
2022-02-18 14:34:33 +00:00
2022-02-18 14:48:52 +00:00
Option 2: Run `go get git.ulra.eu/adro/miniwol`, results in a binary `~/go/bin/miniwol`.
2022-02-18 14:34:33 +00:00
2022-02-18 14:48:52 +00:00
Move the binary to e.G. `/usr/bin/miniwol` to run it like any command,
2022-02-18 14:34:33 +00:00
2022-02-18 14:18:44 +00:00
## Usage
2022-02-18 14:48:52 +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.
2022-02-18 14:18:44 +00:00
2022-02-18 14:48:52 +00:00
Set a password using `miniwol setpass <password>`. This will also add any missing fields defaults to the config.
2022-02-18 14:18:44 +00:00
2022-02-18 14:34:33 +00:00
Configure the devices you want to be able to wake up as per the [example](./example/config.toml).
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.