@@ -85,32 +85,34 @@ Environment variables:
8585
8686The ` 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.
8787
88- | Field | Type | Required | Description |
89- | -------------- | ------- | ------------------------ | ------------------------------------------------------------------------------- |
90- | ` ip ` | string | Yes | The IP address of the host. Required for all types. |
91- | ` mac ` | string | Required for PHYSICAL | MAC address for Wake-on-LAN. Only needed for physical hosts. |
92- | ` id ` | string | Required for VIRTUAL | Identifier for virtual machines or LXCs. |
93- | ` virtIP ` | string | Optional | IP of the VM/LXC for the wake API. Defaults to ` ip ` . |
94- | ` startupTime ` | number | Optional | Seconds to wait after starting before forwarding traffic. |
95- | ` url ` | string | Optional | Override the default helper URL for this host. |
96- | ` docker ` | object | Required for DOCKER type | Docker-specific settings. See below. |
97- | ` docker: true ` | boolean | Optional | Can be set to ` true ` to mark a host as DOCKER type without additional settings. |
98-
99- ## Docker Sub-Object
88+ | Field | Type | Required | Description |
89+ | -------------- | ------- | ------------------------ | ------------------------------------------------------------------------------------------------------- |
90+ | ` ip ` | string | Yes | The IP address of the host. Used for all types; typically used for ping checks and default connections. |
91+ | ` mac ` | string | Required for PHYSICAL | MAC address for Wake-on-LAN. Only needed for physical hosts. |
92+ | ` addr ` | string | Optional, PHYSICAL only | The network address used to send WoL packets, if different from ` ip ` or subnet. |
93+ | ` id ` | string | Required for VIRTUAL | Identifier for virtual machines or LXCs. |
94+ | ` virtIP ` | string | Optional | IP of the VM/LXC for the wake API. Defaults to ` ip ` . |
95+ | ` startupTime ` | number | Optional | Seconds to wait after starting before forwarding traffic. |
96+ | ` url ` | string | Optional | Override the default helper URL for this host. |
97+ | ` docker ` | object | Required for DOCKER type | Docker-specific settings. See below. |
98+ | ` docker: true ` | boolean | Optional | Can be set to ` true ` to mark a host as DOCKER type without additional settings. |
99+
100+ ### Docker Sub-Object
100101
101102| Field | Type | Required | Description |
102103| -------------- | ------ | -------- | ------------------------------------------------------------------------------------------ |
103104| ` queryPattern ` | string | Optional | Template used to build the query for WoL Dockerized. Falls back to ` ENV.woldQueryPattern ` . |
104105| ` url ` | string | Optional | Override URL for Docker wake API. Defaults to ` http://${host.ip}:${ENV.woldPort}/wake ` . |
105106
106- ## Host Type Inference
107+ ### Host Type Inference
107108
108109- ** PHYSICAL** → has ` mac ` and ` ip `
109110- ** VIRTUAL** → has ` id `
110111- ** DOCKER** → has ` docker ` object or ` docker: true `
111112
112- ## Notes on Optional Overrides
113+ ### Notes on Optional Overrides
113114
115+ - ` addr ` allows sending WoL packets to a different network address than ` ip ` , useful for hosts behind different subnets or NAT.
114116- ` url ` can override default helper URLs for PHYSICAL, VIRTUAL, or DOCKER hosts.
115117- ` virtIP ` can override the IP used by virtual helper services.
116118- ` docker.queryPattern ` can override the global ` ENV.woldQueryPattern ` .
0 commit comments