added documentation for WoLBeacon, fixed the config file path

This commit is contained in:
Izaya 2019-10-24 02:01:25 +11:00
parent d8b6501b57
commit 0aaccb9e8f
5 changed files with 40 additions and 2 deletions

1
WoLBeacon/OpenOS/README.md Symbolic link
View File

@ -0,0 +1 @@
usr/man/wolbeacon

View File

@ -12,7 +12,7 @@ cfg.port = 3442
cfg.message = "WoLBeacon"
local function saveConfig()
local f = io.open("/etc/wolbeacon.lua","wb")
local f = io.open("/etc/wolbeacon.cfg","wb")
if not f then
return false
end
@ -27,7 +27,7 @@ local function broadcast()
end
local function loadConfig()
local f = io.open("/etc/wolbeacon.lua","rb")
local f = io.open("/etc/wolbeacon.cfg","rb")
if not f then
saveConfig()
return false

View File

@ -0,0 +1,27 @@
# WoLBeacon for OpenOS
WoLBeacon is an OpenOS rc daemon to wake other machines up, and make sure yours can be woken up.
## Usage
WoLBeacon can be managed as an rc service:
```
rc wolbeacon start
rc wolbeacon stop
rc wolbeacon reload
rc wolbeacon enable
rc wolbeacon disable
```
You will most likely want to start and enable the service.
## Configuration
WoLBeacon's configuration file can be found in */etc/wolbeacon.cfg*, containing a number of fields:
- **broadcast**: Whether to broadcast Wake-on-LAN packets.
- **receive**: Whether to configure the local network interfaces to receive Wake-on-LAN messages.
- **message**: The Wake-on-LAN message to listen for and broadcast.
- **port**: The port to broadcast Wake-on-LAN messages on.
- **delay**: The interval between sending Wake-on-LAN messages.

9
WoLBeacon/README.md Normal file
View File

@ -0,0 +1,9 @@
# WoLBeacon
WoLBeacon is a piece of software written to wake other computers up, and keep them awake, like force-feeding your friends coffee.
This is achieved by both setting the wake message for the local machine, and broadcasting wake-on-LAN messages at regular intervals.
## [WoLBeacon for OpenOS](OpenOS/)
WoLBeacon is implemented as an rc daemon for OpenOS.

View File

@ -131,6 +131,7 @@
["wolbeacon"] = {
files = {
["master/WoLBeacon/OpenOS/etc/rc.d/wolbeacon.lua"] = "//etc/rc.d",
["master/WoLBeacon/OpenOS/usr/man/wolbeacon"] = "/man",
},
name = "WoL Beacon",
description = "Wake on LAN daemon",