witten
/
wake-on-lan-service
1
2
Fork 0
Code Issues Pull Requests Packages Releases Activity

Capitalize LAN.

This commit is contained in:
Dan Helfman 2022-06-12 20:06:09 -07:00
parent e516f63056
commit b291c90fac
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -3,13 +3,13 @@
Remotely wake up your servers ... as-a-service! Remotely wake up your servers ... as-a-service!
**The problem:** Docker prevents bridge-networked containers from sending **The problem:** Docker prevents bridge-networked containers from sending
wake-on-lan packets outside of the Docker network. That means standard Docker wake-on-LAN packets outside of the Docker network. That means standard Docker
containers can't wake up remote machines. As a work-around, you can put them containers can't wake up remote machines. As a work-around, you can put them
on the Docker host network, but that has security and interoperability on the Docker host network, but that has security and interoperability
implications—you may not want to expose your containers that way. implications—you may not want to expose your containers that way.
**The solution:** wake-on-lan-service runs on Docker's host network and sends **The solution:** wake-on-lan-service runs on Docker's host network and sends
wake-on-lan packets *on behalf of* other containers running on a standard wake-on-LAN packets *on behalf of* other containers running on a standard
bridge network. This allows them to wake up remote machines—without themselves bridge network. This allows them to wake up remote machines—without themselves
having to be on the host network. having to be on the host network.
@ -24,12 +24,12 @@ Source at https://projects.torsion.org/witten/wake-on-lan-service
## How it works ## How it works
This service listens on a port for TCP requests containing a MAC address to This service listens on a port for TCP requests containing a MAC address to
send a wake-on-lan packet to. It expects plain TCP requests, not HTTP. send a wake-on-LAN packet to. It expects plain TCP requests, not HTTP.
## Environment variables ## Environment variables
* `PORT`: The TCP port to listen on for wake-on-lan requests, defaults to * `PORT`: The TCP port to listen on for wake-on-LAN requests, defaults to
18888. Don't forget to open this port in your firewall. 18888. Don't forget to open this port in your firewall.
@ -83,7 +83,7 @@ Alternatively, on Linux, you can try using the IP `172.17.0.1`.
### Home Assistant ### Home Assistant
If you happen to be using Home Assistant in Docker, here's how you might If you happen to be using Home Assistant in Docker, here's how you might
request wake-on-lan of a remote server via wake-on-lan-service. This example request wake-on-LAN of a remote server via wake-on-lan-service. This example
is of an automation action in your Home Assistant configuration: is of an automation action in your Home Assistant configuration:
```yaml ```yaml