config

package
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Mar 18, 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 App

type App struct {
	Name        string `` /* 279-byte string literal not displayed */
	Product     string `` /* 169-byte string literal not displayed */
	Description string `yaml:"description" env:"COLLABORATION_APP_DESCRIPTION" desc:"App description" introductionVersion:"1.0.0"`
	Icon        string `yaml:"icon" env:"COLLABORATION_APP_ICON" desc:"Icon for the app" introductionVersion:"1.0.0"`

	Addr     string `` /* 146-byte string literal not displayed */
	Insecure bool   `` /* 149-byte string literal not displayed */

	ProofKeys          ProofKeys `yaml:"proofkeys"`
	LicenseCheckEnable bool      `` /* 212-byte string literal not displayed */
}

App defines the available app configuration.

type CS3Api

type CS3Api struct {
	Gateway       Gateway               `yaml:"gateway"`
	DataGateway   DataGateway           `yaml:"datagateway"`
	GRPCClientTLS *shared.GRPCClientTLS `yaml:"grpc_client_tls"`
}

CS3Api defines the available configuration in order to access to the CS3 gateway.

type Config

type Config struct {
	Commons *shared.Commons `yaml:"-"` // don't use this directly as configuration for a service

	Service Service `yaml:"-"`
	App     App     `yaml:"app"`
	Store   Store   `yaml:"store"`

	TokenManager *TokenManager `yaml:"token_manager"`

	GRPC GRPC `yaml:"grpc"`
	HTTP HTTP `yaml:"http"`

	Wopi   Wopi   `yaml:"wopi"`
	CS3Api CS3Api `yaml:"cs3api"`

	Tracing *Tracing `yaml:"tracing"`
	Log     *Log     `yaml:"log"`
	Debug   Debug    `yaml:"debug"`

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

Config combines all available configuration parts.

type DataGateway

type DataGateway struct {
	Insecure bool `` /* 145-byte string literal not displayed */
}

DataGateway defines the available configuration for the CS3 API data gateway

type Debug

type Debug struct {
	Addr   string `` /* 178-byte string literal not displayed */
	Token  string `yaml:"token" env:"COLLABORATION_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint." introductionVersion:"1.0.0"`
	Pprof  bool   `` /* 127-byte string literal not displayed */
	Zpages bool   `` /* 160-byte string literal not displayed */
}

Debug defines the available debug configuration. Not used at the moment

type GRPC

type GRPC struct {
	Addr     string `yaml:"addr" env:"COLLABORATION_GRPC_ADDR" desc:"The bind address of the GRPC service." introductionVersion:"1.0.0"`
	Protocol string `` /* 145-byte string literal not displayed */

	Namespace string `yaml:"-"`
}

GRPC defines the available grpc configuration.

type Gateway

type Gateway struct {
	Name string `yaml:"name" env:"OC_REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata." introductionVersion:"1.0.0"`
}

Gateway defines the available configuration for the CS3 API gateway

type HTTP

type HTTP struct {
	Addr      string                `yaml:"addr" env:"COLLABORATION_HTTP_ADDR" desc:"The bind address of the HTTP service." introductionVersion:"1.0.0"`
	Namespace string                `yaml:"-"`
	TLS       shared.HTTPServiceTLS `yaml:"tls"`
}

HTTP defines the available http configuration.

type Log

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

Log defines the available log configuration.

type ProofKeys

type ProofKeys struct {
	Disable  bool   `yaml:"disable" env:"COLLABORATION_APP_PROOF_DISABLE" desc:"Disable the proof keys verification" introductionVersion:"1.0.0"`
	Duration string `` /* 245-byte string literal not displayed */
}

type Service

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

Service defines the available service configuration.

type Store

type Store struct {
	Store        string        `` /* 226-byte string literal not displayed */
	Nodes        []string      `` /* 368-byte string literal not displayed */
	Database     string        `` /* 136-byte string literal not displayed */
	Table        string        `yaml:"table" env:"COLLABORATION_STORE_TABLE" desc:"The database table the store should use." introductionVersion:"1.0.0"`
	TTL          time.Duration `` /* 234-byte string literal not displayed */
	AuthUsername string        `` /* 226-byte string literal not displayed */
	AuthPassword string        `` /* 226-byte string literal not displayed */
}

Store configures the store to use

type TokenManager

type TokenManager struct {
	JWTSecret string `` /* 141-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;COLLABORATION_TRACING_ENABLED" desc:"Activates tracing." introductionVersion:"1.0.0"`
	Type      string `` /* 216-byte string literal not displayed */
	Endpoint  string `` /* 142-byte string literal not displayed */
	Collector string `` /* 262-byte string literal not displayed */
}

Tracing defines the available tracing configuration. Not used at the moment

func (Tracing) Convert

func (t Tracing) Convert() tracing.Config

Convert Tracing to the tracing package's Config struct.

type Wopi

type Wopi struct {
	WopiSrc     string `` /* 271-byte string literal not displayed */
	Secret      string `` /* 195-byte string literal not displayed */
	DisableChat bool   `` /* 204-byte string literal not displayed */
	ProxyURL    string `` /* 355-byte string literal not displayed */
	ProxySecret string `` /* 244-byte string literal not displayed */
	ShortTokens bool   `` /* 285-byte string literal not displayed */
}

Wopi defines the available configuration for the WOPI endpoint.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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