global

Documentation

Overview

Package global provides the infrastructure need to load global configuration files.

Index

• func ConfigurationPath() (string, error)
• type Configuration
  • func LoadConfiguration(path string) (*Configuration, error)

Functions

func ConfigurationPath

func ConfigurationPath() (string, error)

ConfigurationPath returns the path of the YAML-based global configuration file. It does not verify that the file exists.

Types

type Configuration

type Configuration struct {
	// Forwarding is the global forwarding configuration.
	Forwarding struct {
		// Defaults are the global forwarding configuration defaults.
		Defaults forwarding.Configuration `yaml:"defaults"`
	} `yaml:"forward"`
	// Synchronization is the global synchronization configuration.
	Synchronization struct {
		// Defaults are the global synchronization configuration defaults.
		Defaults synchronization.Configuration `yaml:"defaults"`
	} `yaml:"sync"`
}

Configuration is the global YAML configuration object type.

func LoadConfiguration

func LoadConfiguration(path string) (*Configuration, error)

LoadConfiguration attempts to load a YAML-based Mutagen global configuration file from the specified path.