55 lines
No EOL
1.2 KiB
Markdown
55 lines
No EOL
1.2 KiB
Markdown
# hass-wol
|
||
|
||
> Wake-on-LAN (WoL) for your Home Assistant
|
||
|
||
## Usage
|
||
|
||
This tool is intended to be used as a companion container to the Home Assistant container.
|
||
|
||
Your `docker-compose.yml` may look like this:
|
||
|
||
```yaml
|
||
version: "3.9"
|
||
|
||
services:
|
||
homeassistant:
|
||
image: "homeassistant/home-assistant"
|
||
# ...
|
||
|
||
hass-wol:
|
||
image: "git.moritzruth.de/moritzruth/hass-wol:1.0.0"
|
||
restart: unless-stopped
|
||
network_mode: host # this is required because WoL uses UDP broadcast packets
|
||
volumes:
|
||
- "./hass-wol.toml:/config.toml:ro"
|
||
- "./data:/data" # persistent data
|
||
```
|
||
|
||
And your `hass-wol.toml` like this:
|
||
|
||
```toml
|
||
broadcast_address = "255.255.255.255" # don’t change this if you don’t need to
|
||
|
||
[mqtt]
|
||
host = "MQTT_BROKER_IP_ADDRESS"
|
||
port = 1883
|
||
client_id = "hass-wol"
|
||
credentials = { user = "USER", password = "PASSWORD" }
|
||
|
||
[[host]]
|
||
display_name = "my_pc"
|
||
mac_address = "04:1B:BF:2D:C7:70"
|
||
|
||
[[host]]
|
||
display_name = "my_server"
|
||
mac_address = "20:5D:48:98:94:C0"
|
||
|
||
# These options are optional.
|
||
# hass_identifiers = [] # see https://www.home-assistant.io/integrations/button.mqtt/#identifiers
|
||
# packet_count = 6
|
||
# ms_between_packets = 500
|
||
```
|
||
|
||
## License
|
||
|
||
hass-wol is licensed under the [Blue Oak Model License 1.0.0](./LICENSE.md). |