config

Documentation

Index

• Variables
• type Config
  • func Global() (*Config, error)
  • func New() (*Config, error)
  • func (c *Config) Load() error
  • func (c *Config) Prepare() error
  • func (c *Config) Services() []*ServiceConfigWithKey
  • func (c *Config) Validate() error
• type ServiceConfig
• type ServiceConfigGroup
• type ServiceConfigWithKey

Variables

var (
	EthwalletURL   string
	MarketplaceURL string
)

Default endpoints to access services. These endpoints are overritten by the build Use the following format for the variable name: "[Service]URL" (where Service is the name of the service capitalized) The service name should be the name of the directory inside `systemservices` but capitalized example:

var (
	BarURL string
)

var (
	EnvMarketplaceAddress  string
	EnvMarketplaceToken    string
	EnvMarketplaceEndpoint string
)

Env to override on the system services

Types

type Config

type Config struct {
	Name string
	Path string

	Server struct {
		Address string
	}

	Log struct {
		Format      string
		ForceColors bool
		Level       string
	}

	Database struct {
		ServiceRelativePath   string
		ExecutionRelativePath string
	}

	Service ServiceConfigGroup
}

Config contains all the configuration needed.

func Global

func Global() (*Config, error)

Global returns a singleton of a Config after loaded ENV and validate the values.

func New

func New() (*Config, error)

New creates a new config with default values.

func (*Config) Load

func (c *Config) Load() error

Load reads config from environmental variables.

func (*Config) Prepare

func (c *Config) Prepare() error

Prepare setups local directories or any other required thing based on config

func (*Config) Services

func (c *Config) Services() []*ServiceConfigWithKey

Services returns all services that the configuration package is aware of

func (*Config) Validate

func (c *Config) Validate() error

Validate checks values and return an error if any validation failed.

type ServiceConfig

type ServiceConfig struct {
	URL  string
	Env  map[string]string
	Sid  string
	Hash string
}

ServiceConfig contains information related to services that the config knows about

type ServiceConfigGroup

type ServiceConfigGroup struct {
	Ethwallet   ServiceConfig
	Marketplace ServiceConfig
}

ServiceConfigGroup is the struct that contains all the `ServiceConfig` related to the config

type ServiceConfigWithKey

type ServiceConfigWithKey struct {
	*ServiceConfig
	Key string
}

ServiceConfigWithKey contains information related to services that the config knows about and their key