Skip to content

Commit 0ed1179

Browse files
committed
2 parents f75266c + 3268555 commit 0ed1179

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -243,32 +243,34 @@ SCOPE=openid profile
243243

244244
The `hosts` section defines all machines, VMs, containers, or Docker services that WoL Redirect can wake up. Each host entry may have several optional or required fields depending on its type.
245245

246-
| Field | Type | Required | Description |
247-
| -------------- | ------- | ------------------------ | ------------------------------------------------------------------------------- |
248-
| `ip` | string | Yes | The IP address of the host. Required for all types. |
249-
| `mac` | string | Required for PHYSICAL | MAC address for Wake-on-LAN. Only needed for physical hosts. |
250-
| `id` | string | Required for VIRTUAL | Identifier for virtual machines or LXCs. |
251-
| `virtIP` | string | Optional | IP of the VM/LXC for the wake API. Defaults to `ip`. |
252-
| `startupTime` | number | Optional | Seconds to wait after starting before forwarding traffic. |
253-
| `url` | string | Optional | Override the default helper URL for this host. |
254-
| `docker` | object | Required for DOCKER type | Docker-specific settings. See below. |
255-
| `docker: true` | boolean | Optional | Can be set to `true` to mark a host as DOCKER type without additional settings. |
256-
257-
## Docker Sub-Object
246+
| Field | Type | Required | Description |
247+
| -------------- | ------- | ------------------------ | ------------------------------------------------------------------------------------------------------- |
248+
| `ip` | string | Yes | The IP address of the host. Used for all types; typically used for ping checks and default connections. |
249+
| `mac` | string | Required for PHYSICAL | MAC address for Wake-on-LAN. Only needed for physical hosts. |
250+
| `addr` | string | Optional, PHYSICAL only | The network address used to send WoL packets, if different from `ip` or subnet. |
251+
| `id` | string | Required for VIRTUAL | Identifier for virtual machines or LXCs. |
252+
| `virtIP` | string | Optional | IP of the VM/LXC for the wake API. Defaults to `ip`. |
253+
| `startupTime` | number | Optional | Seconds to wait after starting before forwarding traffic. |
254+
| `url` | string | Optional | Override the default helper URL for this host. |
255+
| `docker` | object | Required for DOCKER type | Docker-specific settings. See below. |
256+
| `docker: true` | boolean | Optional | Can be set to `true` to mark a host as DOCKER type without additional settings. |
257+
258+
### Docker Sub-Object
258259

259260
| Field | Type | Required | Description |
260261
| -------------- | ------ | -------- | ------------------------------------------------------------------------------------------ |
261262
| `queryPattern` | string | Optional | Template used to build the query for WoL Dockerized. Falls back to `ENV.woldQueryPattern`. |
262263
| `url` | string | Optional | Override URL for Docker wake API. Defaults to `http://${host.ip}:${ENV.woldPort}/wake`. |
263264

264-
## Host Type Inference
265+
### Host Type Inference
265266

266267
- **PHYSICAL** → has `mac` and `ip`
267268
- **VIRTUAL** → has `id`
268269
- **DOCKER** → has `docker` object or `docker: true`
269270

270-
## Notes on Optional Overrides
271+
### Notes on Optional Overrides
271272

273+
- `addr` allows sending WoL packets to a different network address than `ip`, useful for hosts behind different subnets or NAT.
272274
- `url` can override default helper URLs for PHYSICAL, VIRTUAL, or DOCKER hosts.
273275
- `virtIP` can override the IP used by virtual helper services.
274276
- `docker.queryPattern` can override the global `ENV.woldQueryPattern`.

0 commit comments

Comments
 (0)