Skip to content

Commit 8a1d48d

Browse files
Update README.md
1 parent 67f5b47 commit 8a1d48d

1 file changed

Lines changed: 3 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -249,16 +249,17 @@ The `hosts` section defines all machines, VMs, containers, or Docker services th
249249
| `mac` | string | Required for PHYSICAL | MAC address for Wake-on-LAN. Only needed for physical hosts. |
250250
| `addr` | string | Optional, PHYSICAL only | The network address used to send WoL packets, if different from `ip`. |
251251
| `id` | string | Required for VIRTUAL | Identifier for virtual machines or LXCs. |
252-
| `virtIP` | string | Optional | IP of the VM/LXC. Defaults to `ip`. |
252+
| `virtIP` | string | Optional | IP of the VM/LXC, used for pings. Defaults to `ip`. |
253253
| `startupTime` | number | Optional | Seconds to wait after starting before pinging IP. |
254254
| `url` | string | Optional | Override the default helper URL for this host. |
255255
| `docker: true` | boolean | Optional | Can be set to `true` to mark a host as DOCKER type without additional settings. |
256256
| `docker` | object | Required for DOCKER type | Docker-specific settings. See below. |
257257

258-
### Docker Sub-Object
258+
### Docker Sub-Object (`docker`)
259259

260260
| Field | Type | Required | Description |
261261
| -------------- | ------ | -------- | ------------------------------------------------------------------------------------------ |
262+
| `query` | string | Optional | Raw query used for WoL Dockerized. Skips building query with `queryPattern`. |
262263
| `queryPattern` | string | Optional | Template used to build the query for WoL Dockerized. Falls back to `ENV.woldQueryPattern`. |
263264
| `url` | string | Optional | Override URL for Docker wake API. Defaults to `http://${host.ip}:${ENV.woldPort}/wake`. |
264265

@@ -268,14 +269,6 @@ The `hosts` section defines all machines, VMs, containers, or Docker services th
268269
- **VIRTUAL** → has `id`
269270
- **DOCKER** → has `docker` object or `docker: true`
270271

271-
### Notes on Optional Overrides
272-
273-
- `addr` allows sending WoL packets to a different network address than `ip`, useful for hosts behind different subnets or NAT.
274-
- `url` can override default helper URLs for PHYSICAL, VIRTUAL, or DOCKER hosts.
275-
- `virtIP` can override the IP used for pings.
276-
- `docker.queryPattern` can override the global `ENV.woldQueryPattern`.
277-
- The execution order of hosts in a route determines the startup sequence.
278-
279272
## Advanced Setups
280273

281274
WoL Redirect supports two main scenarios depending on how your services are hosted.

0 commit comments

Comments
 (0)