config

Documentation

Index

• func BindSourcesToStructs(service string, dst interface{}) error
• func LocalEndpoint(protocol, addr string) string
• type Config
  • func DefaultConfig() *Config
• type Mode
• type Runtime

Functions

func BindSourcesToStructs

func BindSourcesToStructs(service string, dst interface{}) error

BindSourcesToStructs assigns any config value from a config file / env variable to struct `dst`.

func LocalEndpoint

func LocalEndpoint(protocol, addr string) string

LocalEndpoint returns the local endpoint for a given protocol and address. Use it when configuring the reva runtime to get a service endpoint in the same runtime, e.g. a gateway talking to an authregistry service.

Types

type Config

type Config struct {
	*shared.Commons `yaml:"shared"`

	Tracing        *shared.Tracing        `yaml:"tracing"`
	Log            *shared.Log            `yaml:"log"`
	Cache          *shared.Cache          `yaml:"cache"`
	GRPCClientTLS  *shared.GRPCClientTLS  `yaml:"grpc_client_tls"`
	GRPCServiceTLS *shared.GRPCServiceTLS `yaml:"grpc_service_tls"`
	HTTPServiceTLS shared.HTTPServiceTLS  `yaml:"http_service_tls"`
	Reva           *shared.Reva           `yaml:"reva"`

	Mode         Mode // DEPRECATED
	File         string
	OpenCloudURL string `yaml:"opencloud_url" env:"OC_URL" desc:"URL, where OpenCloudURL is reachable for users." introductionVersion:"pre5.0"`

	Registry          string               `yaml:"registry"`
	TokenManager      *shared.TokenManager `yaml:"token_manager"`
	MachineAuthAPIKey string               `` /* 208-byte string literal not displayed */
	TransferSecret    string               `` /* 143-byte string literal not displayed */
	SystemUserID      string               `` /* 337-byte string literal not displayed */
	SystemUserAPIKey  string               `` /* 135-byte string literal not displayed */
	AdminUserID       string               `` /* 266-byte string literal not displayed */
	Runtime           Runtime              `yaml:"runtime"`

	Activitylog       *activitylog.Config    `yaml:"activitylog"`
	Antivirus         *antivirus.Config      `yaml:"antivirus"`
	AppProvider       *appProvider.Config    `yaml:"app_provider"`
	AppRegistry       *appRegistry.Config    `yaml:"app_registry"`
	Audit             *audit.Config          `yaml:"audit"`
	AuthApp           *authapp.Config        `yaml:"auth_app"`
	AuthBasic         *authbasic.Config      `yaml:"auth_basic"`
	AuthBearer        *authbearer.Config     `yaml:"auth_bearer"`
	AuthMachine       *authmachine.Config    `yaml:"auth_machine"`
	AuthService       *authservice.Config    `yaml:"auth_service"`
	Clientlog         *clientlog.Config      `yaml:"clientlog"`
	Collaboration     *collaboration.Config  `yaml:"collaboration"`
	EventHistory      *eventhistory.Config   `yaml:"eventhistory"`
	Frontend          *frontend.Config       `yaml:"frontend"`
	Gateway           *gateway.Config        `yaml:"gateway"`
	Graph             *graph.Config          `yaml:"graph"`
	Groups            *groups.Config         `yaml:"groups"`
	IDM               *idm.Config            `yaml:"idm"`
	IDP               *idp.Config            `yaml:"idp"`
	Invitations       *invitations.Config    `yaml:"invitations"`
	Nats              *nats.Config           `yaml:"nats"`
	Notifications     *notifications.Config  `yaml:"notifications"`
	OCDav             *ocdav.Config          `yaml:"ocdav"`
	OCM               *ocm.Config            `yaml:"ocm"`
	OCS               *ocs.Config            `yaml:"ocs"`
	Postprocessing    *postprocessing.Config `yaml:"postprocessing"`
	Policies          *policies.Config       `yaml:"policies"`
	Proxy             *proxy.Config          `yaml:"proxy"`
	Settings          *settings.Config       `yaml:"settings"`
	Sharing           *sharing.Config        `yaml:"sharing"`
	SSE               *sse.Config            `yaml:"sse"`
	StorageSystem     *storagesystem.Config  `yaml:"storage_system"`
	StoragePublicLink *storagepublic.Config  `yaml:"storage_public"`
	StorageShares     *storageshares.Config  `yaml:"storage_shares"`
	StorageUsers      *storageusers.Config   `yaml:"storage_users"`
	Thumbnails        *thumbnails.Config     `yaml:"thumbnails"`
	Userlog           *userlog.Config        `yaml:"userlog"`
	Users             *users.Config          `yaml:"users"`
	Web               *web.Config            `yaml:"web"`
	WebDAV            *webdav.Config         `yaml:"webdav"`
	Webfinger         *webfinger.Config      `yaml:"webfinger"`
	Search            *search.Config         `yaml:"search"`
}

Config combines all available configuration parts.

func DefaultConfig

func DefaultConfig() *Config

type Mode

type Mode int

type Runtime

type Runtime struct {
	Port       string   `yaml:"port" env:"OC_RUNTIME_PORT" desc:"The TCP port at which OpenCloud will be available" introductionVersion:"pre5.0"`
	Host       string   `yaml:"host" env:"OC_RUNTIME_HOST" desc:"The host at which OpenCloud will be available" introductionVersion:"pre5.0"`
	Services   []string `` /* 169-byte string literal not displayed */
	Disabled   []string `` /* 233-byte string literal not displayed */
	Additional []string `` /* 370-byte string literal not displayed */
}

Runtime configures the OpenCloud runtime when running in supervised mode.