https://github.com/imyelo/wolth
:zzz: Wake on LAN through HTTP
https://github.com/imyelo/wolth
wake wake-on-lan wol
Last synced: 6 months ago
JSON representation
:zzz: Wake on LAN through HTTP
- Host: GitHub
- URL: https://github.com/imyelo/wolth
- Owner: imyelo
- License: apache-2.0
- Created: 2019-06-19T20:37:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T00:47:57.000Z (almost 3 years ago)
- Last Synced: 2025-04-03T15:45:33.136Z (6 months ago)
- Topics: wake, wake-on-lan, wol
- Language: JavaScript
- Homepage:
- Size: 1.09 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# wolth
> :zzz: Wake on LAN through HTTP
## Get Started
1. Clone the project to the server machine
```bash
$ git clone https://github.com/imyelo/wolth.git
```
2. Install dependencies
```bash
$ 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
```bash
$ WOLTH_MAC="12:34:56:78:9a:bc" npm start
```
or set environment variables in `.env` file:
```bash
$ echo "WOLTH_MAC = 12:34:56:78:9a:bc" > .env
$ npm start
```
4. Wake from machine
```bash
$ 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:
```ini
WOLTH_MAC = 12:34:56:67:9a:bc
```
Full config: in `.env` file
```ini
# .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](https://github.com/imyelo), 2019 - present