import "github.com/spf13/viper"
var RemoteConfig remoteConfigFactoryRemoteConfig is optional, see the remote package
SupportedExts are universally supported extensions.
SupportedRemoteProviders are universally supported remote providers.
AddConfigPath adds a path for Viper to search for the config file in. Can be called multiple times to define multiple search paths.
AddRemoteProvider adds a remote configuration source. Remote Providers are searched in the order they are added. provider is a string value, "etcd" or "consul" are currently supported. endpoint is the url. etcd requires http://ip:port consul requires ip:port path is the path in the k/v store to retrieve configuration To retrieve a config file called myapp.json from /configs/myapp.json you should set path to /configs and set config name (SetConfigName()) to "myapp"
AddSecureRemoteProvider adds a remote configuration source. Secure Remote Providers are searched in the order they are added. provider is a string value, "etcd" or "consul" are currently supported. endpoint is the url. etcd requires http://ip:port consul requires ip:port secretkeyring is the filepath to your openpgp secret keyring. e.g. /etc/secrets/myring.gpg path is the path in the k/v store to retrieve configuration To retrieve a config file called myapp.json from /configs/myapp.json you should set path to /configs and set config name (SetConfigName()) to "myapp" Secure Remote Providers are implemented with github.com/xordataexchange/crypt
AllKeys returns all keys holding a value, regardless of where they are set. Nested keys are returned with a v.keyDelim (= ".") separator
AllSettings merges all settings and returns them as a map[string]interface{}.
func AutomaticEnv()
AutomaticEnv has Viper check ENV variables for all. keys set in config, default & flags
BindEnv binds a Viper key to a ENV variable. ENV variables are case sensitive. If only a key is provided, it will use the env key matching the key, uppercased. EnvPrefix will be used when set when env name is not provided.
BindFlagValue binds a specific key to a FlagValue. Example (where serverCmd is a Cobra instance):
serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
Viper.BindFlagValue("port", serverCmd.Flags().Lookup("port"))
func BindFlagValues(flags FlagValueSet) error
BindFlagValues binds a full FlagValue set to the configuration, using each flag's long name as the config key.
BindPFlag binds a specific key to a pflag (as used by cobra). Example (where serverCmd is a Cobra instance):
serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
Viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))
BindPFlags binds a full flag set to the configuration, using each flag's long name as the config key.
ConfigFileUsed returns the file used to populate the config registry.
func Debug()
Debug prints all configuration registries for debugging purposes.
Get can retrieve any value given the key to use. Get is case-insensitive for a key. Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: override, flag, env, config file, key/value store, default
Get returns an interface. For a specific value use one of the Get____ methods.
GetBool returns the value associated with the key as a boolean.
GetDuration returns the value associated with the key as a duration.
GetFloat64 returns the value associated with the key as a float64.
GetInt returns the value associated with the key as an integer.
GetInt32 returns the value associated with the key as an integer.
GetInt64 returns the value associated with the key as an integer.
GetSizeInBytes returns the size of the value associated with the given key in bytes.
GetString returns the value associated with the key as a string.
GetStringMap returns the value associated with the key as a map of interfaces.
GetStringMapString returns the value associated with the key as a map of strings.
GetStringMapStringSlice returns the value associated with the key as a map to a slice of strings.
GetStringSlice returns the value associated with the key as a slice of strings.
GetTime returns the value associated with the key as time.
InConfig checks to see if the given key (or an alias) is in the config file.
IsSet checks to see if the key has been set in any of the data locations. IsSet is case-insensitive for a key.
MergeConfig merges a new configuration with an existing config.
MergeInConfig merges a new configuration with an existing config.
ReadConfig will read a configuration file, setting existing keys to nil if the key does not exist in the file.
ReadInConfig will discover and load the configuration file from disk and key/value stores, searching in one of the defined paths.
ReadRemoteConfig attempts to get configuration from a remote source and read it in the remote configuration registry.
Aliases provide another accessor for the same key. This enables one to change a name without breaking the application
func Reset()
Intended for testing, will reset all to default settings. In the public interface for the viper package so applications can use it in their testing as well.
SafeWriteConfig writes current configuration to file only if the file does not exist.
SafeWriteConfigAs writes current configuration to a given filename if it does not exist.
Set sets the value for the key in the override register. Set is case-insensitive for a key. Will be used instead of values obtained via flags, config file, ENV, default, or key/value store.
SetConfigFile explicitly defines the path, name and extension of the config file. Viper will use this and not check any of the config paths.
SetConfigName sets name for the config file. Does not include extension.
SetConfigType sets the type of the configuration returned by the remote source, e.g. "json".
SetDefault sets the default value for this key. SetDefault is case-insensitive for a key. Default only used when no value is provided by the user via flag, config or ENV.
SetEnvKeyReplacer sets the strings.Replacer on the viper object Useful for mapping an environmental variable to a key that does not match it.
SetEnvPrefix defines a prefix that ENVIRONMENT variables will use. E.g. if your prefix is "spf", the env registry will look for env variables that start with "SPF_".
SetFs sets the filesystem to use to read configuration.
SetTypeByDefaultValue enables or disables the inference of a key value's type when the Get function is used based upon a key's default value as opposed to the value returned based on the normal fetch logic.
For example, if a key has a default value of []string{} and the same key is set via an environment variable to "a b c", a call to the Get function would return a string slice for the key if the key's type is inferred by the default value and the Get function would return:
[]string {"a", "b", "c"}
Otherwise the Get function would return:
"a b c"
func Unmarshal(rawVal interface{}, opts ...DecoderConfigOption) errorUnmarshal unmarshals the config into a Struct. Make sure that the tags on the fields of the structure are properly set.
func UnmarshalKey(key string, rawVal interface{}, opts ...DecoderConfigOption) error
UnmarshalKey takes a single key and unmarshals it into a Struct.
func WatchConfig()
WriteConfig writes the current configuration to a file.
WriteConfigAs writes current configuration to a given filename.
type ConfigFileNotFoundError struct {
// contains filtered or unexported fields
}ConfigFileNotFoundError denotes failing to find configuration file.
func (fnfe ConfigFileNotFoundError) Error() string
Error returns the formatted configuration error.
type ConfigMarshalError struct {
// contains filtered or unexported fields
}ConfigMarshalError happens when failing to marshal the configuration.
func (e ConfigMarshalError) Error() string
Error returns the formatted configuration error.
type ConfigParseError struct {
// contains filtered or unexported fields
}ConfigParseError denotes failing to parse configuration file.
func (pe ConfigParseError) Error() string
Error returns the formatted configuration error.
type DecoderConfigOption func(*mapstructure.DecoderConfig)
A DecoderConfigOption can be passed to viper.Unmarshal to configure mapstructure.DecoderConfig options
func DecodeHook(hook mapstructure.DecodeHookFunc) DecoderConfigOption
DecodeHook returns a DecoderConfigOption which overrides the default DecoderConfig.DecodeHook value, the default is:
mapstructure.ComposeDecodeHookFunc(
mapstructure.StringToTimeDurationHookFunc(),
mapstructure.StringToSliceHookFunc(","),
)
type FlagValue interface {
HasChanged() bool
Name() string
ValueString() string
ValueType() string
}FlagValue is an interface that users can implement to bind different flags to viper.
FlagValueSet is an interface that users can implement to bind a set of flags to viper.
RemoteConfigError denotes encountering an error while trying to pull the configuration from the remote provider.
func (rce RemoteConfigError) Error() string
Error returns the formatted remote provider error
type RemoteProvider interface {
Provider() string
Endpoint() string
Path() string
SecretKeyring() string
}RemoteProvider stores the configuration necessary to connect to a remote key/value store. Optional secretKeyring to unencrypt encrypted values can be provided.
UnsupportedConfigError denotes encountering an unsupported configuration filetype.
func (str UnsupportedConfigError) Error() string
Error returns the formatted configuration error.
UnsupportedRemoteProviderError denotes encountering an unsupported remote provider. Currently only etcd and Consul are supported.
func (str UnsupportedRemoteProviderError) Error() string
Error returns the formatted remote provider error.
type Viper struct {
// contains filtered or unexported fields
}Viper is a prioritized configuration registry. It maintains a set of configuration sources, fetches values to populate those, and provides them according to the source's priority. The priority of the sources is the following: 1. overrides 2. flags 3. env. variables 4. config file 5. key/value store 6. defaults
For example, if values from the following sources were loaded:
Defaults : {
"secret": "",
"user": "default",
"endpoint": "https://localhost"
}
Config : {
"user": "root"
"secret": "defaultsecret"
}
Env : {
"secret": "somesecretkey"
}
The resulting config will have the following values:
{
"secret": "somesecretkey",
"user": "root",
"endpoint": "https://localhost"
}
GetViper gets the global Viper instance.
New returns an initialized Viper instance.
Sub returns new Viper instance representing a sub tree of this instance. Sub is case-insensitive for a key.
func (v *Viper) BindFlagValues(flags FlagValueSet) (err error)
func (v *Viper) Unmarshal(rawVal interface{}, opts ...DecoderConfigOption) error
UnmarshalExact unmarshals the config into a Struct, erroring if a field is nonexistent in the destination struct.
func (v *Viper) UnmarshalKey(key string, rawVal interface{}, opts ...DecoderConfigOption) error
| Path | Synopsis |
|---|---|
| remote | Package remote integrates the remote features of Viper. |
Package viper imports 25 packages (graph) and is imported by 5090 packages. Updated 2018-10-10. Refresh now. Tools for package owners.