config

Documentation

Overview

Package config implements types for handling the configuation for the app.

Index

• func DowngradeV3toV2(d *Data) (*v2.Data, error)
• type Config
  • func New(f fs.Filesystem) *Config
  • func (d *Config) Clone() *Config
  • func (d *Config) Get(name string) (string, error)
  • func (d *Config) HasErrors() bool
  • func (d *Config) Merge()
  • func (d *Config) Messages(logger func(level string, v vars.Variable, message string))
  • func (d *Config) Overrides() []string
  • func (d *Config) Set(name, val string) error
  • func (d *Config) Validate(resetLogs bool)
• type Data
  • func MergeV2toV3(data *Data, d *v2.Data) (*Data, error)
  • func UpgradeV2ToV3(d *v2.Data, fs fs.Filesystem) (*Data, error)

Functions

func DowngradeV3toV2

func DowngradeV3toV2(d *Data) (*v2.Data, error)

Types

type Config

type Config struct {
	Data
	// contains filtered or unexported fields
}

Config is a wrapper for Data

func New

func New(f fs.Filesystem) *Config

New returns a Config which is initialized with its default values

func (*Config) Clone

func (d *Config) Clone() *Config

NewConfigFrom returns a clone of a Config

func (*Config) Get

func (d *Config) Get(name string) (string, error)

func (*Config) HasErrors

func (d *Config) HasErrors() bool

HasErrors returns whether there are some error messages in the log.

func (*Config) Merge

func (d *Config) Merge()

Merge merges the values of the known environment variables into the configuration

func (*Config) Messages

func (d *Config) Messages(logger func(level string, v vars.Variable, message string))

Messages calls for each log entry the provided callback. The level has the values 'error', 'warn', or 'info'. The name is the name of the configuration value, e.g. 'api.auth.enable'. The message is the log message.

func (*Config) Overrides

func (d *Config) Overrides() []string

Overrides returns a list of configuration value names that have been overriden by an environment variable.

func (*Config) Set

func (d *Config) Set(name, val string) error

func (*Config) Validate

func (d *Config) Validate(resetLogs bool)

Validate validates the current state of the Config for completeness and sanity. Errors are written to the log. Use resetLogs to indicate to reset the logs prior validation.

type Data

type Data struct {
	CreatedAt       time.Time `json:"created_at"` // When this config has been persisted
	LoadedAt        time.Time `json:"-"`          // When this config has been actually used
	UpdatedAt       time.Time `json:"-"`          // Irrelevant
	Version         int64     `json:"version" jsonschema:"minimum=3,maximum=3" format:"int64"`
	ID              string    `json:"id"`
	Name            string    `json:"name"`
	Address         string    `json:"address"`
	CheckForUpdates bool      `json:"update_check"`
	Log             struct {
		Level    string   `json:"level" enums:"debug,info,warn,error,silent" jsonschema:"enum=debug,enum=info,enum=warn,enum=error,enum=silent"`
		Topics   []string `json:"topics"`
		MaxLines int      `json:"max_lines" format:"int"`
	} `json:"log"`
	DB struct {
		Dir string `json:"dir"`
	} `json:"db"`
	Host struct {
		Name []string `json:"name"`
		Auto bool     `json:"auto"`
	} `json:"host"`
	API struct {
		ReadOnly bool `json:"read_only"`
		Access   struct {
			HTTP struct {
				Allow []string `json:"allow"`
				Block []string `json:"block"`
			} `json:"http"`
			HTTPS struct {
				Allow []string `json:"allow"`
				Block []string `json:"block"`
			} `json:"https"`
		} `json:"access"`
		Auth struct {
			Enable           bool   `json:"enable"`
			DisableLocalhost bool   `json:"disable_localhost"`
			Username         string `json:"username"`
			Password         string `json:"password"`
			JWT              struct {
				Secret string `json:"secret"`
			} `json:"jwt"`
			Auth0 struct {
				Enable  bool                `json:"enable"`
				Tenants []value.Auth0Tenant `json:"tenants"`
			} `json:"auth0"`
		} `json:"auth"`
	} `json:"api"`
	TLS struct {
		Address  string `json:"address"`
		Enable   bool   `json:"enable"`
		Auto     bool   `json:"auto"`
		Email    string `json:"email"`
		CertFile string `json:"cert_file"`
		KeyFile  string `json:"key_file"`
	} `json:"tls"`
	Storage struct {
		Disk struct {
			Dir   string `json:"dir"`
			Size  int64  `json:"max_size_mbytes" format:"int64"`
			Cache struct {
				Enable   bool   `json:"enable"`
				Size     uint64 `json:"max_size_mbytes" format:"uint64"`
				TTL      int64  `json:"ttl_seconds" format:"int64"`
				FileSize uint64 `json:"max_file_size_mbytes" format:"uint64"`
				Types    struct {
					Allow []string `json:"allow"`
					Block []string `json:"block"`
				} `json:"types"`
			} `json:"cache"`
		} `json:"disk"`
		Memory struct {
			Auth struct {
				Enable   bool   `json:"enable"`
				Username string `json:"username"`
				Password string `json:"password"`
			} `json:"auth"`
			Size  int64 `json:"max_size_mbytes" format:"int64"`
			Purge bool  `json:"purge"`
		} `json:"memory"`
		S3   []value.S3Storage `json:"s3"`
		CORS struct {
			Origins []string `json:"origins"`
		} `json:"cors"`
		MimeTypes string `json:"mimetypes_file"`
	} `json:"storage"`
	RTMP struct {
		Enable     bool   `json:"enable"`
		EnableTLS  bool   `json:"enable_tls"`
		Address    string `json:"address"`
		AddressTLS string `json:"address_tls"`
		App        string `json:"app"`
		Token      string `json:"token"`
	} `json:"rtmp"`
	SRT struct {
		Enable     bool   `json:"enable"`
		Address    string `json:"address"`
		Passphrase string `json:"passphrase"`
		Token      string `json:"token"`
		Log        struct {
			Enable bool     `json:"enable"`
			Topics []string `json:"topics"`
		} `json:"log"`
	} `json:"srt"`
	FFmpeg struct {
		Binary       string `json:"binary"`
		MaxProcesses int64  `json:"max_processes" format:"int64"`
		Access       struct {
			Input struct {
				Allow []string `json:"allow"`
				Block []string `json:"block"`
			} `json:"input"`
			Output struct {
				Allow []string `json:"allow"`
				Block []string `json:"block"`
			} `json:"output"`
		} `json:"access"`
		Log struct {
			MaxLines   int `json:"max_lines" format:"int"`
			MaxHistory int `json:"max_history" format:"int"`
		} `json:"log"`
	} `json:"ffmpeg"`
	Playout struct {
		Enable  bool `json:"enable"`
		MinPort int  `json:"min_port" format:"int"`
		MaxPort int  `json:"max_port" format:"int"`
	} `json:"playout"`
	Debug struct {
		Profiling   bool  `json:"profiling"`
		ForceGC     int   `json:"force_gc" format:"int"`
		MemoryLimit int64 `json:"memory_limit_mbytes" format:"int64"`
	} `json:"debug"`
	Metrics struct {
		Enable           bool  `json:"enable"`
		EnablePrometheus bool  `json:"enable_prometheus"`
		Range            int64 `json:"range_sec" format:"int64"`    // seconds
		Interval         int64 `json:"interval_sec" format:"int64"` // seconds
	} `json:"metrics"`
	Sessions struct {
		Enable          bool     `json:"enable"`
		IPIgnoreList    []string `json:"ip_ignorelist"`
		SessionTimeout  int      `json:"session_timeout_sec" format:"int"`
		Persist         bool     `json:"persist"`
		PersistInterval int      `json:"persist_interval_sec" format:"int"`
		MaxBitrate      uint64   `json:"max_bitrate_mbit" format:"uint64"`
		MaxSessions     uint64   `json:"max_sessions" format:"uint64"`
	} `json:"sessions"`
	Service struct {
		Enable bool   `json:"enable"`
		Token  string `json:"token"`
		URL    string `json:"url"`
	} `json:"service"`
	Router struct {
		BlockedPrefixes []string          `json:"blocked_prefixes"`
		Routes          map[string]string `json:"routes"`
		UIPath          string            `json:"ui_path"`
	} `json:"router"`
}

Data is the actual configuration data for the app

func MergeV2toV3

func MergeV2toV3(data *Data, d *v2.Data) (*Data, error)

func UpgradeV2ToV3

func UpgradeV2ToV3(d *v2.Data, fs fs.Filesystem) (*Data, error)