config

Documentation

Overview

Package config implements configuration for the wash executable using https://github.com/spf13/viper.

Index

• Constants
• Variables
• func DefaultFile() string
• func DefaultFileAbsPath() string
• func Init() error
• func ReadFrom(file string) error

Constants

const (
	SocketKey   = "socket"
	EmbeddedKey = "embedded"
)

Contains all the keys for Wash's shared config

Variables

var Embedded bool

var Socket string

Socket is the path to the Wash server's UNIX socket

Functions

func DefaultFile

func DefaultFile() string

DefaultFile returns the default config file's path

func DefaultFileAbsPath

func DefaultFileAbsPath() string

DefaultFileAbsPath returns the default config file's absolute path

func Init

func Init() error

Init initializes the config package. It loads Wash's defaults and sets up viper

func ReadFrom

func ReadFrom(file string) error

ReadFrom reads the config from the specified file. If file == DefaultFile(), then ReadFrom wil not return an error if file does not exist.