A CLI tool to send Wake-On-LAN (WOL) magic packets to wake up devices on your network. Features both CLI commands and a web interface.

• Send WOL magic packets via CLI or web interface
• Configure multiple machines with names for easy access
• Configurable broadcast address and port, with per-machine overrides
• List configured machines
• Web interface for easy wake-up
• Docker support

Download the latest release for your platform from the releases page.

Available for:

• Linux (x86_64, arm64, armv7)
• macOS (x86_64, arm64)
• Windows (x86_64)

go install github.com/trugamr/wol@latest

docker run --network host -v $(pwd)/config.yaml:/etc/wol/config.yaml ghcr.io/trugamr/wol:latest

Or using docker-compose:

# Method 1: Using bind mount
services:
  wol:
    image: ghcr.io/trugamr/wol:latest
    command: serve # To start the web interface
    network_mode: "host"
    volumes:
      - ./config.yaml:/etc/wol/config.yaml

# Method 2: Using environment variables
services:
  wol:
    image: ghcr.io/trugamr/wol:latest
    command: serve # To start the web interface
    network_mode: "host"
    environment:
      WOL_CONFIG: |
        machines:
          - name: desktop
            mac: "00:11:22:33:44:55"
            ip: "192.168.1.100" # Optional, for status checking
          - name: server
            mac: "AA:BB:CC:DD:EE:FF"
            ip: "server.local"
        server:
          listen: ":7777" # Optional, defaults to :7777
        ping:
          privileged: false # Optional, set to true to use privileged ping

Check out examples/reverse-proxy.yml for an example of running wol behind reverse proxy with basic auth, https etc.

Image tags:

• latest and X.Y.Z track named releases (X.Y.Z pins a specific version).
• edge tracks the latest commit on main, for trying unreleased changes.

Create a config.yaml file in one of these locations (in order of precedence):

• ./config.yaml (current directory)
• ~/.wol/config.yaml (home directory)
• /etc/wol/config.yaml (system-wide)

To load a config file from an arbitrary path, pass -c/--config:

wol serve --config /etc/wol/config.yaml

An explicit --config file is authoritative: it must exist (wol exits with an error if it doesn't), and the default search locations above and the WOL_CONFIG environment variable are ignored. On startup serve logs which config source it loaded.

Alternatively, you can provide the configuration via the WOL_CONFIG environment variable:

export WOL_CONFIG='
machines:
  - name: desktop
    mac: "00:11:22:33:44:55"
    ip: "192.168.1.100" # Optional, for status checking
  - name: server
    mac: "AA:BB:CC:DD:EE:FF"
    ip: "server.local"

server:
  listen: ":7777" # Optional, defaults to :7777
'

Example configuration:

machines:
  - name: desktop
    mac: "00:11:22:33:44:55"
    ip: "192.168.1.100" # Optional, for status checking
  - name: server
    mac: "AA:BB:CC:DD:EE:FF"
    ip: "server.local"
    # Optional per-machine broadcast override, e.g. when this machine is on a
    # different subnet/VLAN. Unset fields inherit the global broadcast below.
    broadcast:
      address: "192.168.20.255"

server:
  listen: ":7777" # Optional, defaults to :7777

# Optional. Where magic packets are sent; defaults to 255.255.255.255:9.
broadcast:
  address: "255.255.255.255"
  port: 9

ping:
  privileged: false # Optional, set to true if you need privileged ping

By default, magic packets are sent to the broadcast address 255.255.255.255 on port 9. On a host with more than one network interface (for example WSL2, or a host with Docker bridges), the OS may send the packet out the wrong interface, so the device never receives it.

If that happens, set the broadcast address of your device's own subnet. For a device at 192.168.1.100/24 that address is 192.168.1.255. The packet is then routed out the correct interface.

You can set the broadcast target in three ways:

• Globally, under the broadcast key.
• Per machine, under a machine's own broadcast key. This is useful when machines are on different subnets. Any field you leave out falls back to the global value.
• For a single send, with the --broadcast and --port flags.

When more than one is set, the order of precedence is: CLI flag, then per-machine config, then global config, then the built-in default of 255.255.255.255:9.

# List all configured machines
wol list

# Wake up a machine by name
wol send --name desktop

# Wake up a machine by MAC address
wol send --mac "00:11:22:33:44:55"

# Override the broadcast address and port for a single send
# (for example, to reach a device on a specific subnet)
wol send --mac "00:11:22:33:44:55" --broadcast 192.168.1.255 --port 9

# Start the web interface
wol serve

# Start the web interface with an explicit config file
wol serve --config /etc/wol/config.yaml

# Show version information
wol version

The web interface is available at http://localhost:7777 when running the serve command. It provides:

• List of all configured machines
• One-click wake up buttons
• Real-time machine status monitoring (when IP is configured)
• Version information
• Links to documentation and support

# Clone the repository
git clone https://github.com/trugamr/wol.git
cd wol

# Build
go build

# Run
./wol

When running in a Docker container, the machine status feature that uses ping may not work due to permission issues. This is because the application uses pro-bing for sending pings, which requires specific Linux kernel settings.

To fix this issue, you need to set the following sysctl parameter on your host system:

sysctl -w net.ipv4.ping_group_range="0 2147483647"

To make this change persistent, add it to your /etc/sysctl.conf file.

You can also try experimenting with setting ping.privileged: true in your configuration as an alternative solution.

For more details, see issue #12.

Releases are handled by release-please. Every push to main updates a "release" pull request that bumps the version and the changelog based on the Conventional Commits in the history. Merging that pull request tags the release and triggers GoReleaser to publish the binaries and container images. Nothing is released until the release pull request is merged.

This project is licensed under the MIT License. See the LICENSE file for details.

Contributions are welcome! Feel free to open issues or submit pull requests.