configuration

Documentation

Index

• Constants
• func EnsureConfigurationExists(path string) (created bool, err error)
• func Load(val *schema.StructValidator, sources ...Source) (keys []string, configuration *schema.Configuration, err error)
• func LoadAdvanced(val *schema.StructValidator, path string, result interface{}, ...) (keys []string, err error)
• func StringToMailAddressHookFunc() mapstructure.DecodeHookFuncType
• func StringToRegexpFunc() mapstructure.DecodeHookFuncType
• func StringToURLHookFunc() mapstructure.DecodeHookFuncType
• func ToTimeDurationHookFunc() mapstructure.DecodeHookFuncType
• type CommandLineSource
  • func NewCommandLineSourceWithMapping(flags *pflag.FlagSet, mapping map[string]string, ...) (source *CommandLineSource)
  • func (s *CommandLineSource) Load(_ *schema.StructValidator) (err error)
  • func (s *CommandLineSource) Merge(ko *koanf.Koanf, val *schema.StructValidator) (err error)
  • func (s CommandLineSource) Name() (name string)
• type EnvironmentSource
  • func NewEnvironmentSource(prefix, delimiter string) (source *EnvironmentSource)
  • func (s *EnvironmentSource) Load(_ *schema.StructValidator) (err error)
  • func (s *EnvironmentSource) Merge(ko *koanf.Koanf, _ *schema.StructValidator) (err error)
  • func (s EnvironmentSource) Name() (name string)
• type SecretsSource
  • func NewSecretsSource(prefix, delimiter string) (source *SecretsSource)
  • func (s *SecretsSource) Load(val *schema.StructValidator) (err error)
  • func (s *SecretsSource) Merge(ko *koanf.Koanf, val *schema.StructValidator) (err error)
  • func (s SecretsSource) Name() (name string)
• type Source
  • func NewDefaultSources(filePaths []string, prefix, delimiter string) (sources []Source)
• type YAMLFileSource
  • func NewYAMLFileSource(path string) (source *YAMLFileSource)
  • func NewYAMLFileSources(paths []string) (sources []*YAMLFileSource)
  • func (s *YAMLFileSource) Load(_ *schema.StructValidator) (err error)
  • func (s *YAMLFileSource) Merge(ko *koanf.Koanf, _ *schema.StructValidator) (err error)
  • func (s YAMLFileSource) Name() (name string)

Constants

const DefaultEnvDelimiter = "_"

DefaultEnvDelimiter is the default environment delimiter.

const DefaultEnvPrefix = "AUTHELIA_"

DefaultEnvPrefix is the default environment prefix.

Functions

func EnsureConfigurationExists

func EnsureConfigurationExists(path string) (created bool, err error)

EnsureConfigurationExists is an auxiliary function to the main Configuration tools that ensures the Configuration template is created if it doesn't already exist.

func Load

func Load(val *schema.StructValidator, sources ...Source) (keys []string, configuration *schema.Configuration, err error)

Load the configuration given the provided options and sources.

func LoadAdvanced

func LoadAdvanced(val *schema.StructValidator, path string, result interface{}, sources ...Source) (keys []string, err error)

LoadAdvanced is intended to give more flexibility over loading a particular path to a specific interface.

func StringToMailAddressHookFunc

func StringToMailAddressHookFunc() mapstructure.DecodeHookFuncType

StringToMailAddressHookFunc decodes a string into a mail.Address or *mail.Address.

func StringToRegexpFunc

func StringToRegexpFunc() mapstructure.DecodeHookFuncType

StringToRegexpFunc decodes a string into a *regexp.Regexp or regexp.Regexp.

func StringToURLHookFunc

func StringToURLHookFunc() mapstructure.DecodeHookFuncType

StringToURLHookFunc converts string types into a url.URL or *url.URL.

func ToTimeDurationHookFunc

func ToTimeDurationHookFunc() mapstructure.DecodeHookFuncType

ToTimeDurationHookFunc converts string and integer types to a time.Duration.

Types

type CommandLineSource

type CommandLineSource struct {
	// contains filtered or unexported fields
}

CommandLineSource loads configuration from the command line flags.

func NewCommandLineSourceWithMapping

func NewCommandLineSourceWithMapping(flags *pflag.FlagSet, mapping map[string]string, includeValidKeys, includeUnchangedKeys bool) (source *CommandLineSource)

NewCommandLineSourceWithMapping creates a new command line configuration source with a map[string]string which converts flag names into other config key names. If includeValidKeys is true we also allow any flag with a name which matches the list of valid keys into the koanf.Koanf, otherwise everything not in the map is skipped. Unchanged flags are also skipped unless includeUnchangedKeys is set to true.

func (*CommandLineSource) Load

func (s *CommandLineSource) Load(_ *schema.StructValidator) (err error)

Load the Source into the YAMLFileSource koanf.Koanf.

func (*CommandLineSource) Merge

func (s *CommandLineSource) Merge(ko *koanf.Koanf, val *schema.StructValidator) (err error)

Merge the CommandLineSource koanf.Koanf into the provided one.

func (CommandLineSource) Name

func (s CommandLineSource) Name() (name string)

Name of the Source.

type EnvironmentSource

type EnvironmentSource struct {
	// contains filtered or unexported fields
}

EnvironmentSource is a configuration Source which loads values from the environment.

func NewEnvironmentSource

func NewEnvironmentSource(prefix, delimiter string) (source *EnvironmentSource)

NewEnvironmentSource returns a Source configured to load from environment variables.

func (*EnvironmentSource) Load

func (s *EnvironmentSource) Load(_ *schema.StructValidator) (err error)

Load the Source into the EnvironmentSource koanf.Koanf.

func (*EnvironmentSource) Merge

func (s *EnvironmentSource) Merge(ko *koanf.Koanf, _ *schema.StructValidator) (err error)

Merge the EnvironmentSource koanf.Koanf into the provided one.

func (EnvironmentSource) Name

func (s EnvironmentSource) Name() (name string)

Name of the Source.

type SecretsSource

type SecretsSource struct {
	// contains filtered or unexported fields
}

SecretsSource loads environment variables that have a value pointing to a file.

func NewSecretsSource

func NewSecretsSource(prefix, delimiter string) (source *SecretsSource)

NewSecretsSource returns a Source configured to load from secrets.

func (*SecretsSource) Load

func (s *SecretsSource) Load(val *schema.StructValidator) (err error)

Load the Source into the SecretsSource koanf.Koanf.

func (*SecretsSource) Merge

func (s *SecretsSource) Merge(ko *koanf.Koanf, val *schema.StructValidator) (err error)

Merge the SecretsSource koanf.Koanf into the provided one.

func (SecretsSource) Name

func (s SecretsSource) Name() (name string)

Name of the Source.

type Source

type Source interface {
	Name() (name string)
	Merge(ko *koanf.Koanf, val *schema.StructValidator) (err error)
	Load(val *schema.StructValidator) (err error)
}

Source is an abstract representation of a configuration Source implementation.

func NewDefaultSources

func NewDefaultSources(filePaths []string, prefix, delimiter string) (sources []Source)

NewDefaultSources returns a slice of Source configured to load from specified YAML files.

type YAMLFileSource

type YAMLFileSource struct {
	// contains filtered or unexported fields
}

YAMLFileSource is a configuration Source with a YAML File.

func NewYAMLFileSource

func NewYAMLFileSource(path string) (source *YAMLFileSource)

NewYAMLFileSource returns a Source configured to load from a specified YAML path. If there is an issue accessing this path it also returns an error.

func NewYAMLFileSources

func NewYAMLFileSources(paths []string) (sources []*YAMLFileSource)

NewYAMLFileSources returns a slice of Source configured to load from specified YAML files.

func (*YAMLFileSource) Load

func (s *YAMLFileSource) Load(_ *schema.StructValidator) (err error)

Load the Source into the YAMLFileSource koanf.Koanf.

func (*YAMLFileSource) Merge

func (s *YAMLFileSource) Merge(ko *koanf.Koanf, _ *schema.StructValidator) (err error)

Merge the YAMLFileSource koanf.Koanf into the provided one.

func (YAMLFileSource) Name

func (s YAMLFileSource) Name() (name string)

Name of the Source.