config

Documentation

Overview

Package config is resposible for finding, parsing and merging the HTTPMS user configuration with the default. Configuration locations should be different depending on the host OS.

Linux/BSD configurations should be in $HOME/.httpms/config.json Windows configurations should be in %APPDATA%/httpms/config.json

Index

• Constants
• func CopyDefaultOverUser() error
• func UserConfigExists() bool
• func UserConfigPath() string
• type Auth
• type Cert
• type Config
  • func FindAndParse() (Config, error)
• type ScanSection
  • func (ss *ScanSection) UnmarshalJSON(input []byte) error

Constants

const (
	// ConfigName contains the name of the actual configuration file. This is the one
	// the user is supposed to change.
	ConfigName = "config.json"
)

Functions

func CopyDefaultOverUser

func CopyDefaultOverUser() error

CopyDefaultOverUser will create (or replace if neccessery) the user configuration using the default config new config.

func UserConfigExists

func UserConfigExists() bool

UserConfigExists returns true if the user configuration is present and in order. Otherwise false.

func UserConfigPath

func UserConfigPath() string

UserConfigPath returns the full path to the place where the user's configuration file should be

Types

type Auth

type Auth struct {
	User     string `json:"user,omitempty"`
	Password string `json:"password,omitempty"`
	Secret   string `json:"secret"`
}

Auth represents a configuration HTTP Basic authentication

type Cert

type Cert struct {
	Crt string `json:"crt,omitempty"`
	Key string `json:"key,omitempty"`
}

Cert represents a configuration for TLS certificate

type Config

type Config struct {
	Listen          string      `json:"listen,omitempty"`
	SSL             bool        `json:"ssl,omitempty"`
	SSLCertificate  Cert        `json:"ssl_certificate,omitempty"`
	Auth            bool        `json:"basic_authenticate,omitempty"`
	Authenticate    Auth        `json:"authentication,omitempty"`
	Libraries       []string    `json:"libraries,omitempty"`
	LibraryScan     ScanSection `json:"library_scan,omitempty"`
	UserPath        string      `json:"user_path,omitempty"`
	LogFile         string      `json:"log_file,omitempty"`
	SqliteDatabase  string      `json:"sqlite_database,omitempty"`
	Gzip            bool        `json:"gzip,omitempty"`
	ReadTimeout     int         `json:"read_timeout,omitempty"`
	WriteTimeout    int         `json:"write_timeout,omitempty"`
	MaxHeadersSize  int         `json:"max_header_bytes,omitempty"`
	DownloadArtwork bool        `json:"download_artwork,omitempty"`
}

Config contains representation for everything in config.json

func FindAndParse

func FindAndParse() (Config, error)

FindAndParse actually finds the configuration file, parsing it and merging it on top the default configuration.

type ScanSection

type ScanSection struct {
	FilesPerOperation int64         `json:"files_per_operation,omitempty"`
	SleepPerOperation time.Duration `json:"sleep_after_operation,omitempty"`
	InitialWait       time.Duration `json:"initial_wait_duration,omitempty"`
}

ScanSection is used for merging the two configs. Its purpose is to essentially hold the default values for its properties.

func (*ScanSection) UnmarshalJSON

func (ss *ScanSection) UnmarshalJSON(input []byte) error

UnmarshalJSON parses a JSON and populets its ScanSection. Satisfies the Unmrashaller interface.