Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fussel178 committed Mar 5, 2022
1 parent 8d4369d commit 0bda436
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# php-wol-redirector
Sends a WOL packet to the specified host on website request and redirects to the hosted website after a timeout

Sends a WOL packet to the specified host on website request and redirects to the hosted website after a timeout.

## Installation

1. Copy it to your hosting solution.
2. Copy the `config.sample.json` to `config.json`.
3. Edit the `config.json` to your liking.
4. Replace the links that point to the devices that are WoL capable.
> Hint: Use the `./encode_url.php` script to generate the parameters.
## `config.json` definition

| Key | Description |
|------------|------------------------------------------------------------------------------|
| `host.mac` | The MAC address of the adapter that you want to wake (get it with `ip addr`) |
| `host.ip` | The IP address of the device you want to wake (only used for routing) |
| `timeout` | The timeout between refreshes in the browser |

0 comments on commit 0bda436

Please sign in to comment.