Documentation
¶
Overview ¶
The config package contains structures related to the configuration of an Yggdrasil node.
The configuration contains, amongst other things, encryption keys which are used to derive a node's identity, information about peerings and node information that is shared with the network. There are also some module-specific options related to TUN, multicast and the admin socket.
In order for a node to maintain the same identity across restarts, you should persist the configuration onto the filesystem or into some configuration storage so that the encryption keys (and therefore the node ID) do not change.
Note that Yggdrasil will automatically populate sane defaults for any configuration option that is not provided.
Index ¶
- func GetDefaults() platformDefaultParameters
- type KeyBytes
- type MulticastInterfaceConfig
- type NodeConfig
- func (cfg *NodeConfig) GenerateSelfSignedCertificate() error
- func (cfg *NodeConfig) MarshalPEMCertificate() ([]byte, error)
- func (cfg *NodeConfig) MarshalPEMPrivateKey() ([]byte, error)
- func (cfg *NodeConfig) NewPrivateKey()
- func (cfg *NodeConfig) ReadFrom(r io.Reader) (int64, error)
- func (cfg *NodeConfig) UnmarshalHJSON(b []byte) error
- func (cfg *NodeConfig) UnmarshalPEMPrivateKey(b []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetDefaults ¶ added in v0.5.0
func GetDefaults() platformDefaultParameters
Types ¶
type KeyBytes ¶ added in v0.5.0
type KeyBytes []byte
func (KeyBytes) MarshalJSON ¶ added in v0.5.0
func (*KeyBytes) UnmarshalJSON ¶ added in v0.5.0
type MulticastInterfaceConfig ¶ added in v0.4.0
type NodeConfig ¶
type NodeConfig struct {
PrivateKey KeyBytes `json:",omitempty" comment:"Your private key. DO NOT share this with anyone!"`
PrivateKeyPath string `json:",omitempty" comment:"The path to your private key file in PEM format."`
Certificate *tls.Certificate `json:"-"`
Peers []string `` /* 286-byte string literal not displayed */
InterfacePeers map[string][]string `` /* 267-byte string literal not displayed */
Listen []string `` /* 343-byte string literal not displayed */
AdminListen string `` /* 281-byte string literal not displayed */
MulticastInterfaces []MulticastInterfaceConfig `` /* 602-byte string literal not displayed */
AllowedPublicKeys []string `` /* 256-byte string literal not displayed */
IfName string `` /* 138-byte string literal not displayed */
IfMTU uint64 `` /* 170-byte string literal not displayed */
NodeInfoPrivacy bool `` /* 314-byte string literal not displayed */
NodeInfo map[string]interface{} `` /* 177-byte string literal not displayed */
LogLookups bool `json:",omitempty"`
}
NodeConfig is the main configuration structure, containing configuration options that are necessary for an Yggdrasil node to run. You will need to supply one of these structs to the Yggdrasil core when starting a node.
func GenerateConfig ¶
func GenerateConfig() *NodeConfig
Generates default configuration and returns a pointer to the resulting NodeConfig. This is used when outputting the -genconf parameter and also when using -autoconf.
func (*NodeConfig) GenerateSelfSignedCertificate ¶ added in v0.5.0
func (cfg *NodeConfig) GenerateSelfSignedCertificate() error
func (*NodeConfig) MarshalPEMCertificate ¶ added in v0.5.0
func (cfg *NodeConfig) MarshalPEMCertificate() ([]byte, error)
func (*NodeConfig) MarshalPEMPrivateKey ¶ added in v0.5.0
func (cfg *NodeConfig) MarshalPEMPrivateKey() ([]byte, error)
func (*NodeConfig) NewPrivateKey ¶ added in v0.5.0
func (cfg *NodeConfig) NewPrivateKey()
func (*NodeConfig) ReadFrom ¶ added in v0.5.0
func (cfg *NodeConfig) ReadFrom(r io.Reader) (int64, error)
func (*NodeConfig) UnmarshalHJSON ¶ added in v0.5.0
func (cfg *NodeConfig) UnmarshalHJSON(b []byte) error
func (*NodeConfig) UnmarshalPEMPrivateKey ¶ added in v0.5.0
func (cfg *NodeConfig) UnmarshalPEMPrivateKey(b []byte) error
Source Files