heathcliff26/netrouse repository overview

⁠NetRouse

This is a simple utility for sending Wake-On-Lan magic packet to clients in the local network. It can be used directly via the cli, or remotely via a web interface.

⁠Table of Contents

• NetRouse⁠
  • Table of Contents⁠
  • Usage⁠
    • CLI Args⁠
    • Using the image⁠
      • Permissions for ping functionality⁠
    • Image location⁠
    • Tags⁠
  • Configuration⁠
  • Development⁠
  • Credit⁠

⁠Usage

⁠CLI Args

$ netrouse help
NetRouse power on other devices on the network via Wake-on-Lan

Usage:
  netrouse [flags]
  netrouse [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  server      Serve a frontend via gui
  version     Print version information and exit
  wol         Send a magic packet to the given mac address

Flags:
  -h, --help   help for netrouse

Use "netrouse [command] --help" for more information about a command.

⁠Using the image

When using the container image, please note that the server needs to run with --net host to send the magic packets.

$ podman run -d --net host -v /path/to/config.yaml:/config/config.yaml ghcr.io/heathcliff26/netrouse:latest

If you want to use it with persistent data, run it with -v netrouse-data:/data. With the default configuration it will write data to /data/hosts.yaml.

The image can be run without configuration, it will simply use the default values.

⁠Permissions for ping functionality

If you encounter socket: permission denied errors when checking if a host is online, you might need to run sudo sysctl -w net.ipv4.ping_group_range="0 2147483647.

⁠Image location

⁠Tags

There are different flavors of the image:

⁠Configuration

An example configuration with comments and default values for the server can be found here⁠.

The default paths for the configuration file are: - standalone: /etc/netrouse/config.yaml - in container: /config/config.yaml

⁠Development

When changing the frontend, use the original bootstrap file static/bootstrap/bootstrap.css and not the trimmed version static/css/bootstrap.css

⁠Credit

For CSS bootstrap is used: Website⁠ | Github⁠ | Documentation⁠

To trim the bootstrap file purgecss is used: Website⁠ | Github⁠ | Documentation⁠

The favicon base is from bootstrap: Power Button⁠

For generating the different icons: RealFaviconGenerator⁠