config

Documentation

Index

• Variables
• type Config
  • func (c Config) Validate() (warns []error, errs []error)
• type Route
  • func (r *Route) CachePingEnabled() bool
  • func (r *Route) GetCachePingTTL() time.Duration
• type Status
  • func (s *Status) Response(protocol proto.Protocol) (*ping.ServerPing, error)

Variables

var DefaultConfig = Config{
	Enabled: false,
	Routes:  []Route{},
}

DefaultConfig is the default configuration for Lite mode.

Types

type Config

type Config struct {
	Enabled bool
	Routes  []Route
}

Config is the configuration for Lite mode.

func (Config) Validate

func (c Config) Validate() (warns []error, errs []error)

type Route

type Route struct {
	Host              configutil.SingleOrMulti[string] `json:"host" yaml:"host"`
	Backend           configutil.SingleOrMulti[string] `json:"backend" yaml:"backend"`
	CachePingTTL      configutil.Duration              `json:"cachePingTTL,omitempty" yaml:"cachePingTTL,omitempty"` // 0 = default, < 0 = disabled
	Fallback          *Status                          `json:"fallback,omitempty" yaml:"fallback,omitempty"`         // nil = disabled
	ProxyProtocol     bool                             `json:"proxyProtocol,omitempty" yaml:"proxyProtocol,omitempty"`
	RealIP            bool                             `json:"realIP,omitempty" yaml:"realIP,omitempty"`
	ModifyVirtualHost bool                             `json:"modifyVirtualHost,omitempty" yaml:"modifyVirtualHost,omitempty"`
}

func (*Route) CachePingEnabled

func (r *Route) CachePingEnabled() bool

CachePingEnabled returns true if the route has a ping cache enabled.

func (*Route) GetCachePingTTL

func (r *Route) GetCachePingTTL() time.Duration

GetCachePingTTL returns the configured ping cache TTL or a default duration if not set.

type Status

type Status struct {
	MOTD    string          `yaml:"motd,omitempty" json:"motd,omitempty"`
	Version ping.Version    `yaml:"version,omitempty" json:"version,omitempty"`
	Favicon favicon.Favicon `yaml:"favicon,omitempty" json:"favicon,omitempty"`
	ModInfo modinfo.ModInfo `yaml:"modInfo,omitempty" json:"modInfo,omitempty"`

	ParsedMOTD struct {
		Text      *component.Text `yaml:"-" json:"-"`
		sync.Once `yaml:"-" json:"-"`
	} `yaml:"-" json:"-"`
}

func (*Status) Response

func (s *Status) Response(protocol proto.Protocol) (*ping.ServerPing, error)

Response returns the configured status response.