config

Documentation

Index

• Constants
• Variables
• func Load(path string, conf interface{}) error
• type Agent
  • func (conf *Agent) Check() error
• type AgentAuth
• type Forward
• type LetsEncrypt
• type Server
  • func (conf *Server) Check() error

Constants

const BufferSize = 1500

BufferSize is the max size of a single message transferred via a tunnel. This should be sufficiently large to prevent fragmentation.

Variables

var AgentDefault = Agent{
	GatewayURL: "ws://localhost:9000",
}

AgentDefault is a default agent configuration.

var ServerDefault = Server{
	ControlAddress: "localhost:9000",
	LetsEncrypt:    LetsEncrypt{CacheDir: ".autocert_cache"},
}

ServerDefault is a default server configuration.

Functions

func Load

func Load(path string, conf interface{}) error

Load loads a YAML document from a file and fills in corresponding fields of conf variable. Default values given in the variable are honored.

Types

type Agent

type Agent struct {
	GatewayURL string    `yaml:"gateway_url"`
	AuthKey    string    `yaml:"auth_key"`
	Forwards   []Forward `yaml:"forwards"`
}

Agent represnets a configuration of a reverse tunnel agent program.

func (*Agent) Check

func (conf *Agent) Check() error

Check checks agent config for obvious mistakes. Returns a non-nil error if a bad configuration is found.

type AgentAuth

type AgentAuth struct {
	AuthKey string          `yaml:"auth_key"`
	Ports   []ports.NetPort `yaml:"ports"`
}

AgentAuth represents an agent and its access rights authorized in a reverse tunnel server program.

type Forward

type Forward struct {
	Port        ports.NetPort `yaml:"port"`
	Destination string        `yaml:"destination"`
}

Forward represents a configuration of a single port forwarding.

type LetsEncrypt

type LetsEncrypt struct {
	Domain   string `yaml:"domain"`
	CacheDir string `yaml:"cache_dir"`
}

LetsEncrypt represents autocert configuration for the server.

type Server

type Server struct {
	ControlAddress string      `yaml:"control_address"`
	LetsEncrypt    LetsEncrypt `yaml:"lets_encrypt"`
	Agents         []AgentAuth `yaml:"agents"`
}

Server represents a configuration of a reverse tunnel server program.

func (*Server) Check

func (conf *Server) Check() error

Check checks agent config for obvious mistakes. Returns a non-nil error if a bad configuration is found.