config

Documentation

Overview

Package config implements a configuration for Wraith game engine and web server.

Index

• type Config
  • func Default() (*Config, error)
  • func (cfg *Config) Load() error
• type DBConfig
  • func (db DBConfig) DSN() string

Types

type Config

type Config struct {
	Debug bool
	App   struct {
		Data            string // path to data files
		Assets          string // path to public assets
		Root            string
		Templates       string // path to templates
		TimestampFormat string
	}
	Auth struct {
		Providers string // comma separated list of authentication providers
	}
	Cookies struct {
		HttpOnly bool
		Secure   bool
	}
	DB       DBConfig
	FileName string
	Home     string
	Server   struct {
		Scheme         string
		Host           string
		MaxHeaderBytes int
		Port           string
		Timeout        struct {
			Idle  time.Duration
			Read  time.Duration
			Write time.Duration
		}
		Key  string
		Salt string
	}
}

Config defines configuration information for the application.

func Default

func Default() (*Config, error)

Default returns a default configuration. These are the values without loading the environment, configuration file, or command line.

func (*Config) Load

func (cfg *Config) Load() error

Load updates the values in a Config in this order:

1. It will load a configuration file if one is given on the command line via the `-config` flag. If provided, the file must contain a valid JSON object.
2. Environment variables, using the prefix `GOBBS`
3. Command line flags

type DBConfig

type DBConfig struct {
	Host   string
	Port   int
	Name   string
	User   string
	Secret string
}

DBConfig holds mysql configuration.

func (DBConfig) DSN

func (db DBConfig) DSN() string

DSN returns a connect string for a mysql database.