config

package

Go to main page

Versions in this module

v0

v0.4.1

Jan 6, 2025

Changes in this version

type ClusterConfig

+ func (c ClusterConfig) EtcdEnabled() bool

v0.4.0

Dec 31, 2024

Changes in this version

+ const ENV_PREFIX

+ const ENV_SEPARATOR

+ const FLAG_VOLATILE

type ConfigUpdate

+ Source string

type DatabaseConfig

+ TLSEnabled bool

+ TLSSkipVerify bool

type EtcdConfig

+ Password string

+ Prefix string

+ Username string

+ func (r *EtcdConfig) Close() error

+ func (r *EtcdConfig) ComputePrefix(key string) string

+ func (r *EtcdConfig) GetManager(logger *zap.Logger) (*EtcdManager, error)

+ type EtcdManager struct

+ func NewEtcdManager(config *EtcdConfig, logger *zap.Logger) (*EtcdManager, error)

+ func (m *EtcdManager) Client() *clientv3.Client

+ func (m *EtcdManager) Close() error

type ManagerDefault

+ func (m *ManagerDefault) Shutdown() error

type SiaConfig

+ Cluster bool

v0.3.2

Nov 6, 2024

v0.3.1

Nov 6, 2024

v0.3.0

Nov 6, 2024

Changes in this version

type SiaConfig

+ HostScoreAPIURL string

v0.2.1

Oct 31, 2024

v0.2.0

Oct 30, 2024

Changes in this version

+ const APIDir

+ const CLUSTER_CONFIG_KEY

+ const CONFIG_EXTENSION

+ const CoreConfigFile

+ const FLAG_SYNC

+ const PluginsDir

+ const ProtoDir

+ const SectionConfigFile

+ const ServiceDir

+ func GetAPISectionSpecifier(pluginName string) string

+ func GetCoreSectionSpecifier(key string) string

+ func GetProtoSectionSpecifier(pluginName string) string

+ func GetServiceSectionSpecifier(pluginName string, serviceName string) string

+ type AccountConfig struct

+ DeletionGracePeriod uint

+ func (a AccountConfig) Defaults() map[string]any

type CacheConfig

+ func (c CacheConfig) Defaults() map[string]any

+ func (c CacheConfig) Validate() error

+ type CacheMode string

+ const CacheModeMemory

+ const CacheModeNone

+ const CacheModeRedis

type ClusterConfig

+ func (c ClusterConfig) RedisEnabled() bool

+ func (c ClusterConfig) Validate() error

type Config

+ func (c Config) Defaults() map[string]any

+ type ConfigChangeCallback func(key string, value any) error

+ type ConfigPropertyUpdateCategory string

+ const CONFIG_PROPERTY_UPDATE_EVENT_CATEGORY_API

+ const CONFIG_PROPERTY_UPDATE_EVENT_CATEGORY_CORE

+ const CONFIG_PROPERTY_UPDATE_EVENT_CATEGORY_PROTOCOL

+ const CONFIG_PROPERTY_UPDATE_EVENT_CATEGORY_SERVICE

+ type ConfigUpdate struct

+ Key string

+ Value any

type CoreConfig

+ Account AccountConfig

+ Cron CronConfig

+ type CronConfig struct

+ Enabled bool

+ MaxQueue uint

+ func (c CronConfig) Defaults() map[string]any

type DatabaseConfig

+ func (d DatabaseConfig) CacheEnabled() bool

+ type Etcd struct

+ func NewEtcdProvider(client *clientv3.Client, key string, timeout time.Duration) *Etcd

+ func (e *Etcd) Read() (map[string]interface{}, error)

+ func (e *Etcd) ReadBytes() ([]byte, error)

+ func (e *Etcd) Watch(cb func(event interface{}, err error)) error

+ type FieldProcessor func(parent *reflect.StructField, field reflect.StructField, value reflect.Value, ...) error

type Manager

+ All func() map[string]any

+ Exists func(key string) bool

+ FieldProcessor func(obj any, prefix string, processors ...FieldProcessor) error

+ Flags func(key string) []string

+ Get func(key string) any

+ IsEditable func(key string) bool

+ RegisterConfigChangeCallback func(callback ConfigChangeCallback)

+ SetLogger func(logger *zap.Logger)

+ Update func(key string, value any) error

type ManagerDefault

+ func (m *ManagerDefault) All() map[string]any

+ func (m *ManagerDefault) Exists(key string) bool

+ func (m *ManagerDefault) FieldProcessor(obj any, prefix string, processors ...FieldProcessor) error

+ func (m *ManagerDefault) Flags(key string) []string

+ func (m *ManagerDefault) Get(key string) any

+ func (m *ManagerDefault) IsEditable(key string) bool

+ func (m *ManagerDefault) RegisterConfigChangeCallback(callback ConfigChangeCallback)

+ func (m *ManagerDefault) SetLogger(logger *zap.Logger)

+ func (m *ManagerDefault) Update(key string, value any) error

+ type Reconfigurable interface

+ Reconfigure func(scope Scope, value any) error

+ type Scope struct

+ func NewScope(category ConfigPropertyUpdateCategory, entity, subEntity, property string) Scope

+ func NewScopeFromKey(key string) Scope

+ func (s Scope) Category() ConfigPropertyUpdateCategory

+ func (s Scope) Entity() string

+ func (s Scope) Key() string

+ func (s Scope) Property() string

+ func (s Scope) SubEntity() string

type SiaConfig

+ PriceFetchWorkers int

type StorageConfig

+ Tus TusConfig

+ type TusConfig struct

+ LockerMode string

+ func (t TusConfig) Validate() error

v0.1.1

Jun 19, 2024

Changes in this version

type Manager

+ GetProtocol func(pluginName string) ProtocolConfig

type ManagerDefault

+ func (m *ManagerDefault) GetProtocol(pluginName string) ProtocolConfig

v0.1.0

Jun 19, 2024

Changes in this version

+ var ErrInvalidServiceConfig = errors.New("service config must be of type config.ServiceConfig")

+ type APIConfig interface

+ type CacheConfig struct

+ Mode string

+ Options interface{}

+ type ClusterConfig struct

+ Enabled bool

+ Etcd *EtcdConfig

+ Redis *RedisConfig

+ type Config struct

+ Core CoreConfig

+ Plugin map[string]PluginEntity

+ type CoreConfig struct

+ Clustered *ClusterConfig

+ DB DatabaseConfig

+ Domain string

+ ExternalPort uint

+ Identity types.Identity

+ Log LogConfig

+ Mail MailConfig

+ NodeID types.UUID

+ Port uint

+ PortalName string

+ PostUploadLimit uint64

+ Storage StorageConfig

+ func (c CoreConfig) ClusterEnabled() bool

+ func (c CoreConfig) Defaults() map[string]interface{}

+ func (c CoreConfig) Validate() error

+ type DatabaseConfig struct

+ Cache *CacheConfig

+ Charset string

+ File string

+ Host string

+ Name string

+ Password string

+ Port int

+ Type string

+ Username string

+ func (d DatabaseConfig) Defaults() map[string]any

+ func (d DatabaseConfig) Validate() error

+ type Defaults interface

+ Defaults func() map[string]any

+ type EtcdConfig struct

+ DialTimeout int

+ Endpoints []string

+ func (r *EtcdConfig) Client() (*clientv3.Client, error)

+ func (r *EtcdConfig) Defaults() map[string]interface{}

+ func (r *EtcdConfig) Validate() error

+ type LogConfig struct

+ Level string

+ func (l LogConfig) Defaults() map[string]interface{}

+ type MailConfig struct

+ AuthType string

+ From string

+ Host string

+ Password string

+ Port int

+ SSL bool

+ Username string

+ func (c MailConfig) Defaults() map[string]interface{}

+ func (m MailConfig) Validate() error

+ type Manager interface

+ Config func() *Config

+ ConfigDir func() string

+ ConfigFile func() string

+ ConfigureAPI func(pluginName string, cfg APIConfig) error

+ ConfigureProtocol func(pluginName string, cfg ProtocolConfig) error

+ ConfigureService func(pluginName string, serviceName string, cfg ServiceConfig) error

+ GetAPI func(pluginName string) APIConfig

+ GetPlugin func(pluginName string) *PluginEntity

+ GetService func(serviceName string) ServiceConfig

+ Init func() error

+ Save func() error

+ type ManagerDefault struct

+ func NewManager() (*ManagerDefault, error)

+ func (m *ManagerDefault) Config() *Config

+ func (m *ManagerDefault) ConfigDir() string

+ func (m *ManagerDefault) ConfigFile() string

+ func (m *ManagerDefault) ConfigureAPI(pluginName string, cfg APIConfig) error

+ func (m *ManagerDefault) ConfigureProtocol(pluginName string, cfg ProtocolConfig) error

+ func (m *ManagerDefault) ConfigureService(pluginName string, serviceName string, cfg ServiceConfig) error

+ func (m *ManagerDefault) GetAPI(pluginName string) APIConfig

+ func (m *ManagerDefault) GetPlugin(pluginName string) *PluginEntity

+ func (m *ManagerDefault) GetService(serviceName string) ServiceConfig

+ func (m *ManagerDefault) Init() error

+ func (m *ManagerDefault) Save() error

+ type MemoryConfig struct

+ type PluginEntity struct

+ API APIConfig

+ Protocol ProtocolConfig

+ Service map[string]ServiceConfig

+ type ProtocolConfig interface

+ type RedisConfig struct

+ Address string

+ DB int

+ Password string

+ func (r *RedisConfig) Client() (*redis.Client, error)

+ func (r *RedisConfig) Defaults() map[string]interface{}

+ func (r *RedisConfig) Validate() error

+ type S3Config struct

+ AccessKey string

+ BufferBucket string

+ Endpoint string

+ Region string

+ SecretKey string

+ func (s S3Config) Defaults() map[string]any

+ func (s S3Config) Validate() error

+ type ServiceConfig interface

+ type SiaConfig struct

+ Key string

+ MaxContractSCPrice string

+ MaxDownloadPrice string

+ MaxRPCSCPrice string

+ MaxStoragePrice string

+ MaxUploadPrice string

+ PriceHistoryDays uint64

+ URL string

+ func (s SiaConfig) Defaults() map[string]interface{}

+ func (s SiaConfig) Validate() error

+ type StorageConfig struct

+ S3 S3Config

+ Sia SiaConfig

+ type SyncConfig struct

+ Enabled bool

+ func (s SyncConfig) Defaults() map[string]any

+ type Validator interface

+ Validate func() error

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