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

update README.md

Browse Source
This commit is contained in:
adro 2022-02-18 15:48:52 +01:00
parent ffe8d01b06
commit 319c8dfcfb
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,5 +1,4 @@
# miniwol
Small web server to send Wake-on-LAN requests to its local network
## Features
@ -7,19 +6,19 @@ 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 folder after cloning, resulting in a binary `miniwol` in the current directory.
Option 1: Run `go build` in this repository, results in a binary `./miniwol`.
Option 2: Run `go get git.ulra.eu/adro/miniwol`, resulting in a binary in TODO.
Option 2: Run `go get git.ulra.eu/adro/miniwol`, results in a binary `~/go/bin/miniwol`.
Put the resulting binary in a place like `/usr/bin/miniwol` if you wish to run it like any command,
Move the binary to e.G. `/usr/bin/miniwol` to run it like any command,
## Usage
Add an empty config, the program checks, in order of priority, for `./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.
Set a password and write its hash to the config using `miniwol setpass <password>`. This will also add the other default fields to the config.
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).
Now you can run the webserver using `miniwol` or `miniwol web` .
Run the webserver using `miniwol` or `miniwol web` .
Sessions are simply stored in memory. In case you need to, you can clear all sessions by just restarting the webserver.
Sessions are in-memory. Restarting the webserver clears all sessions.