config

Documentation

Index

• type Config
  • func New(version string) (*Config, error)
  • func (c *Config) Flags() []cli.Flag
  • func (c Config) Validate() error
• type Environment
• type Mode

Types

type Config

type Config struct {
	BillingRedirect string
	Environment     string
	Mode            string
	Version         string
}

Config holds the configuration for the application.

func New

func New(version string) (*Config, error)

New initialises a new Config struct.

func (*Config) Flags

func (c *Config) Flags() []cli.Flag

Flags returns CLI flags for the application, that map to the Config struct.

func (Config) Validate

func (c Config) Validate() error

Validate checks that all flag values are valid. Most of the time this can be done within the Action() function of the flag, but sometimes it's necessary to validate based on the state of other flags.

type Environment

type Environment string

Environment is an enum for the different environments the application can run in.

type Mode

type Mode string

Mode is an enum for the different modes the application can run in.

const (
	EnvironmentDocker Mode = "docker"
	EnvironmentLocal  Mode = "local"
)

const (
	ModeBridge     Mode = "bridge"
	ModeStandalone Mode = "standalone"
)