config

Documentation

Index

• Constants
• Variables
• func New(c Config, inst Instance) (process.Runnable, error)
• type Config
• type ConnHandler
• type Instance
• type Service

Constants

const DefaultWatchServiceAddr = "wss://watch.connect.api.minekube.com"

Variables

var DefaultConfig = Config{
	Enabled:                false,
	WatchServiceAddr:       DefaultWatchServiceAddr,
	Name:                   xid.New().String(),
	EnforcePassthrough:     false,
	AllowUnencryptedTunnel: false,
	Service: Service{
		Enabled:                 false,
		Addr:                    "localhost:8443",
		PublicTunnelServiceAddr: "ws://localhost:8080/tunnel",
		OverrideRegistration:    false,
	},
}

DefaultConfig is a default Config.

Functions

func New

func New(c Config, inst Instance) (process.Runnable, error)

New validates the config and creates a process collection from it.

Types

type Config

type Config struct {
	Enabled                bool // Whether to connect Gate to the WatchService
	Name                   string
	EnforcePassthrough     bool // Setting to true will reject all sessions in non-passthrough mode.
	WatchServiceAddr       string
	AllowUnencryptedTunnel bool

	Service Service
}

Config is the config for Connect.

type ConnHandler

type ConnHandler interface {
	HandleConn(conn net.Conn)
}

type Instance

type Instance interface {
	proxy.ServerRegistry
	ConnHandler
}

type Service

type Service struct {
	Enabled bool
	Addr    string // The address all services listen on.
	// The address provided to endpoints in session proposals.
	// If not specified falls back to Services.Addr.
	PublicTunnelServiceAddr string
	// Overrides servers with the same name.
	OverrideRegistration bool
}

Service is a config for defining self-hosted Connect service for single-instance use.