config

Documentation

Index

• type CORS
• type CacheStore
• type Config
• type Debug
• type HTTP
• type IdentityManagement
• type Log
• type Service
• type TokenManager
• type Tracing

Types

type CORS

type CORS struct {
	AllowedOrigins   []string `` /* 287-byte string literal not displayed */
	AllowedMethods   []string `` /* 291-byte string literal not displayed */
	AllowedHeaders   []string `` /* 294-byte string literal not displayed */
	AllowCredentials bool     `` /* 289-byte string literal not displayed */
}

CORS defines the available cors configuration.

type CacheStore

type CacheStore struct {
	Type    string `` /* 159-byte string literal not displayed */
	Address string `` /* 178-byte string literal not displayed */
	Size    int    `` /* 196-byte string literal not displayed */
}

CacheStore defines the available configuration for the cache store

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"`
	CacheStore *CacheStore `yaml:"cache_store"`
	Debug      Debug       `yaml:"debug"`

	HTTP HTTP `yaml:"http"`

	TokenManager  *TokenManager         `yaml:"token_manager"`
	Reva          *shared.Reva          `yaml:"reva"`
	GRPCClientTLS *shared.GRPCClientTLS `yaml:"grpc_client_tls"`

	IdentityManagement IdentityManagement `yaml:"identity_management"`

	AccountBackend    string `yaml:"-"` // we only support cs3 backend, no need to have this configurable
	MachineAuthAPIKey string ``         /* 198-byte string literal not displayed */

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

Config combines all available configuration parts.

type Debug

type Debug struct {
	Addr   string `` /* 140-byte string literal not displayed */
	Token  string `yaml:"token" env:"OCS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint."`
	Pprof  bool   `yaml:"pprof" env:"OCS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling."`
	Zpages bool   `yaml:"zpages" env:"OCS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing in-memory traces."`
}

Debug defines the available debug configuration.

type HTTP

type HTTP struct {
	Addr      string                `yaml:"addr" env:"OCS_HTTP_ADDR" desc:"The bind address of the HTTP service."`
	Root      string                `yaml:"root" env:"OCS_HTTP_ROOT" desc:"Subdirectory that serves as the root for this HTTP service."`
	Namespace string                `yaml:"-"`
	CORS      CORS                  `yaml:"cors"`
	TLS       shared.HTTPServiceTLS `yaml:"tls"`
}

HTTP defines the available http configuration.

type IdentityManagement

type IdentityManagement struct {
	Address string `` /* 132-byte string literal not displayed */
}

IdentityManagement keeps track of the OIDC address. This is because Reva requisite of uniqueness for users is based in the combination of IDP hostname + UserID. For more information see: https://github.com/cs3org/reva/blob/4fd0229f13fae5bc9684556a82dbbd0eced65ef9/pkg/storage/utils/decomposedfs/node/node.go#L856-L865

type Log

type Log struct {
	Level  string `` /* 170-byte string literal not displayed */
	Pretty bool   `mapstructure:"pretty" env:"OCIS_LOG_PRETTY;OCS_LOG_PRETTY" desc:"Activates pretty log output."`
	Color  bool   `mapstructure:"color" env:"OCIS_LOG_COLOR;OCS_LOG_COLOR" desc:"Activates colorized log output."`
	File   string `mapstructure:"file" env:"OCIS_LOG_FILE;OCS_LOG_FILE" desc:"The path to the log file. Activates logging to this file if set."`
}

Log defines the available log configuration.

type Service

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

Service defines the available service configuration.

type TokenManager

type TokenManager struct {
	JWTSecret string `yaml:"jwt_secret" env:"OCIS_JWT_SECRET;OCS_JWT_SECRET" desc:"The secret to mint and validate jwt tokens."`
}

TokenManager is the config for using the reva token manager

type Tracing

type Tracing struct {
	Enabled   bool   `yaml:"enabled" env:"OCIS_TRACING_ENABLED;OCS_TRACING_ENABLED" desc:"Activates tracing."`
	Type      string `` /* 188-byte string literal not displayed */
	Endpoint  string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT;OCS_TRACING_ENDPOINT" desc:"The endpoint of the tracing agent."`
	Collector string `` /* 226-byte string literal not displayed */
}

Tracing defines the available tracing configuration.