config

Documentation

Overview

Package config implements global configuration options.

Index

• type Config
  • func DefaultConfig() Config
  • func (c *Config) Validate() error
• type ControlConfig

Types

type Config

type Config struct {
	// Enable Sentry worker.
	// NOTE: This should only be enabled on Sentry nodes.
	Enabled bool `yaml:"enabled"`

	Control ControlConfig `yaml:"control,omitempty"`
}

Config is the sentry worker configuration structure.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration settings.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration settings.

type ControlConfig

type ControlConfig struct {
	// Sentry worker's gRPC server port.
	Port uint16 `yaml:"port"`

	// Public keys of upstream nodes that are allowed to connect to sentry control endpoint.
	AuthorizedPubkeys []string `yaml:"authorized_pubkeys"`
}

ControlConfig is the sentry worker control configuration structure.