wolth v0.3.0

wolth

:zzz: Wake on LAN through HTTP

Get Started

1. Clone the project to the server machine

   $ git clone https://github.com/imyelo/wolth.git

2. Install dependencies

   $ cd wolth
   $ yarn

3. Start server, the WOLTH_MAC is the MAC address of the machine you want to wake but not the server's

   $ WOLTH_MAC="12:34:56:78:9a:bc" npm start

   or set environment variables in .env file:

   $ echo "WOLTH_MAC = 12:34:56:78:9a:bc" > .env
   $ npm start

4. Wake from machine

   $ curl -X POST http://127.0.0.1:3000

You can now wake the machine from anywhere with a simple POST request as long as the server is acceptable from outside. :tada:

Configuration

Environment variables:

• PORT:
  • optional, default value is 3000
  • the port of wolth server listening
• WOLTH_MAC:
  • required
  • the MAC address of the machine you want to wake
• WOLTH_ADDRESS:
  • optional, default value is '255.255.255.255'
• WOLTH_PORT:
  • optional, default value is 9

Configuration Example

Minimal config in .env file:

WOLTH_MAC = 12:34:56:67:9a:bc

Full config: in .env file

# .env
PORT = 8080
WOLTH_MAC = 12:34:56:67:9a:bc
WOLTH_ADDRESS = 192.168.1.10
WOLTH_PORT = 7

License

Apache-2.0 © yelo, 2019 - present