config

Documentation

Index

• Constants
• func GetConfig(root string) (conf *viper.Viper)
• func InitRuntime(root string)
• func RuntimeDir(root string) string
• func SetDefaults(runtime string, conf *viper.Viper) *viper.Viper

Constants

const (
	// RUNTIME_ENV defines the name of the environment variable for runtime path
	RUNTIME_ENV = "ANGINE_RUNTIME"
	// DEFAULT_RUNTIME defines the default path for runtime path relative to $HOME
	DEFAULT_RUNTIME = ".angine"
	// DATADIR is the data dir in the runtime, basically you don't change this never
	DATADIR    = "data"
	ARCHIVEDIR = "archive"
	// CONFIGFILE is the name of the configuration file name in the runtime path for angine
	CONFIGFILE = "config.toml"
)

const CONFIGTPL = `` /* 273-byte string literal not displayed */

Functions

func GetConfig

func GetConfig(root string) (conf *viper.Viper)

GetConfig returns a ready-to-go config instance with all defaults filled in

func InitRuntime

func InitRuntime(root string)

InitRuntime makes all the necessary directorys for angine's runtime and generate the config template for you if it is not there already

func RuntimeDir

func RuntimeDir(root string) string

RuntimeDir determines where the runtime directory is : param > environment > default

func SetDefaults

func SetDefaults(runtime string, conf *viper.Viper) *viper.Viper

SetDefaults sets all the default configs for angine