traefik_wol

README

traefik-wol

Traefik plugin which starts a machine when a request is received using wake-on-lan. Based somewhat on go-wol.

Operation modes

Using the built-in wake-on-lan service

In this mode, the plugin will try to start the machine using the wake-on-lan service provided by the plugin. For this to work, the plugin needs to be able to send a magic packet to the machine. This means that the machine needs to be on the same network as the plugin. In other words, when using docker the network mode needs to be host.

Dynamic configuration example:

http:
  middlewares:
    traefik-wol:
      plugin:
        wol:
          healthCheck: http://192.168.0.10:8009 # REQUIRED The URL to use for the health check
          macAddress: 00:00:00:00:00:00 # REQUIRED The MAC address of the machine to start
          ipAddress: 192.168.0.10 # REQUIRED The IP address of the machine to start

Using an external wake-on-lan service

In order to not have to run the plugin in host mode, you can use an external wake-on-lan service. This service needs to be able to send a magic packet to the machine. The plugin will then send a request to the service to start the machine.

A service that can be used for this is docker-wol_api.

Dynamic configuration example:

http:
  middlewares:
    traefik-wol:
      plugin:
        wol:
          healthCheck: http://192.168.0.10:8009 # REQUIRED The URL to use for the health check
          #REQUIRED The URL to use for the start request
          # This is the URL of the "wake" service
          startUrl: http://192.168.0.11:8081/wol/00:00:00:00:00:00
          startMethod: POST # The method to use for the start request
          numRetries: 5 # The number of retries
          requestTimeout: 5 # The request timeout in seconds

Automatically stopping the machine after a period of inactivity

The plugin can automatically stop the machine after a period of inactivity. This is done by sending a request to the machine to stop itself.

A service that can be used for this is sleep-on-lan.

Dynamic configuration example:

http:
  middlewares:
    traefik-wol:
      plugin:
        wol:
          healthCheck: http://192.168.0.10:8009 # REQUIRED The URL to use for the health check
          # REQUIRED The URL to use for the start request
          # This is the URL of the "wake" service
          startUrl: http://192.168.0.11:8081/wol/00:00:00:00:00:00
          startMethod: POST # The method to use for the start request
          numRetries: 5 # The number of retries
          requestTimeout: 5 # The request timeout in seconds
          stopTimeout: 5 # The number of minutes to wait before stopping the server
          stopUrl: http://192.168.0.10:8009/sleep # The URL to use for the stop request

Documentation

Index

• func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error)
• type Config
  • func CreateConfig() *Config
• type Wol
  • func (a *Wol) ServeHTTP(rw http.ResponseWriter, req *http.Request)

Functions

func New

func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error)

New created a new Demo plugin.

Types

type Config

type Config struct {
	MacAddress         string `json:"macAddress,omitempty"`
	IpAddress          string `json:"ipAddress,omitempty"`
	StartUrl           string `json:"startUrl,omitempty"`
	StartMethod        string `json:"startMethod,omitempty"`
	StopUrl            string `json:"stopUrl,omitempty"`
	StopMethod         string `json:"stopMethod,omitempty"`
	StopTimeout        int    `json:"stopTimeout,omitempty"`
	HealthCheck        string `json:"healthCheck,omitempty"`
	BroadcastInterface string `json:"broadcastInterface,omitempty"`
	RequestTimeout     int    `json:"requestTimeout,omitempty"`
	NumRetries         int    `json:"numRetries,omitempty"`
}

Config the plugin configuration.

func CreateConfig

func CreateConfig() *Config

CreateConfig creates the default plugin configuration.

type Wol

type Wol struct {
	// contains filtered or unexported fields
}

Wol a Demo plugin.

func (*Wol) ServeHTTP

func (a *Wol) ServeHTTP(rw http.ResponseWriter, req *http.Request)