Documentation
¶
Index ¶
- type AppProvider
- type Asset
- type Auth
- type Config
- type DataGatewayPort
- type Debug
- type DriverCommon
- type DriverEOS
- type DriverOCIS
- type DriverOwnCloud
- type DriverOwnCloudSQL
- type DriverS3
- type DriverS3NG
- type FrontendPort
- type Gateway
- type Groups
- type LDAP
- type LDAPGroupSchema
- type LDAPUserSchema
- type Log
- type Middleware
- type OCDav
- type OIDC
- type Port
- type PublicStorage
- type Reva
- type Sharing
- type StorageConfig
- type StoragePort
- type StorageRegistry
- type Tracing
- type UserGroupRest
- type UserOwnCloudSQL
- type Users
- type WopiDriver
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppProvider ¶ added in v1.12.0
type AppProvider struct {
Port
ExternalAddr string
Driver string
WopiDriver WopiDriver
}
AppProvider defines the available app provider configuration
type DataGatewayPort ¶
DataGatewayPort has a public url
type DriverCommon ¶
type DriverCommon struct {
// Root is the absolute path to the location of the data
Root string
ShareFolder string
// UserLayout contains the template used to construct
// the internal path, eg: `{{substr 0 1 .Username}}/{{.Username}}`
UserLayout string
// EnableHome enables the creation of home directories.
EnableHome bool
}
DriverCommon defines common driver configuration options.
type DriverEOS ¶
type DriverEOS struct {
DriverCommon
// ShadowNamespace for storing shadow data
ShadowNamespace string
// UploadsNamespace for storing upload data
UploadsNamespace string
// Location of the eos binary.
// Default is /usr/bin/eos.
EosBinary string
// Location of the xrdcopy binary.
// Default is /usr/bin/xrdcopy.
XrdcopyBinary string
// URL of the Master EOS MGM.
// Default is root://eos-example.org
MasterURL string
// URI of the EOS MGM grpc server
// Default is empty
GrpcURI string
// URL of the Slave EOS MGM.
// Default is root://eos-example.org
SlaveURL string
// Location on the local fs where to store reads.
// Defaults to os.TempDir()
CacheDirectory string
// Enables logging of the commands executed
// Defaults to false
EnableLogging bool
// ShowHiddenSysFiles shows internal EOS files like
// .sys.v# and .sys.a# files.
ShowHiddenSysFiles bool
// ForceSingleUserMode will force connections to EOS to use SingleUsername
ForceSingleUserMode bool
// UseKeyTabAuth changes will authenticate requests by using an EOS keytab.
UseKeytab bool
// SecProtocol specifies the xrootd security protocol to use between the server and EOS.
SecProtocol string
// Keytab specifies the location of the keytab to use to authenticate to EOS.
Keytab string
// SingleUsername is the username to use when SingleUserMode is enabled
SingleUsername string
// gateway service to use for uid lookups
GatewaySVC string
}
DriverEOS defines the available EOS driver configuration.
type DriverOCIS ¶
type DriverOCIS struct {
ServiceUserUUID string
}
DriverOCIS defines the available oCIS storage driver configuration.
type DriverOwnCloud ¶
type DriverOwnCloud struct {
DriverCommon
UploadInfoDir string
Redis string
Scan bool
}
DriverOwnCloud defines the available ownCloud storage driver configuration.
type DriverOwnCloudSQL ¶
type DriverOwnCloudSQL struct {
DriverCommon
UploadInfoDir string
DBUsername string
DBPassword string
DBHost string
DBPort int
DBName string
}
DriverOwnCloudSQL defines the available ownCloudSQL storage driver configuration.
type DriverS3 ¶
type DriverS3 struct {
DriverCommon
Region string
AccessKey string
SecretKey string
Endpoint string
Bucket string
}
DriverS3 defines the available S3 storage driver configuration.
type DriverS3NG ¶
type DriverS3NG struct {
DriverCommon
Region string
AccessKey string
SecretKey string
Endpoint string
Bucket string
}
DriverS3NG defines the available s3ng storage driver configuration.
type FrontendPort ¶
type FrontendPort struct {
Port
AppProviderPrefix string
DatagatewayPrefix string
OCDavPrefix string
OCSPrefix string
OCSHomeNamespace string
PublicURL string
OCSCacheWarmupDriver string
OCSResourceInfoCacheTTL int
Middleware Middleware
}
FrontendPort defines the available frontend configuration.
type Gateway ¶
type Gateway struct {
Port
DisableHomeCreationOnLogin bool
LinkGrants string
HomeMapping string
EtagCacheTTL int
}
Gateway defines the available gateway configuration.
type LDAP ¶
type LDAP struct {
Hostname string
Port int
BaseDN string
LoginFilter string
UserFilter string
UserAttributeFilter string
UserFindFilter string
UserGroupFilter string
GroupFilter string
GroupAttributeFilter string
GroupFindFilter string
GroupMemberFilter string
BindDN string
BindPassword string
IDP string
UserSchema LDAPUserSchema
GroupSchema LDAPGroupSchema
}
LDAP defines the available ldap configuration.
type LDAPGroupSchema ¶
type LDAPGroupSchema struct {
GID string
Mail string
DisplayName string
CN string
GIDNumber string
}
LDAPGroupSchema defines the available ldap group schema configuration.
type LDAPUserSchema ¶
type LDAPUserSchema struct {
UID string
Mail string
DisplayName string
CN string
UIDNumber string
GIDNumber string
}
LDAPUserSchema defines the available ldap user schema configuration.
type Port ¶
type Port struct {
// MaxCPUs can be a number or a percentage
MaxCPUs string
LogLevel string
// GRPCNetwork can be tcp, udp or unix
GRPCNetwork string
// GRPCAddr to listen on, hostname:port (0.0.0.0:9999 for all interfaces) or socket (/var/run/reva/sock)
GRPCAddr string
// Protocol can be grpc or http
// HTTPNetwork can be tcp, udp or unix
HTTPNetwork string
// HTTPAddr to listen on, hostname:port (0.0.0.0:9100 for all interfaces) or socket (/var/run/reva/sock)
HTTPAddr string
// Protocol can be grpc or http
Protocol string
// Endpoint is used by the gateway and registries (eg localhost:9100 or cloud.example.com)
Endpoint string
// DebugAddr for the debug endpoint to bind to
DebugAddr string
// Services can be used to give a list of services that should be started on this port
Services []string
// Config can be used to configure the reva instance.
// Services and Protocol will be ignored if this is used
Config map[string]interface{}
// Context allows for context cancellation and propagation
Context context.Context
// Supervised is used when running under an oCIS runtime supervision tree
Supervised bool
}
Port defines the available port configuration.
type PublicStorage ¶
type PublicStorage struct {
StoragePort
UserProviderAddr string
}
PublicStorage configures a public storage provider
type Reva ¶
type Reva struct {
// JWTSecret used to sign jwt tokens between services
JWTSecret string
TransferSecret string
TransferExpires int
OIDC OIDC
LDAP LDAP
UserGroupRest UserGroupRest
UserOwnCloudSQL UserOwnCloudSQL
OCDav OCDav
Storages StorageConfig
// Ports are used to configure which services to start on which port
Frontend FrontendPort
DataGateway DataGatewayPort
Gateway Gateway
StorageRegistry StorageRegistry
Users Users
Groups Groups
AuthProvider Users
AuthBasic Port
AuthBearer Port
Sharing Sharing
StorageHome StoragePort
StorageUsers StoragePort
StoragePublicLink PublicStorage
StorageMetadata StoragePort
AppProvider AppProvider
// Configs can be used to configure the reva instance.
// Services and Ports will be ignored if this is used
Configs map[string]interface{}
// chunking and resumable upload config (TUS)
UploadMaxChunkSize int
UploadHTTPMethodOverride string
// checksumming capabilities
ChecksumSupportedTypes []string
ChecksumPreferredUploadType string
DefaultUploadProtocol string
}
Reva defines the available reva configuration.
type Sharing ¶
type Sharing struct {
Port
UserDriver string
UserJSONFile string
UserSQLUsername string
UserSQLPassword string
UserSQLHost string
UserSQLPort int
UserSQLName string
PublicDriver string
PublicJSONFile string
PublicPasswordHashCost int
PublicJanitorRunInterval int
UserStorageMountID string
}
Sharing defines the available sharing configuration.
type StorageConfig ¶
type StorageConfig struct {
Home DriverCommon
EOS DriverEOS
Local DriverCommon
OwnCloud DriverOwnCloud
OwnCloudSQL DriverOwnCloudSQL
S3 DriverS3
S3NG DriverS3NG
Common DriverCommon
OCIS DriverOCIS
}
StorageConfig combines all available storage driver configuration parts.
type StoragePort ¶
type StoragePort struct {
Port
Driver string
MountPath string
MountID string
ExposeDataServer bool
// url the data gateway will use to route requests
DataServerURL string
// for HTTP ports with only one http service
HTTPPrefix string
TempFolder string
ReadOnly bool
}
StoragePort defines the available storage configuration.
type StorageRegistry ¶
type StorageRegistry struct {
Driver string
// HomeProvider is the path in the global namespace that the static storage registry uses to determine the home storage
HomeProvider string
Rules []string
JSON string
}
StorageRegistry defines the available storage registry configuration
type UserGroupRest ¶
type UserGroupRest struct {
ClientID string
ClientSecret string
RedisAddress string
RedisUsername string
RedisPassword string
IDProvider string
APIBaseURL string
OIDCTokenEndpoint string
TargetAPI string
}
UserGroupRest defines the REST driver specification for user and group resolution.
type UserOwnCloudSQL ¶ added in v1.12.0
type UserOwnCloudSQL struct {
DBUsername string
DBPassword string
DBHost string
DBPort int
DBName string
Idp string
Nobody int64
JoinUsername bool
JoinOwnCloudUUID bool
EnableMedialSearch bool
}
UserOwnCloudSQL defines the available ownCloudSQL user provider configuration.