config

Documentation

Index

• type Config
  • func (c *Config) ManageDeprecatedFlags(prefix string)
  • func (c *Config) Validate() error
• type HookConfig
• type LogConfig
• type NotificationConfig
• type OldConfig
• type StaticConfig
• type TLSConfig

Types

type Config

type Config struct {
	ListenAddr     string             `flag:"listen-addr" desc:"HTTP listen address" default:":8080"`
	PasswdFile     string             `flag:"passwd-file" desc:"Password file for basic HTTP authentication" default:".htpasswd"`
	TruststoreFile string             `flag:"truststore-file" desc:"Truststore used by HTTP signature verifier (.pem or .p12)"`
	Hook           HookConfig         `flag:"hook"`
	Log            LogConfig          `flag:"log"`
	Notification   NotificationConfig `flag:"notification"`
	Static         StaticConfig       `flag:"static"`
	TLS            TLSConfig          `flag:"tls"`
	OldConfig      `flag:""`
}

Config store root configuration

func (*Config) ManageDeprecatedFlags

func (c *Config) ManageDeprecatedFlags(prefix string)

ManageDeprecatedFlags manage legacy configuration

func (*Config) Validate

func (c *Config) Validate() error

Validate the configuration

type HookConfig

type HookConfig struct {
	DefaultExt  string `flag:"default-ext" desc:"Default extension for hook scripts" default:"sh"`
	DefaultMode string `flag:"default-mode" desc:"Hook default response mode (chuncked,buffered)" default:"chuncked"`
	Timeout     int    `flag:"timeout" desc:"Maximum hook execution time in second" default:"10"`
	ScriptsDir  string `flag:"scripts" desc:"Scripts location" default:"scripts"`
	LogDir      string `flag:"log-dir" desc:"Hook execution logs location" default:""`
	Workers     int    `flag:"workers" desc:"Number of workers to start" default:"2"`
}

HookConfig store Hook execution configuration

type LogConfig

type LogConfig struct {
	Level   string   `flag:"level" desc:"Log level (debug, info, warn or error)" default:"info"`
	Format  string   `flag:"format" desc:"Log format (json or text)" default:"text"`
	Modules []string `flag:"modules" desc:"Logging modules to activate (http,hook)" default:""`
}

LogConfig store logger configuration

type NotificationConfig

type NotificationConfig struct {
	URI string `flag:"uri" desc:"Notification URI"`
}

NotificationConfig store notification configuration

type OldConfig

type OldConfig struct {
	NbWorkers int    `flag:"nb-workers" desc:"Number of workers to start [DEPRECATED]" default:"2"`
	Scripts   string `flag:"scripts" desc:"Scripts location [DEPRECATED]" default:"scripts"`
}

OldConfig contain global configuration

type StaticConfig

type StaticConfig struct {
	Dir  string `flag:"dir" desc:"Static file directory to serve on /static path" default:""`
	Path string `flag:"path" desc:"Path to serve static file directory" default:"/static"`
}

StaticConfig store static assets configuration

type TLSConfig

type TLSConfig struct {
	Enabled  bool   `flag:"enabled" desc:"Enable TLS" default:"false"`
	CertFile string `flag:"cert-file" desc:"TLS certificate file (unused if ACME used)" default:"server.pem"`
	KeyFile  string `flag:"key-file" desc:"TLS key file (unused if ACME used)" default:"server.key"`
	Domain   string `flag:"domain" desc:"TLS domain name used by ACME"`
}

TLSConfig store TLS configuration