wol-relay

Crates.iowol-relay
lib.rswol-relay
version0.2.1
created_at2025-08-02 15:22:10.0185+00
updated_at2025-08-02 20:39:19.141587+00
descriptionA Wake-on-LAN relay server.
homepage
repositoryhttps://github.com/Finomnis/wol-relay
max_upload_size
id1778925
size38,988
(Finomnis)

documentation

README

wol-relay

Crates.io Crates.io License Build Status docs.rs

A Wake-on-LAN relay server written in Rust.

Provides the ability to wake computers in the subnet of the relay server from other subnets.

Technical Details

While WoL messages can be embedded in any payload, its most common form is as a 102 byte UDP packet to port 9, which is what this server is listening for.

If WoL messages do not get picked up by this relay server, make sure they are not using a different port, protocol or format.

Run as binary

cargo install wol-relay --features cli

Then, simply running wol-relay will run the relay server.

Use wol-relay --help for configuration options.

Run as docker container

docker run --rm -ti --network host ghcr.io/finomnis/wol-relay -v

Run via docker-compose

version: '2'
services:
  wol-relay:
    container_name: wol-relay
    image: ghcr.io/finomnis/wol-relay
    restart: 'unless-stopped'
    network_mode: 'host'
    command:
      - '-v' # Print more logs; repeat for even more

Contributions

Contributions are welcome!

I primarily wrote this crate for my own convenience, so any ideas for improvements are greatly appreciated.

Commit count: 0

cargo fmt