Documentation ¶
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"` GRPC GRPCConfig `yaml:"grpc"` TokenManager *TokenManager `yaml:"token_manager"` Reva *shared.Reva `yaml:"reva"` SkipUserGroupsInToken bool `` /* 154-byte string literal not displayed */ Driver string `` /* 140-byte string literal not displayed */ Drivers Drivers `yaml:"drivers"` Supervised bool `yaml:"-"` Context context.Context `yaml:"-"` }
type Debug ¶
type Debug struct { Addr string `` /* 142-byte string literal not displayed */ Token string `yaml:"token" env:"USERS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint."` Pprof bool `yaml:"pprof" env:"USERS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling."` Zpages bool `yaml:"zpages" env:"USERS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing in-memory traces."` }
type Drivers ¶
type Drivers struct { LDAP LDAPDriver `yaml:"ldap"` OwnCloudSQL OwnCloudSQLDriver `yaml:"owncloudsql"` JSON JSONDriver `yaml:"json,omitempty"` // not supported by the oCIS product, therefore not part of docs REST RESTProvider `yaml:"rest,omitempty"` // not supported by the oCIS product, therefore not part of docs }
type GRPCConfig ¶
type GRPCConfig struct { Addr string `yaml:"addr" env:"USERS_GRPC_ADDR" desc:"The bind address of the GRPC service."` TLS *shared.GRPCServiceTLS `yaml:"tls"` Namespace string `yaml:"-"` Protocol string `yaml:"protocol" env:"USERS_GRPC_PROTOCOL" desc:"The transport protocol of the GPRC service."` }
type JSONDriver ¶
type JSONDriver struct {
File string `yaml:"file"`
}
type LDAPDriver ¶
type LDAPDriver struct { URI string `` /* 136-byte string literal not displayed */ CACert string `` /* 178-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 */ UserBaseDN string `yaml:"user_base_dn" env:"LDAP_USER_BASE_DN;USERS_LDAP_USER_BASE_DN" desc:"Search base DN for looking up LDAP users."` GroupBaseDN string `yaml:"group_base_dn" env:"LDAP_GROUP_BASE_DN;USERS_LDAP_GROUP_BASE_DN" desc:"Search base DN for looking up LDAP groups."` UserScope string `` /* 162-byte string literal not displayed */ GroupScope string `` /* 166-byte string literal not displayed */ UserSubstringFilterType string `` /* 330-byte string literal not displayed */ UserFilter string `` /* 160-byte string literal not displayed */ GroupFilter string `` /* 136-byte string literal not displayed */ UserObjectClass string `` /* 177-byte string literal not displayed */ GroupObjectClass string `` /* 182-byte string literal not displayed */ IDP string `` /* 179-byte string literal not displayed */ UserSchema LDAPUserSchema `yaml:"user_schema"` GroupSchema LDAPGroupSchema `yaml:"group_schema"` }
type LDAPGroupSchema ¶
type LDAPGroupSchema struct { ID string `` /* 177-byte string literal not displayed */ IDIsOctetString bool `` /* 306-byte string literal not displayed */ Mail string `` /* 146-byte string literal not displayed */ DisplayName string `` /* 191-byte string literal not displayed */ Groupname string `` /* 138-byte string literal not displayed */ Member string `` /* 129-byte string literal not displayed */ }
type LDAPUserSchema ¶
type LDAPUserSchema struct { ID string `` /* 174-byte string literal not displayed */ IDIsOctetString bool `` /* 302-byte string literal not displayed */ Mail string `` /* 128-byte string literal not displayed */ DisplayName string `` /* 148-byte string literal not displayed */ Username string `` /* 132-byte string literal not displayed */ }
type Log ¶
type Log struct { Level string `` /* 164-byte string literal not displayed */ Pretty bool `yaml:"pretty" env:"OCIS_LOG_PRETTY;USERS_LOG_PRETTY" desc:"Activates pretty log output."` Color bool `yaml:"color" env:"OCIS_LOG_COLOR;USERS_LOG_COLOR" desc:"Activates colorized log output."` File string `yaml:"file" env:"OCIS_LOG_FILE;USERS_LOG_FILE" desc:"The path to the log file. Activates logging to this file if set."` }
type OwnCloudSQLDriver ¶
type OwnCloudSQLDriver struct { DBUsername string `` /* 129-byte string literal not displayed */ DBPassword string `yaml:"db_password" env:"USERS_OWNCLOUDSQL_DB_PASSWORD" desc:"Password for the database user."` DBHost string `yaml:"db_host" env:"USERS_OWNCLOUDSQL_DB_HOST" desc:"Hostname of the database server."` DBPort int `yaml:"db_port" env:"USERS_OWNCLOUDSQL_DB_PORT" desc:"Network port to use for the database connection."` DBName string `yaml:"db_name" env:"USERS_OWNCLOUDSQL_DB_NAME" desc:"Name of the owncloud database."` IDP string `` /* 161-byte string literal not displayed */ Nobody int64 `yaml:"nobody" env:"USERS_OWNCLOUDSQL_NOBODY" desc:"Fallback number if no numeric UID and GID properties are provided."` JoinUsername bool `yaml:"join_username" env:"USERS_OWNCLOUDSQL_JOIN_USERNAME" desc:"Join the user properties table to read usernames"` JoinOwnCloudUUID bool `yaml:"join_owncloud_uuid" env:"USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID" desc:"Join the user properties table to read user IDs."` EnableMedialSearch bool `` /* 219-byte string literal not displayed */ }
type RESTProvider ¶
type TokenManager ¶
type TokenManager struct {
JWTSecret string `yaml:"jwt_secret" env:"OCIS_JWT_SECRET;USERS_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;USERS_TRACING_ENABLED" desc:"Activates tracing."` Type string `` /* 190-byte string literal not displayed */ Endpoint string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT;USERS_TRACING_ENDPOINT" desc:"The endpoint of the tracing agent."` Collector string `` /* 228-byte string literal not displayed */ }
Click to show internal directories.
Click to hide internal directories.