adro/miniwol
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
adro 2022-02-21 15:19:12 +01:00
parent 2485c7ab7a
commit a0efbfd06b
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -6,18 +6,15 @@ Small web server to send Wake-on-LAN requests to its local network
- Binary includes everything except config
## Installation
Option 1: Run `go build` in this repository, results in a binary `./miniwol`.
Run `go get git.ulra.eu/adro/miniwol`, resulting in a binary `~/go/bin/miniwol`.
Move this binary to e.G. `/usr/bin/miniwol` to run it like any command.
Option 2: Run `go get git.ulra.eu/adro/miniwol`, results in a binary `~/go/bin/miniwol`.
Move the binary to e.G. `/usr/bin/miniwol` to run it like any command,
Examples include a simply systemd service to have it start automatically.
## Usage
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.
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.
Set a password using `miniwol setpass <password>`. This will also add any missing fields defaults to the config.
Configure the devices you want to be able to wake up as per the [example](./example/config.toml).
Set a password using `miniwol setpass <password>`. This will also add any missing defaults to the config.
Run the webserver using `miniwol` or `miniwol web` .