config

Documentation

Index

• type Config
  • func DefaultConfig() *Config
  • func ParseFlags(preCfg *Config) (*Config, error)
  • func ReadConfigFile(cfg *Config) (*Config, error)
  • func SetupConfig(cfg *Config) (*Config, error)

Types

type Config

type Config struct {
	PoetDir         string  `long:"poetdir"        description:"The base directory that contains poet's data, logs, configuration file, etc."`
	ConfigFile      string  `long:"configfile"     description:"Path to configuration file"                                                   short:"c"`
	DataDir         string  `long:"datadir"        description:"The directory to store poet's data within"                                    short:"b"`
	LogDir          string  `long:"logdir"         description:"Directory to log output."`
	DebugLog        bool    `long:"debuglog"       description:"Enable debug logs"`
	JSONLog         bool    `long:"jsonlog"        description:"Whether to log in JSON format"`
	MaxLogFiles     int     `long:"maxlogfiles"    description:"Maximum logfiles to keep (0 for no rotation)"`
	MaxLogFileSize  int     `long:"maxlogfilesize" description:"Maximum logfile size in MB"`
	RawRPCListener  string  `long:"rpclisten"      description:"The interface/port/socket to listen for RPC connections"                      short:"r"`
	RawRESTListener string  `long:"restlisten"     description:"The interface/port/socket to listen for REST connections"                     short:"w"`
	MetricsPort     *uint16 `long:"metrics-port"   description:"The port to expose metrics"`

	CPUProfile string `long:"cpuprofile" description:"Write CPU profile to the specified file"`
	Profile    string `long:"profile"    description:"Enable HTTP profiling on given port -- must be between 1024 and 65535"`

	Service *service.Config `group:"Service"`
}

Config defines the configuration options for poet.

See loadConfig for further details regarding the configuration loading+parsing process.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns a config with default hardcoded values.

func ParseFlags

func ParseFlags(preCfg *Config) (*Config, error)

ParseFlags reads values from command line arguments.

func ReadConfigFile

func ReadConfigFile(cfg *Config) (*Config, error)

ReadConfigFile reads values from a conf file.

func SetupConfig

func SetupConfig(cfg *Config) (*Config, error)

SetupConfig initializes filesystem and network infrastructure.