conf

Documentation

Index

• func FillRuntimeKey() error
• func FillRuntimePaths() error
• func GetNodesAddr() []string
• func LoadConfig(path string) error
• func LoadConfigToVar(path string, v *GlobalConfig) error
• func SaveConfig(path string) error
• type BanKeyConfig
• type CentrifugoConfig
• type DBConfig
• type GlobalConfig
  • func GetConfigFromPath(path string) (*GlobalConfig, error)
  • func (c *GlobalConfig) GetPidPath() string
  • func (c GlobalConfig) IsNode() bool
  • func (c GlobalConfig) IsOBS() bool
  • func (c GlobalConfig) IsOBSMaster() bool
  • func (c GlobalConfig) IsSupportingOBS() bool
• type HostPort
  • func (h HostPort) Str() string
• type LogConfig
• type RunMode
  • func (rm RunMode) IsNode() bool
  • func (rm RunMode) IsOBS() bool
  • func (rm RunMode) IsOBSMaster() bool
  • func (rm RunMode) IsSupportingOBS() bool
• type StatsDConfig
• type Syslog
• type TokenMovementConfig

Functions

func FillRuntimeKey

func FillRuntimeKey() error

FillRuntimeKey fills parameters of keys from runtime parameters

func FillRuntimePaths

func FillRuntimePaths() error

FillRuntimePaths fills paths from runtime parameters

func GetNodesAddr

func GetNodesAddr() []string

GetNodesAddr returns addreses of nodes

func LoadConfig

func LoadConfig(path string) error

LoadConfig from configFile the function has side effect updating global var Config

func LoadConfigToVar

func LoadConfigToVar(path string, v *GlobalConfig) error

func SaveConfig

func SaveConfig(path string) error

SaveConfig save global parameters to configFile

Types

type BanKeyConfig

type BanKeyConfig struct {
	BadTime int // control time period in minutes
	BanTime int // ban time in minutes
	BadTx   int // maximum bad tx during badTime minutes
}

BanKey parameters

type CentrifugoConfig

type CentrifugoConfig struct {
	Secret string
	URL    string
}

CentrifugoConfig connection params

type DBConfig

type DBConfig struct {
	Name            string
	Host            string // ipaddr, hostname, or "0.0.0.0"
	Port            int    // must be in range 1..65535
	User            string
	Password        string
	LockTimeout     int // lock_timeout in milliseconds
	IdleInTxTimeout int // postgres parameter idle_in_transaction_session_timeout
}

DBConfig database connection parameters

type GlobalConfig

type GlobalConfig struct {
	KeyID        int64  `toml:"-"`
	ConfigPath   string `toml:"-"`
	TestRollBack bool   `toml:"-"`
	FuncBench    bool   `toml:"-"`

	PidFilePath           string
	LockFilePath          string
	DataDir               string // application work dir (cwd by default)
	KeysDir               string // place for private keys files: NodePrivateKey, PrivateKey
	TempDir               string // temporary dir
	FirstBlockPath        string
	TLS                   bool   // TLS is on/off. It is required for https
	TLSCert               string // TLSCert is a filepath of the fullchain of certificate.
	TLSKey                string // TLSKey is a filepath of the private key.
	OBSMode               string
	HTTPServerMaxBodySize int64
	NetworkID             int64

	MaxPageGenerationTime int64 // in milliseconds

	TCPServer HostPort
	HTTP      HostPort

	DB            DBConfig
	StatsD        StatsDConfig
	Centrifugo    CentrifugoConfig
	Log           LogConfig
	TokenMovement TokenMovementConfig
	BanKey        BanKeyConfig

	NodesAddr []string
}

GlobalConfig is storing all startup config as global struct

var Config GlobalConfig

Config global parameters

func GetConfigFromPath

func GetConfigFromPath(path string) (*GlobalConfig, error)

GetConfigFromPath read config from path and returns GlobalConfig struct

func (*GlobalConfig) GetPidPath

func (c *GlobalConfig) GetPidPath() string

GetPidPath returns path to pid file

func (GlobalConfig) IsNode

func (c GlobalConfig) IsNode() bool

IsNode check running mode

func (GlobalConfig) IsOBS

func (c GlobalConfig) IsOBS() bool

IsOBS check running mode

func (GlobalConfig) IsOBSMaster

func (c GlobalConfig) IsOBSMaster() bool

IsOBSMaster check running mode

func (GlobalConfig) IsSupportingOBS

func (c GlobalConfig) IsSupportingOBS() bool

IsSupportingOBS check running mode

type HostPort

type HostPort struct {
	Host string // ipaddr, hostname, or "0.0.0.0"
	Port int    // must be in range 1..65535
}

HostPort endpoint in form "str:int"

func (HostPort) Str

func (h HostPort) Str() string

Str converts HostPort pair to string format

type LogConfig

type LogConfig struct {
	LogTo     string
	LogLevel  string
	LogFormat string
	Syslog    Syslog
}

Log represents parameters of log

type RunMode

type RunMode string

func (RunMode) IsNode

func (rm RunMode) IsNode() bool

IsNode returns true if mode not equal to any OBS

func (RunMode) IsOBS

func (rm RunMode) IsOBS() bool

IsOBS returns true if mode equal obs

func (RunMode) IsOBSMaster

func (rm RunMode) IsOBSMaster() bool

IsOBSMaster returns true if mode equal obsMaster

func (RunMode) IsSupportingOBS

func (rm RunMode) IsSupportingOBS() bool

IsSupportingOBS returns true if mode support obs

type StatsDConfig

type StatsDConfig struct {
	Host string // ipaddr, hostname, or "0.0.0.0"
	Port int    // must be in range 1..65535
	Name string
}

StatsDConfig statd connection parameters

type Syslog

type Syslog struct {
	Facility string
	Tag      string
}

Syslog represents parameters of syslog

type TokenMovementConfig

type TokenMovementConfig struct {
	Host     string
	Port     int
	Username string
	Password string
	To       string
	From     string
	Subject  string
}

TokenMovementConfig smtp config for token movement