config

Documentation

Overview

Package config exposes static configuration data, and loaded user preferences.

Index

• Variables
• func CreateTorusRoot() (string, error)
• type Config
  • func LoadConfig() (*Config, error)
  • func NewConfig(torusRoot string) (*Config, error)

Variables

var Version = "alpha"

Version is the compiled version of our binary. It is set via the Makefile.

Functions

func CreateTorusRoot

func CreateTorusRoot() (string, error)

CreateTorusRoot creates the root directory for the Torus daemon.

Types

type Config

type Config struct {
	APIVersion string
	Version    string

	TorusRoot  string
	SocketPath string
	PidPath    string
	DBPath     string

	RegistryURI *url.URL
	CABundle    *x509.CertPool
	PublicKey   *prefs.PublicKey
}

Config represents the static and user defined configuration data for Torus.

func LoadConfig

func LoadConfig() (*Config, error)

LoadConfig loads the config, standardizing cli errors on failure.

func NewConfig

func NewConfig(torusRoot string) (*Config, error)

NewConfig returns a new Config, with loaded user preferences.