config

Documentation

Index

• type CacheStore
• type Config
• type Debug
• type Events
• type HTTP
• type Identity
• type LDAP
• type Log
• type Service
• type Spaces
• type TokenManager
• type Tracing

Types

type CacheStore

type CacheStore struct {
	Type    string `` /* 161-byte string literal not displayed */
	Address string `` /* 180-byte string literal not displayed */
	Size    int    `` /* 198-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"`

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

	Spaces   Spaces   `yaml:"spaces"`
	Identity Identity `yaml:"identity"`
	Events   Events   `yaml:"events"`

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

Config combines all available configuration parts.

type Debug

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

Debug defines the available debug configuration.

type Events

type Events struct {
	Endpoint             string `` /* 246-byte string literal not displayed */
	Cluster              string `` /* 196-byte string literal not displayed */
	TLSInsecure          bool   `yaml:"tls_insecure" env:"OCIS_INSECURE;GRAPH_EVENTS_TLS_INSECURE" desc:"Whether to verify the server TLS certificates."`
	TLSRootCACertificate string `` /* 212-byte string literal not displayed */
	EnableTLS            bool   `` /* 225-byte string literal not displayed */
}

Events combines the configuration options for the event bus.

type HTTP

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

HTTP defines the available http configuration.

type Identity

type Identity struct {
	Backend string `` /* 130-byte string literal not displayed */
	LDAP    LDAP   `yaml:"ldap"`
}

type LDAP

type LDAP struct {
	URI                string `` /* 136-byte string literal not displayed */
	CACert             string `` /* 177-byte string literal not displayed */
	Insecure           bool   `` /* 167-byte string literal not displayed */
	BindDN             string `` /* 134-byte string literal not displayed */
	BindPassword       string `` /* 127-byte string literal not displayed */
	UseServerUUID      bool   `` /* 198-byte string literal not displayed */
	UsePasswordModExOp bool   `` /* 160-byte string literal not displayed */
	WriteEnabled       bool   `` /* 178-byte string literal not displayed */

	UserBaseDN               string `yaml:"user_base_dn" env:"LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN" desc:"Search base DN for looking up LDAP users."`
	UserSearchScope          string `` /* 169-byte string literal not displayed */
	UserFilter               string `` /* 160-byte string literal not displayed */
	UserObjectClass          string `` /* 173-byte string literal not displayed */
	UserEmailAttribute       string `` /* 147-byte string literal not displayed */
	UserDisplayNameAttribute string `` /* 166-byte string literal not displayed */
	UserNameAttribute        string `` /* 141-byte string literal not displayed */
	UserIDAttribute          string `` /* 193-byte string literal not displayed */

	GroupBaseDN        string `yaml:"group_base_dn" env:"LDAP_GROUP_BASE_DN;GRAPH_LDAP_GROUP_BASE_DN" desc:"Search base DN for looking up LDAP groups."`
	GroupSearchScope   string `` /* 180-byte string literal not displayed */
	GroupFilter        string `` /* 136-byte string literal not displayed */
	GroupObjectClass   string `` /* 178-byte string literal not displayed */
	GroupNameAttribute string `` /* 146-byte string literal not displayed */
	GroupIDAttribute   string `` /* 196-byte string literal not displayed */
}

type Log

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

Log defines the available log configuration.

type Service

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

Service defines the available service configuration.

type Spaces

type Spaces struct {
	WebDavBase                      string `yaml:"webdav_base" env:"OCIS_URL;GRAPH_SPACES_WEBDAV_BASE" desc:"The public facing URL of WebDAV."`
	WebDavPath                      string `yaml:"webdav_path" env:"GRAPH_SPACES_WEBDAV_PATH" desc:"The WebDAV subpath for spaces."`
	DefaultQuota                    string `yaml:"default_quota" env:"GRAPH_SPACES_DEFAULT_QUOTA" desc:"The default quota in bytes."`
	ExtendedSpacePropertiesCacheTTL int    `` /* 154-byte string literal not displayed */
}

type TokenManager

type TokenManager struct {
	JWTSecret string `yaml:"jwt_secret" env:"OCIS_JWT_SECRET;GRAPH_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;GRAPH_TRACING_ENABLED" desc:"Activates tracing."`
	Type      string `` /* 190-byte string literal not displayed */
	Endpoint  string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT;GRAPH_TRACING_ENDPOINT" desc:"The endpoint of the tracing agent."`
	Collector string `` /* 228-byte string literal not displayed */
}

Tracing defines the available tracing configuration.