diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b25ba3c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +0.7.1. +- Added line and comment to set a default value for start to use the daemon with any WOL-client that can send a standard Magic Packet to wake up by MAC address + +General +- Before enabling the service, test the script on the command line! (make it executable) +- Stop the running process with CTRL-Z +- Kill the process (otherwise no further instance can be started due to used address)# v0.7 (2020-12-02) - Fixup dependency check, added Reboot command, changed from GPLv2 to GPLv3 + +0.6 (2020-12-02) - Check for missing dependencies + +0.5 - nothing changed + +0.4 - nothing changed + +0.3 (2016-03-11) - Parameter parsing, help extended, some beautifyings + +0.2 (2016-03-07) - Renamed dosthol to dosthold, created client dostholc, finished more commands, turned to socat + +0.1 (2016-03-06) - Initial work; starting virtual machines per wake-on-lan works \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e67d04 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# dosthol - Do something on LAN + +Skript to do something with remote virtual machines +Written primarily for Proxmox VE >=v4.x + +All thanks and credits to Oliver Jaksch + +Discussion: [Proxmox forum](https://forum.proxmox.com/threads/update-wake-and-other-on-lan-for-vms-v0-3.26381/) + +## Linux install + +```sh +# Update package list: +apt-get update + +# Installation dependency: +apt install gawk socat xxd vim + +# Change file permissions +cp dosthol.service.app /etc/systemd/system/dosthol.service + +# Change file permissions +chmod +s /etc/systemd/system/dosthol.service + +# enable dosthol +systemctl enable dosthol + +# status dosthol +systemctl status dosthol +``` +## Usage + +``` + dostholc - The dosthol client, v0.7 + Call it with at least two parameters, like 'dostholc -f FUNCTION -m MAC' + Possible parameters are + -f | --function (one of wakeup|shutdown|poweroff|suspend|resume|reboot|reset (n/a for lxc)) + -m | --mac (MAC address in the form of 11:22:33:44:55:66) + -v | --verbose (0 for no output (default), 1 for some output) + -i | --ip (255.255.255.255 (default) for broadcast on actual subnet - or enter another IP or subnet) +``` +Example: +```sh +./dostholc.sh -f wakeup -m AA:BB:CC:DD:EE:FF -i 192.168.0.100 -v 1 +``` + +## Dependencies + +- PVE v4.x +- vim +- socat +- gawk +- xxd \ No newline at end of file