config

Documentation

Index

• type AuthConfig
• type CertAuthConfig
  • func (c *CertAuthConfig) ApplyDefaults()
• type Config
  • func (c *Config) ApplyDefaults()
  • func (c *Config) ApplyMigrations()
• type ServerConfig
  • func (c *ServerConfig) ApplyDefaults()
• type ServerRedirectConfig
• type ServerTrustedProxies
  • func (v ServerTrustedProxies) AsIPNet() []*net.IPNet
• type ServerTrustedProxy
  • func (v *ServerTrustedProxy) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ServiceConfig
  • func (c *ServiceConfig) ApplyDefaults()

Types

type AuthConfig

type AuthConfig struct {
	Type    string                 `yaml:"type"`    // deprecated
	Options map[string]interface{} `yaml:"options"` // deprecated
	Require []filter.RequireConfig `yaml:"require"` // deprecated
}

type CertAuthConfig

type CertAuthConfig struct {
	Name    string                 `yaml:"name"`
	Type    string                 `yaml:"type"`
	Options map[string]interface{} `yaml:"options"`
}

func (*CertAuthConfig) ApplyDefaults

func (c *CertAuthConfig) ApplyDefaults()

type Config

type Config struct {
	CertAuths []CertAuthConfig `yaml:"certauths,omitempty"`
	Auth      AuthConfig       `yaml:"auth"` // deprecated in favor of env.auth_service, server.require
	Env       envconfig.Config `yaml:"env"`
	Server    ServerConfig     `yaml:"server"`
	Services  []ServiceConfig  `yaml:"services"`
}

func (*Config) ApplyDefaults

func (c *Config) ApplyDefaults()

func (*Config) ApplyMigrations

func (c *Config) ApplyMigrations()

type ServerConfig

type ServerConfig struct {
	CertificatePath string                 `yaml:"certificate_path"`
	Host            string                 `yaml:"host"`
	Port            int                    `yaml:"port"`
	PrivateKeyPath  string                 `yaml:"private_key_path"`
	Redirect        ServerRedirectConfig   `yaml:"redirect"`
	Require         []filter.RequireConfig `yaml:"require"`
	RobotsTXT       string                 `yaml:"robotstxt"`
	TrustedProxies  ServerTrustedProxies   `yaml:"trusted_proxies"`
}

func (*ServerConfig) ApplyDefaults

func (c *ServerConfig) ApplyDefaults()

type ServerRedirectConfig

type ServerRedirectConfig struct {
	Root        string `yaml:"root"`
	AuthSuccess string `yaml:"auth_success"`
	AuthFailure string `yaml:"auth_failure"`
}

type ServerTrustedProxies

type ServerTrustedProxies []ServerTrustedProxy

func (ServerTrustedProxies) AsIPNet

func (v ServerTrustedProxies) AsIPNet() []*net.IPNet

type ServerTrustedProxy

type ServerTrustedProxy net.IPNet

func (*ServerTrustedProxy) UnmarshalYAML

func (v *ServerTrustedProxy) UnmarshalYAML(unmarshal func(interface{}) error) error

type ServiceConfig

type ServiceConfig struct {
	Name    string                 `yaml:"name"`
	Type    string                 `yaml:"type"`
	Require []filter.RequireConfig `yaml:"require"`
	Options map[string]interface{} `yaml:"options"`
}

func (*ServiceConfig) ApplyDefaults

func (c *ServiceConfig) ApplyDefaults()