Documentation

Overview

    Package config holds all specified configuration information aggregated from all possible inputs.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type Config

    type Config struct {
    	Username     string
    	Password     string
    	Environments map[string]Environment
    	Port         int
    }

      Config is a representation of a config yaml. It can contain multiple Environments.

      func Custom

      func Custom(getenv func(string) string, configPath string) (Config, error)

        Custom returns a new Config struct with information from environment variables and a custom config file.

        func Default

        func Default(getenv func(string) string) (Config, error)

          Default returns a new Config struct with information from environment variables and the default config file (./config.yml).

          type Environment

          type Environment struct {
          	Name         string
          	Domain       string
          	Foundations  []string `yaml:",flow"`
          	Authenticate bool
          	SkipSSL      bool `yaml:"skip_ssl"`
          	Instances    uint16
          }

            Environment is representation of a single environment configuration.

            type EnvironmentsNotSpecifiedError

            type EnvironmentsNotSpecifiedError struct{}

            func (EnvironmentsNotSpecifiedError) Error

            type MissingParameterError

            type MissingParameterError struct{}

            func (MissingParameterError) Error

            func (e MissingParameterError) Error() string

            type ParseYamlError

            type ParseYamlError struct {
            	Err error
            }

            func (ParseYamlError) Error

            func (e ParseYamlError) Error() string