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"`

	WebUIURL string `` /* 147-byte string literal not displayed */

	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   `` /* 132-byte string literal not displayed */
}

Debug defines the available debug configuration.

type Events

type Events struct {
	Endpoint             string `` /* 204-byte string literal not displayed */
	Cluster              string `` /* 247-byte string literal not displayed */
	ConsumerGroup        string `yaml:"group" env:"NOTIFICATIONS_EVENTS_GROUP" desc:"Name of the event group / queue on the event system."`
	TLSInsecure          bool   `` /* 127-byte string literal not displayed */
	TLSRootCACertificate string `` /* 228-byte string literal not displayed */
	EnableTLS            bool   `` /* 233-byte string literal not displayed */
}

Events combines the configuration options for the event bus.

type Log

type Log struct {
	Level  string `` /* 180-byte string literal not displayed */
	Pretty bool   `mapstructure:"pretty" env:"OCIS_LOG_PRETTY;NOTIFICATIONS_LOG_PRETTY" desc:"Activates pretty log output."`
	Color  bool   `mapstructure:"color" env:"OCIS_LOG_COLOR;NOTIFICATIONS_LOG_COLOR" desc:"Activates colorized log output."`
	File   string `` /* 134-byte string literal not displayed */
}

Log defines the available log configuration.

type Notifications

type Notifications struct {
	SMTP              SMTP                  `yaml:"SMTP"`
	Events            Events                `yaml:"events"`
	MachineAuthAPIKey string                `` /* 208-byte string literal not displayed */
	EmailTemplatePath string                `` /* 161-byte string literal not displayed */
	RevaGateway       string                `yaml:"reva_gateway" env:"REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata"`
	GRPCClientTLS     *shared.GRPCClientTLS `yaml:"grpc_client_tls"`
}

Notifications defines the config options for the notifications service.

type SMTP

type SMTP struct {
	Host           string `yaml:"smtp_host" env:"NOTIFICATIONS_SMTP_HOST" desc:"SMTP host to connect to."`
	Port           int    `yaml:"smtp_port" env:"NOTIFICATIONS_SMTP_PORT" desc:"Port of the SMTP host to connect to."`
	Sender         string `yaml:"smtp_sender" env:"NOTIFICATIONS_SMTP_SENDER" desc:"Sender address of emails that will be sent."`
	Username       string `yaml:"smtp_username" env:"NOTIFICATIONS_SMTP_USERNAME" desc:"Username for the SMTP host to connect to."`
	Password       string `yaml:"smtp_password" env:"NOTIFICATIONS_SMTP_PASSWORD" desc:"Password for the SMTP host to connect to."`
	Insecure       bool   `yaml:"insecure" env:"NOTIFICATIONS_SMTP_INSECURE" desc:"Allow insecure connections to the SMTP server."`
	Authentication string `` /* 179-byte string literal not displayed */
	Encryption     string `` /* 180-byte string literal not displayed */
}

SMTP combines the smtp configuration options.

type Service

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

Service defines the available service configuration.