config

Documentation

Index

• func HasInstance() bool
• func SetInstance(cfg ConfigInstance)
• func Validate(data []byte) gperr.Error
• type Config
  • func DefaultConfig() *Config
• type ConfigInstance
  • func GetInstance() ConfigInstance
• type Entrypoint
• type HomepageConfig
• type Providers

Functions

func HasInstance

func HasInstance() bool

func SetInstance

func SetInstance(cfg ConfigInstance)

func Validate

func Validate(data []byte) gperr.Error

Types

type Config

type Config struct {
	ACL             *acl.Config      `json:"acl"`
	AutoCert        *autocert.Config `json:"autocert"`
	Entrypoint      Entrypoint       `json:"entrypoint"`
	Providers       Providers        `json:"providers"`
	MatchDomains    []string         `json:"match_domains" validate:"domain_name"`
	Homepage        HomepageConfig   `json:"homepage"`
	TimeoutShutdown int              `json:"timeout_shutdown" validate:"gte=0"`
}

func DefaultConfig

func DefaultConfig() *Config

type ConfigInstance

type ConfigInstance interface {
	Value() *Config
	Reload() gperr.Error
	Statistics() map[string]any
	RouteProviderList() []string
	Context() context.Context
	GetAgent(agentAddrOrDockerHost string) (*agent.AgentConfig, bool)
	VerifyNewAgent(host string, ca agent.PEMPair, client agent.PEMPair) (int, gperr.Error)
	ListAgents() []*agent.AgentConfig
	AutoCertProvider() *autocert.Provider
}

func GetInstance

func GetInstance() ConfigInstance

type Entrypoint

type Entrypoint struct {
	Middlewares []map[string]any               `json:"middlewares"`
	AccessLog   *accesslog.RequestLoggerConfig `json:"access_log" validate:"omitempty"`
}

type HomepageConfig

type HomepageConfig struct {
	UseDefaultCategories bool `json:"use_default_categories"`
}

type Providers

type Providers struct {
	Files        []string                   `json:"include" yaml:"include,omitempty" validate:"dive,filepath"`
	Docker       map[string]string          `json:"docker" yaml:"docker,omitempty" validate:"non_empty_docker_keys,dive,unix_addr|url"`
	Agents       []*agent.AgentConfig       `json:"agents" yaml:"agents,omitempty"`
	Notification []notif.NotificationConfig `json:"notification" yaml:"notification,omitempty"`
	Proxmox      []proxmox.Config           `json:"proxmox" yaml:"proxmox,omitempty"`
}