config

Documentation

Index

• Constants
• func ContextStoreDir() string
• func Dir() string
• func Load(configDir string) (*configfile.ConfigFile, error)
• func LoadDefaultConfigFile(stderr io.Writer) *configfile.ConfigFile
• func LoadFromReader(configData io.Reader) (*configfile.ConfigFile, error)
• func Path(p ...string) (string, error)
• func SetDir(dir string)

Constants

const (
	// EnvOverrideConfigDir is the name of the environment variable that can be
	// used to override the location of the client configuration files (~/.docker).
	//
	// It takes priority over the default, but can be overridden by the "--config"
	// command line option.
	EnvOverrideConfigDir = "DOCKER_CONFIG"

	// ConfigFileName is the name of the client configuration file inside the
	// config-directory.
	ConfigFileName = "config.json"
)

Functions

func ContextStoreDir

func ContextStoreDir() string

ContextStoreDir returns the directory the docker contexts are stored in

func Dir

func Dir() string

Dir returns the directory the configuration file is stored in

func Load

func Load(configDir string) (*configfile.ConfigFile, error)

Load reads the configuration files in the given directory, and sets up the auth config information and returns values.

func LoadDefaultConfigFile

func LoadDefaultConfigFile(stderr io.Writer) *configfile.ConfigFile

LoadDefaultConfigFile attempts to load the default config file and returns an initialized ConfigFile struct if none is found.

func LoadFromReader

func LoadFromReader(configData io.Reader) (*configfile.ConfigFile, error)

LoadFromReader is a convenience function that creates a ConfigFile object from a reader

func Path

func Path(p ...string) (string, error)

Path returns the path to a file relative to the config dir

func SetDir

func SetDir(dir string)

SetDir sets the directory the configuration file is stored in