config

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 24, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppHandler

type AppHandler struct {
	Prefix            string `yaml:"-"`
	Insecure          bool   `` /* 142-byte string literal not displayed */
	SecureViewAppAddr string `` /* 255-byte string literal not displayed */
}

type Archiver

type Archiver struct {
	MaxNumFiles int64  `` /* 149-byte string literal not displayed */
	MaxSize     int64  `` /* 145-byte string literal not displayed */
	Prefix      string `yaml:"-"`
	Insecure    bool   `` /* 139-byte string literal not displayed */
}

type Auth

type Auth struct {
	CredentialsByUserAgent map[string]string `yaml:"credentials_by_user_agent"`
}

Auth configures reva http auth middleware.

type CBOXDriver

type CBOXDriver struct {
	DBUsername string `yaml:"db_username,omitempty"`
	DBPassword string `yaml:"db_password,omitempty"`
	DBHost     string `yaml:"db_host,omitempty"`
	DBPort     int    `yaml:"db_port,omitempty"`
	DBName     string `yaml:"db_name,omitempty"`
	Namespace  string `yaml:"namespace,omitempty"`
}

type CORS

type CORS struct {
	AllowedOrigins   []string `` /* 368-byte string literal not displayed */
	AllowedMethods   []string `` /* 372-byte string literal not displayed */
	AllowedHeaders   []string `` /* 374-byte string literal not displayed */
	AllowCredentials bool     `` /* 320-byte string literal not displayed */
}

CORS defines the available cors configuration.

type CacheWarmupDrivers

type CacheWarmupDrivers struct {
	CBOX CBOXDriver `yaml:"cbox,omitempty"`
}

type Checksums

type Checksums struct {
	SupportedTypes      []string `` /* 322-byte string literal not displayed */
	PreferredUploadType string   `` /* 306-byte string literal not displayed */
}

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"`

	HTTP HTTPConfig `yaml:"http"`

	TransferSecret string `` /* 142-byte string literal not displayed */

	TokenManager      *TokenManager `yaml:"token_manager"`
	Reva              *shared.Reva  `yaml:"reva"`
	MachineAuthAPIKey string        `` /* 233-byte string literal not displayed */

	SkipUserGroupsInToken bool `` /* 185-byte string literal not displayed */

	EnableFavorites                bool   `` /* 140-byte string literal not displayed */
	MaxQuota                       uint64 `` /* 208-byte string literal not displayed */
	UploadMaxChunkSize             int    `` /* 163-byte string literal not displayed */
	UploadHTTPMethodOverride       string `` /* 167-byte string literal not displayed */
	DefaultUploadProtocol          string `` /* 250-byte string literal not displayed */
	EnableFederatedSharingIncoming bool   `` /* 274-byte string literal not displayed */
	EnableFederatedSharingOutgoing bool   `` /* 274-byte string literal not displayed */
	SearchMinLength                int    `` /* 286-byte string literal not displayed */
	Edition                        string `` /* 133-byte string literal not displayed */
	DisableSSE                     bool   `` /* 190-byte string literal not displayed */
	DefaultLinkPermissions         int    `` /* 297-byte string literal not displayed */

	PublicURL              string      `` /* 134-byte string literal not displayed */
	MaxConcurrency         int         `` /* 318-byte string literal not displayed */
	AppHandler             AppHandler  `yaml:"app_handler"`
	Archiver               Archiver    `yaml:"archiver"`
	DataGateway            DataGateway `yaml:"data_gateway"`
	OCS                    OCS         `yaml:"ocs"`
	Checksums              Checksums   `yaml:"checksums"`
	ReadOnlyUserAttributes []string    `` /* 476-byte string literal not displayed */
	LDAPServerWriteEnabled bool        `` /* 379-byte string literal not displayed */
	FullTextSearch         bool        `` /* 169-byte string literal not displayed */

	Middleware Middleware `yaml:"middleware"`

	Events           Events                `yaml:"events"`
	GRPCClientTLS    *shared.GRPCClientTLS `yaml:"grpc_client_tls"`
	AutoAcceptShares bool                  `` /* 209-byte string literal not displayed */
	ServiceAccount   ServiceAccount        `yaml:"service_account"`

	PasswordPolicy PasswordPolicy `yaml:"password_policy"`

	ConfigurableNotifications bool `` /* 158-byte string literal not displayed */

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

type DataGateway

type DataGateway struct {
	Prefix string `yaml:"prefix" env:"FRONTEND_DATA_GATEWAY_PREFIX" desc:"Path prefix for the data gateway." introductionVersion:"1.0.0"`
}

type Debug

type Debug struct {
	Addr   string `` /* 173-byte string literal not displayed */
	Token  string `yaml:"token" env:"FRONTEND_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint." introductionVersion:"1.0.0"`
	Pprof  bool   `yaml:"pprof" env:"FRONTEND_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling." introductionVersion:"1.0.0"`
	Zpages bool   `` /* 155-byte string literal not displayed */
}

type Events

type Events struct {
	Endpoint             string `` /* 246-byte string literal not displayed */
	Cluster              string `` /* 288-byte string literal not displayed */
	TLSInsecure          bool   `` /* 148-byte string literal not displayed */
	TLSRootCACertificate string `` /* 286-byte string literal not displayed */
	EnableTLS            bool   `` /* 258-byte string literal not displayed */
	AuthUsername         string `` /* 263-byte string literal not displayed */
	AuthPassword         string `` /* 263-byte string literal not displayed */
}

Events combines the configuration options for the event bus.

type HTTPConfig

type HTTPConfig struct {
	Addr      string `yaml:"addr" env:"FRONTEND_HTTP_ADDR" desc:"The bind address of the HTTP service." introductionVersion:"1.0.0"`
	Namespace string `yaml:"-"`
	Protocol  string `yaml:"protocol" env:"FRONTEND_HTTP_PROTOCOL" desc:"The transport protocol of the HTTP service." introductionVersion:"1.0.0"`
	Prefix    string `` /* 143-byte string literal not displayed */
	CORS      CORS   `yaml:"cors"`
}

type Log

type Log struct {
	Level  string `` /* 179-byte string literal not displayed */
	Pretty bool   `yaml:"pretty" env:"OC_LOG_PRETTY;FRONTEND_LOG_PRETTY" desc:"Activates pretty log output." introductionVersion:"1.0.0"`
	Color  bool   `yaml:"color" env:"OC_LOG_COLOR;FRONTEND_LOG_COLOR" desc:"Activates colorized log output." introductionVersion:"1.0.0"`
	File   string `` /* 147-byte string literal not displayed */
}

type Middleware

type Middleware struct {
	Auth Auth `yaml:"auth"`
}

Middleware configures reva middlewares.

type OCS

type OCS struct {
	Prefix                      string        `` /* 299-byte string literal not displayed */
	SharePrefix                 string        `` /* 318-byte string literal not displayed */
	HomeNamespace               string        `` /* 263-byte string literal not displayed */
	AdditionalInfoAttribute     string        `` /* 316-byte string literal not displayed */
	StatCacheType               string        `` /* 420-byte string literal not displayed */
	StatCacheNodes              []string      `` /* 563-byte string literal not displayed */
	StatCacheDatabase           string        `` /* 136-byte string literal not displayed */
	StatCacheTable              string        `` /* 277-byte string literal not displayed */
	StatCacheTTL                time.Duration `` /* 439-byte string literal not displayed */
	StatCacheDisablePersistence bool          `` /* 444-byte string literal not displayed */
	StatCacheAuthUsername       string        `` /* 407-byte string literal not displayed */
	StatCacheAuthPassword       string        `` /* 407-byte string literal not displayed */

	CacheWarmupDriver                    string             `yaml:"cache_warmup_driver,omitempty"`  // not supported by the OpenCloud product, therefore not part of docs
	CacheWarmupDrivers                   CacheWarmupDrivers `yaml:"cache_warmup_drivers,omitempty"` // not supported by the OpenCloud product, therefore not part of docs
	EnableDenials                        bool               ``                                      /* 292-byte string literal not displayed */
	ListOCMShares                        bool               ``                                      /* 370-byte string literal not displayed */
	IncludeOCMSharees                    bool               ``                                      /* 332-byte string literal not displayed */
	PublicShareMustHavePassword          bool               ``                                      /* 435-byte string literal not displayed */
	WriteablePublicShareMustHavePassword bool               ``                                      /* 556-byte string literal not displayed */
	ShowUserEmailInResults               bool               ``                                      /* 270-byte string literal not displayed */
}

type PasswordPolicy

type PasswordPolicy struct {
	Disabled               bool   `` /* 187-byte string literal not displayed */
	MinCharacters          int    `` /* 208-byte string literal not displayed */
	MinLowerCaseCharacters int    `` /* 240-byte string literal not displayed */
	MinUpperCaseCharacters int    `` /* 240-byte string literal not displayed */
	MinDigits              int    `` /* 187-byte string literal not displayed */
	MinSpecialCharacters   int    `` /* 274-byte string literal not displayed */
	BannedPasswordsList    string `` /* 290-byte string literal not displayed */
}

PasswordPolicy configures reva password policy

type Service

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

type ServiceAccount

type ServiceAccount struct {
	ServiceAccountID     string `` /* 231-byte string literal not displayed */
	ServiceAccountSecret string `` /* 156-byte string literal not displayed */
}

ServiceAccount is the configuration for the used service account

type TokenManager

type TokenManager struct {
	JWTSecret string `` /* 136-byte string literal not displayed */
}

TokenManager is the config for using the reva token manager

type Tracing

type Tracing struct {
	Enabled   bool   `yaml:"enabled" env:"OC_TRACING_ENABLED;FRONTEND_TRACING_ENABLED" desc:"Activates tracing." introductionVersion:"1.0.0"`
	Type      string `` /* 211-byte string literal not displayed */
	Endpoint  string `` /* 137-byte string literal not displayed */
	Collector string `` /* 257-byte string literal not displayed */
}

Tracing sets the tracing parameters for the frontend service.

func (Tracing) Convert

func (t Tracing) Convert() tracing.Config

Convert Tracing to the tracing package's Config struct.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL