conffile

Documentation

Overview

Package conffile contains code to load, manipulate, and access config file settings.

Index

• Constants
• type Config
  • func Load(path string) (*Config, error)
  • func (c *Config) WantRunning() bool

Constants

const VMUserDataPath = "vm:user-data"

VMUserDataPath is a sentinel value for Load to use to get the data from the VM's metadata service's user-data field.

Types

type Config

type Config struct {
	Path    string // disk path of HuJSON, or VMUserDataPath
	Raw     []byte // raw bytes from disk, in HuJSON form
	Std     []byte // standardized JSON form
	Version string // "alpha0" for now

	// Parsed is the parsed config, converted from its on-disk version to the
	// latest known format.
	//
	// As of 2023-10-15 there is exactly one format ("alpha0") so this is both
	// the on-disk format and the in-memory upgraded format.
	Parsed ipn.ConfigVAlpha
}

Config describes a config file.

func Load

func Load(path string) (*Config, error)

Load reads and parses the config file at the provided path on disk.

func (*Config) WantRunning

func (c *Config) WantRunning() bool

WantRunning reports whether c is non-nil and it's configured to be running.