Documentation
¶
Overview ¶
Package config provides the service configuration.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Commons *shared.Commons `yaml:"-"` // don't use this directly as configuration for a service
Service Service `yaml:"-"`
Tracing *Tracing `yaml:"tracing"`
Log *Log `yaml:"log"`
Debug Debug `yaml:"debug"`
WebUIURL string `` /* 183-byte string literal not displayed */
Notifications Notifications `yaml:"notifications"`
GRPCClientTLS shared.GRPCClientTLS `yaml:"grpc_client_tls"`
ServiceAccount ServiceAccount `yaml:"service_account"`
Context context.Context `yaml:"-"`
Store Store `yaml:"store"`
}
Config combines all available configuration parts.
type Debug ¶
type Debug struct {
Addr string `` /* 178-byte string literal not displayed */
Token string `yaml:"token" env:"NOTIFICATIONS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint." introductionVersion:"1.0.0"`
Pprof bool `` /* 127-byte string literal not displayed */
Zpages bool `` /* 160-byte string literal not displayed */
}
Debug defines the available debug configuration.
type Events ¶
type Events struct {
Endpoint string `` /* 251-byte string literal not displayed */
Cluster string `` /* 293-byte string literal not displayed */
TLSInsecure bool `` /* 153-byte string literal not displayed */
TLSRootCACertificate string `` /* 290-byte string literal not displayed */
EnableTLS bool `` /* 263-byte string literal not displayed */
AuthUsername string `` /* 268-byte string literal not displayed */
AuthPassword string `` /* 268-byte string literal not displayed */
}
Events combines the configuration options for the event bus.
type Log ¶
type Log struct {
Level string `` /* 192-byte string literal not displayed */
Pretty bool `` /* 130-byte string literal not displayed */
Color bool `` /* 130-byte string literal not displayed */
File string `` /* 160-byte string literal not displayed */
}
Log defines the available log configuration.
type Notifications ¶
type Notifications struct {
SMTP SMTP `yaml:"SMTP"`
Events Events `yaml:"events"`
EmailTemplatePath string `` /* 187-byte string literal not displayed */
TranslationPath string `` /* 295-byte string literal not displayed */
DefaultLanguage string `` /* 226-byte string literal not displayed */
RevaGateway string `yaml:"reva_gateway" env:"OC_REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata" introductionVersion:"1.0.0"`
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." introductionVersion:"1.0.0"`
Port int `yaml:"smtp_port" env:"NOTIFICATIONS_SMTP_PORT" desc:"Port of the SMTP host to connect to." introductionVersion:"1.0.0"`
Sender string `` /* 169-byte string literal not displayed */
Username string `` /* 131-byte string literal not displayed */
Password string `` /* 131-byte string literal not displayed */
Insecure bool `` /* 131-byte string literal not displayed */
Authentication string `` /* 316-byte string literal not displayed */
Encryption string `` /* 192-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.
type ServiceAccount ¶
type ServiceAccount struct {
ServiceAccountID string `` /* 236-byte string literal not displayed */
ServiceAccountSecret string `` /* 161-byte string literal not displayed */
}
ServiceAccount is the configuration for the used service account
type Store ¶
type Store struct {
Store string `` /* 226-byte string literal not displayed */
Nodes []string `` /* 368-byte string literal not displayed */
Database string `` /* 136-byte string literal not displayed */
Table string `yaml:"table" env:"NOTIFICATIONS_STORE_TABLE" desc:"The database table the store should use." introductionVersion:"1.0.0"`
TTL time.Duration `` /* 239-byte string literal not displayed */
AuthUsername string `` /* 226-byte string literal not displayed */
AuthPassword string `` /* 226-byte string literal not displayed */
}
Store configures the store to use
type Tracing ¶
type Tracing struct {
Enabled bool `yaml:"enabled" env:"OC_TRACING_ENABLED;NOTIFICATIONS_TRACING_ENABLED" desc:"Activates tracing." introductionVersion:"1.0.0"`
Type string `` /* 216-byte string literal not displayed */
Endpoint string `` /* 142-byte string literal not displayed */
Collector string `` /* 262-byte string literal not displayed */
}
Tracing defines the available tracing configuration.
Click to show internal directories.
Click to hide internal directories.