config

Documentation

Index

• type Config
• type Debug
• type Events
• type Log
• type Notifications
• type SMTP
• type Service

Types

type Config

type Config struct {
	Commons *shared.Commons `yaml:"-"` // don't use this directly as configuration for a service

	Service Service `yaml:"-"`

	Log   *Log  `yaml:"log"`
	Debug Debug `yaml:"debug"`

	Notifications Notifications `yaml:"notifications"`

	Context context.Context `yaml:"-"`
}

Config combines all available configuration parts.

type Debug

type Debug struct {
	Addr   string `` /* 150-byte string literal not displayed */
	Token  string `yaml:"token" env:"NOTIFICATIONS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"`
	Pprof  bool   `yaml:"pprof" env:"NOTIFICATIONS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"`
	Zpages bool   `` /* 128-byte string literal not displayed */
}

Debug defines the available debug configuration.

type Events

type Events struct {
	Endpoint      string `yaml:"endpoint" env:"NOTIFICATIONS_EVENTS_ENDPOINT"`
	Cluster       string `yaml:"cluster" env:"NOTIFICATIONS_EVENTS_CLUSTER"`
	ConsumerGroup string `yaml:"group" env:"NOTIFICATIONS_EVENTS_GROUP"`
}

Events combines the configuration options for the event bus.

type Log

type Log struct {
	Level  string `mapstructure:"level" env:"OCIS_LOG_LEVEL;NOTIFICATIONS_LOG_LEVEL"`
	Pretty bool   `mapstructure:"pretty" env:"OCIS_LOG_PRETTY;NOTIFICATIONS_LOG_PRETTY"`
	Color  bool   `mapstructure:"color" env:"OCIS_LOG_COLOR;NOTIFICATIONS_LOG_COLOR"`
	File   string `mapstructure:"file" env:"OCIS_LOG_FILE;NOTIFICATIONS_LOG_FILE"`
}

Log defines the available log configuration.

type Notifications

type Notifications struct {
	SMTP              SMTP   `yaml:"SMTP"`
	Events            Events `yaml:"events"`
	RevaGateway       string `yaml:"reva_gateway" env:"REVA_GATEWAY;NOTIFICATIONS_REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata"`
	MachineAuthAPIKey string `` /* 176-byte string literal not displayed */
}

Notifications definces the config options for the notifications service.

type SMTP

type SMTP struct {
	Host     string `yaml:"smtp_host" env:"NOTIFICATIONS_SMTP_HOST"`
	Port     string `yaml:"smtp_port" env:"NOTIFICATIONS_SMTP_PORT"`
	Sender   string `yaml:"smtp_sender" env:"NOTIFICATIONS_SMTP_SENDER"`
	Password string `yaml:"smtp_password" env:"NOTIFICATIONS_SMTP_PASSWORD"`
}

SMTP combines the smtp configuration options.

type Service

type Service struct {
	Name string `yaml:"-"`
}

Service defines the available service configuration.