config

Documentation

Index

• type Config
• type Consensus
• type ExplorerData
• type HTTP
• type Log
• type LogFile
• type RHP2
• type RHP3
• type StdOut
• type Syncer

Types

type Config

type Config struct {
	Name           string `yaml:"name,omitempty"`
	Directory      string `yaml:"directory,omitempty"`
	RecoveryPhrase string `yaml:"recoveryPhrase,omitempty"`
	AutoOpenWebUI  bool   `yaml:"autoOpenWebUI,omitempty"`

	HTTP      HTTP         `yaml:"http,omitempty"`
	Syncer    Syncer       `yaml:"syncer,omitempty"`
	Consensus Consensus    `yaml:"consensus,omitempty"`
	Explorer  ExplorerData `yaml:"explorer,omitempty"`
	RHP2      RHP2         `yaml:"rhp2,omitempty"`
	RHP3      RHP3         `yaml:"rhp3,omitempty"`
	Log       Log          `yaml:"log,omitempty"`
}

Config contains the configuration for the host.

type Consensus

type Consensus struct {
	Network        string `yaml:"network,omitempty"`
	IndexBatchSize int    `yaml:"indexBatchSize,omitempty"`
}

Consensus contains the configuration for the consensus set.

type ExplorerData

type ExplorerData struct {
	Disable bool   `yaml:"disable,omitempty"`
	URL     string `yaml:"url,omitempty"`
}

ExplorerData contains the configuration for using an external explorer.

type HTTP

type HTTP struct {
	Address  string `yaml:"address,omitempty"`
	Password string `yaml:"password,omitempty"`
}

HTTP contains the configuration for the HTTP server.

type Log

type Log struct {
	// Path is the directory to store the hostd.log file.
	// Deprecated: use File.Path instead.
	Path   string  `yaml:"path,omitempty"`
	Level  string  `yaml:"level,omitempty"` // global log level
	StdOut StdOut  `yaml:"stdout,omitempty"`
	File   LogFile `yaml:"file,omitempty"`
}

Log contains the configuration for the logger.

type LogFile

type LogFile struct {
	Enabled bool   `yaml:"enabled,omitempty"`
	Level   string `yaml:"level,omitempty"` // override the file log level
	Format  string `yaml:"format,omitempty"`
	// Path is the path of the log file.
	Path string `yaml:"path,omitempty"`
}

LogFile configures the file output of the logger.

type RHP2

type RHP2 struct {
	Address string `yaml:"address,omitempty"`
}

RHP2 contains the configuration for the RHP2 server.

type RHP3

type RHP3 struct {
	TCPAddress string `yaml:"tcp,omitempty"`
}

RHP3 contains the configuration for the RHP3 server.

type StdOut

type StdOut struct {
	Level      string `yaml:"level,omitempty"` // override the stdout log level
	Enabled    bool   `yaml:"enabled,omitempty"`
	Format     string `yaml:"format,omitempty"`
	EnableANSI bool   `yaml:"enableANSI,omitempty"` //nolint:tagliatelle
}

StdOut configures the standard output of the logger.

type Syncer

type Syncer struct {
	Address    string   `yaml:"address,omitempty"`
	Bootstrap  bool     `yaml:"bootstrap,omitempty"`
	EnableUPnP bool     `yaml:"enableUPnP,omitempty"`
	Peers      []string `yaml:"peers,omitempty"`
}

Syncer contains the configuration for the p2p syncer.