configfile

Documentation

Overview

Package configfile handles all the base configuration-file routines. This package also holds the conifiguration for the webserver and notifiarr packages. In here you will find config file parsing, validation, and creation. The application can re-write its own config file from a built-in template, complete with comments. In some circumstances the application writes a brand new empty config on startup.

Index

• Constants
• Variables
• func Funcs() template.FuncMap
• type AllowedIPs
  • func (n AllowedIPs) Contains(ip string) bool
  • func (n AllowedIPs) String() (s string)
• type Config
  • func (c *Config) FindAndReturn(configFile string, write bool) (string, bool, string)
  • func (c *Config) Get(configFile, envPrefix string) error
  • func (c *Config) Write(file string) (string, error)

Constants

const (
	DefaultTimeout  = time.Minute
	DefaultBindAddr = "0.0.0.0:5454"
)

Application Defaults.

const (
	MsgNoConfigFile = "Using env variables only. Config file not found."
	MsgConfigFailed = "Using env variables only. Could not create config file: "
	MsgConfigCreate = "Created new config file: "
	MsgConfigFound  = "Using Config File: "
)

Return prefixes from FindAndReturn.

Variables

var Template = template.Must(template.New("config").Funcs(Funcs()).Parse(tmpl))

Template is the config file template. nolint: gochecknoglobals

Functions

func Funcs

func Funcs() template.FuncMap

Funcs returns our template functions.

Types

type AllowedIPs

type AllowedIPs []*net.IPNet

AllowedIPs determines who can set x-forwarded-for.

func (AllowedIPs) Contains

func (n AllowedIPs) Contains(ip string) bool

Contains returns true if an IP is allowed.

func (AllowedIPs) String

func (n AllowedIPs) String() (s string)

String turns a list of allowedIPs into a printable masterpiece.

type Config

type Config struct {
	BindAddr   string              `json:"bind_addr" toml:"bind_addr" xml:"bind_addr" yaml:"bind_addr"`
	SSLCrtFile string              `json:"ssl_cert_file" toml:"ssl_cert_file" xml:"ssl_cert_file" yaml:"ssl_cert_file"`
	SSLKeyFile string              `json:"ssl_key_file" toml:"ssl_key_file" xml:"ssl_key_file" yaml:"ssl_key_file"`
	AutoUpdate string              `json:"auto_update" toml:"auto_update" xml:"auto_update" yaml:"auto_update"`
	Upstreams  []string            `json:"upstreams" toml:"upstreams" xml:"upstreams" yaml:"upstreams"`
	Timeout    cnfg.Duration       `json:"timeout" toml:"timeout" xml:"timeout" yaml:"timeout"`
	Plex       *plex.Server        `json:"plex" toml:"plex" xml:"plex" yaml:"plex"`
	Snapshot   *snapshot.Config    `json:"snapshot" toml:"snapshot" xml:"snapshot" yaml:"snapshot"`
	Services   *services.Config    `json:"services" toml:"services" xml:"services" yaml:"services"`
	Service    []*services.Service `json:"service" toml:"service" xml:"service" yaml:"service"`
	*logs.LogConfig
	*apps.Apps
	Allow AllowedIPs `json:"-" toml:"-" xml:"-" yaml:"-"`
}

Config represents the data in our config file.

func (*Config) FindAndReturn

func (c *Config) FindAndReturn(configFile string, write bool) (string, bool, string)

FindAndReturn return a config file. Write one if requested.

func (*Config) Get

func (c *Config) Get(configFile, envPrefix string) error

Get parses a config file and environment variables. Sometimes the app runs without a config file entirely.

func (*Config) Write

func (c *Config) Write(file string) (string, error)

Write config to a file.