config

Documentation

Index

• Variables
• type Configuration
  • func Default(builders ...ConfigurationBuilder) Configuration
• type ConfigurationBuilder
  • func WithBalancer(domain, acmeEmail string) ConfigurationBuilder
  • func WithTestDefaults() ConfigurationBuilder

Variables

var (
	DefaultConfigPath = filepath.Join(defaultDataDirectory, defaultConfigFilename) // Default configuration path

)

Types

type Configuration

type Configuration interface {
	serve.Options // The configuration should provide every settings needed by the seelf server

	Initialize(log.ConfigurableLogger, string) error // Initialize the configuration by loading it (from config file, env vars, etc.)
}

Configuration used to configure seelf commands.

func Default

func Default(builders ...ConfigurationBuilder) Configuration

Instantiate the default seelf configuration.

type ConfigurationBuilder

type ConfigurationBuilder func(*configuration)

Configuration builder function used to initialize the configuration object (mostly used in tests).

func WithBalancer

func WithBalancer(domain, acmeEmail string) ConfigurationBuilder

Configure the balancer for the given domain and acme email.

func WithTestDefaults

func WithTestDefaults() ConfigurationBuilder

Configuration builder used to set some tests sensible defaults. Generates a random data directory path to avoid conflicts with other tests.