config

Documentation

Overview

Package configs provides tools for managing configurations

Index

• Variables
• func ApplicationDataDir() string
• func ConfigureCaddyfile(t string, v interface{}) error
• func Del(path ...string)
• func FrontClearCache(rootFolder string)
• func FrontTouchAdditionalFiles(rootFolder string)
• func FrontWriteBootstrap(rootFolder string, conf *FrontBootstrapConf) error
• func Get(path ...string) reader.Value
• func GetDatabase(name string) (string, string)
• func GetDefaultDatabase() (string, string)
• func GetFile() string
• func InitCaddyFile(tpl string, tplData interface{}) error
• func ServiceDataDir(serviceName string) (string, error)
• func Set(val interface{}, path ...string)
• type CaddyTemplateConf
  • func LoadCaddyConf() (*CaddyTemplateConf, error)
• type Config
  • func Default() *Config
  • func (c *Config) Unmarshal(val interface{}) error
  • func (c *Config) UnmarshalKey(key string, val interface{}) error
• type FrontBootstrapConf
  • func FrontBootstrapFromConfig(proxyUrl string) (*FrontBootstrapConf, error)
• type Map
  • func NewMap() *Map
  • func (c Map) Bool(key string, def ...bool) bool
  • func (c Map) Database(k string) (string, string)
  • func (c Map) Del(key string) error
  • func (c Map) Get(key string) interface{}
  • func (c Map) Int(key string, def ...int) int
  • func (c Map) Int64(key string, defaultValue ...int64) int64
  • func (c Map) Map(key string) map[string]interface{}
  • func (c Map) Set(key string, value interface{}) error
  • func (c Map) String(key string) string
  • func (c Map) StringArray(key string) []string
  • func (c Map) StringMap(key string) map[string]string
• type Value
• type Watcher

Variables

var (
	CaddyTemplate = `` /* 748-byte string literal not displayed */

	DefaultCaddyfile = filepath.Join(ApplicationDataDir(), "Caddyfile")
)

var (
	PydioConfigDir  = ApplicationDataDir()
	PydioConfigFile = "pydio.json"
)

var SampleConfig = `` /* 3426-byte string literal not displayed */

Functions

func ApplicationDataDir

func ApplicationDataDir() string

ApplicationDataDir creates a local file to store pydio system data

func ConfigureCaddyfile

func ConfigureCaddyfile(t string, v interface{}) error

func Del

func Del(path ...string)

func FrontClearCache

func FrontClearCache(rootFolder string)

FrontWriteBootstrap clears the frontend caches

func FrontTouchAdditionalFiles

func FrontTouchAdditionalFiles(rootFolder string)

FrontWriteBootstrap touches additional files in frontend boot.conf folder to avoid triggering an install process in the frontend

func FrontWriteBootstrap

func FrontWriteBootstrap(rootFolder string, conf *FrontBootstrapConf) error

FrontWriteBootstrap takes a config, executes the template and save to the front

func Get

func Get(path ...string) reader.Value

func GetDatabase

func GetDatabase(name string) (string, string)

GetDatabase retrieves the database data from the config

func GetDefaultDatabase

func GetDefaultDatabase() (string, string)

GetDefaultDatabase returns the information for the default database

func GetFile

func GetFile() string

GetFile that contain the local config

func InitCaddyFile

func InitCaddyFile(tpl string, tplData interface{}) error

InitCaddyFile creates a caddy LoaderFunc with the correct contents

func ServiceDataDir

func ServiceDataDir(serviceName string) (string, error)

ServiceDataDir returns the applicationdir/services/serviceName and creates it if it does not exists

func Set

func Set(val interface{}, path ...string)

Types

type CaddyTemplateConf

type CaddyTemplateConf struct {
	// Main site URL
	Bind *url.URL

	// Micro REST API dispatcher
	Micro *url.URL
	// Open ID Connect Service
	Dex *url.URL
	// S3 Gateway
	Gateway *url.URL
	// WebSocket server
	WebSocket *url.URL
	// Plugins loader for frontend
	FrontPlugins *url.URL

	// FPM connection, either an URL or a socket file path
	Fpm string

	// Root of the PHP Frontend
	Root string

	// Dedicated log file for caddy errors to ease debugging
	Logs string
	// Caddy compliant TLS string, either "self_signed" or paths to "cert key"
	TLS string
}

CaddyTemplateConf feeds Caddy template file with data

func LoadCaddyConf

func LoadCaddyConf() (*CaddyTemplateConf, error)

LoadCaddyConf reads the pydio config and fill a CaddyTemplateConf object ready to be executed by template

type Config

type Config struct {
	config.Config
}

Config wrapper around micro Config

func Default

func Default() *Config

Default Config with initialisation

func (*Config) Unmarshal

func (c *Config) Unmarshal(val interface{}) error

func (*Config) UnmarshalKey

func (c *Config) UnmarshalKey(key string, val interface{}) error

type FrontBootstrapConf

type FrontBootstrapConf struct {
	ProxyUrl         *url.URL
	WebSocketUrl     *url.URL
	DexID            string
	DexSecret        string
	DisableSslVerify string
}

Data passed to the bootstrapConf template

func FrontBootstrapFromConfig

func FrontBootstrapFromConfig(proxyUrl string) (*FrontBootstrapConf, error)

FrontBootstrapFromConfig reads pydio config to generate the associated bootstrap.conf for frontend.

type Map

type Map map[string]interface{}

Map structure to store configuration

func NewMap

func NewMap() *Map

NewMap variable

func (Map) Bool

func (c Map) Bool(key string, def ...bool) bool

func (Map) Database

func (c Map) Database(k string) (string, string)

Database returns the driver and dsn in that order for the given key

func (Map) Del

func (c Map) Del(key string) error

Del deletes the values associated with key.

func (Map) Get

func (c Map) Get(key string) interface{}

Get retrieves the first value associated with the given key. If there are no values associated with the key, Get returns the empty string. To access multiple values, use the map directly.

func (Map) Int

func (c Map) Int(key string, def ...int) int

Int retrieves the value at the given key if it exists and performs best effort to cast it as an int. If no such key exists or if it cannot be cast as an int, it returns the default value if defined and 0 otherwise.

func (Map) Int64

func (c Map) Int64(key string, defaultValue ...int64) int64

Int64 retrieves the value at the given key if it exists and performs best effort to cast it as an int64. If no such key exists or if it cannot be cast as an int64, it returns the default value if defined and 0 otherwise.

func (Map) Map

func (c Map) Map(key string) map[string]interface{}

func (Map) Set

func (c Map) Set(key string, value interface{}) error

Set sets the key to value. It replaces any existing values.

func (Map) String

func (c Map) String(key string) string

func (Map) StringArray

func (c Map) StringArray(key string) []string

func (Map) StringMap

func (c Map) StringMap(key string) map[string]string

type Value

type Value interface {
	Bool(def bool) bool
	Int(def int) int
	Int64(def int64) int64
	String(def string) string
	Float64(def float64) float64
	Duration(def time.Duration) time.Duration
	StringSlice(def []string) []string
	StringMap(def map[string]string) map[string]string
	Scan(val interface{}) error
	Bytes() []byte
}

Value Represent a value retrieved from the values loaded

type Watcher

type Watcher interface {
	Next() (*micro.ChangeSet, error)
	Stop()
}