config

Documentation

Index

• func GetEnv(cfg *Config) []string
• func StructMappings(cfg *Config) []shared.EnvBinding
• type CORS
• type Config
  • func DefaultConfig() *Config
  • func New() *Config
• type Debug
• type HTTP
• type Service
• type Tracing

Functions

func GetEnv

func GetEnv(cfg *Config) []string

GetEnv fetches a list of known env variables for this extension. It is to be used by gookit, as it provides a list with all the environment variables an extension supports.

func StructMappings

func StructMappings(cfg *Config) []shared.EnvBinding

StructMappings binds a set of environment variables to a destination on cfg. Iterating over this set and editing the Destination value of a binding will alter the original value, as it is a pointer to its memory address. This lets us propagate changes easier.

Types

type CORS

type CORS struct {
	AllowedOrigins   []string `ocisConfig:"allowed_origins"`
	AllowedMethods   []string `ocisConfig:"allowed_methods"`
	AllowedHeaders   []string `ocisConfig:"allowed_headers"`
	AllowCredentials bool     `ocisConfig:"allow_credentials"`
}

CORS defines the available cors configuration.

type Config

type Config struct {
	*shared.Commons

	File            string      `ocisConfig:"file"`
	Log             *shared.Log `ocisConfig:"log"`
	Debug           Debug       `ocisConfig:"debug"`
	HTTP            HTTP        `ocisConfig:"http"`
	Tracing         Tracing     `ocisConfig:"tracing"`
	Service         Service     `ocisConfig:"service"`
	OcisPublicURL   string      `ocisConfig:"ocis_public_url"`
	WebdavNamespace string      `ocisConfig:"webdav_namespace"`

	Context    context.Context
	Supervised bool
}

Config combines all available configuration parts.

func DefaultConfig

func DefaultConfig() *Config

func New

func New() *Config

New initializes a new configuration with or without defaults.

type Debug

type Debug struct {
	Addr   string `ocisConfig:"addr"`
	Token  string `ocisConfig:"token"`
	Pprof  bool   `ocisConfig:"pprof"`
	Zpages bool   `ocisConfig:"zpages"`
}

Debug defines the available debug configuration.

type HTTP

type HTTP struct {
	Addr string `ocisConfig:"addr"`
	Root string `ocisConfig:"root"`
	CORS CORS   `ocisConfig:"cors"`
}

HTTP defines the available http configuration.

type Service

type Service struct {
	Name      string `ocisConfig:"name"`
	Namespace string `ocisConfig:"namespace"`
	Version   string `ocisConfig:"version"`
}

Service defines the available service configuration.

type Tracing

type Tracing struct {
	Enabled   bool   `ocisConfig:"enabled"`
	Type      string `ocisConfig:"type"`
	Endpoint  string `ocisConfig:"endpoint"`
	Collector string `ocisConfig:"collector"`
	Service   string `ocisConfig:"service"`
}

Tracing defines the available tracing configuration.