config

package
v0.9.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2014 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package config implements reading and writing of the syncthing configuration file.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Configuration

type Configuration struct {
	Location     string                    `xml:"-" json:"-"`
	Version      int                       `xml:"version,attr" default:"3"`
	Repositories []RepositoryConfiguration `xml:"repository"`
	Nodes        []NodeConfiguration       `xml:"node"`
	GUI          GUIConfiguration          `xml:"gui"`
	Options      OptionsConfiguration      `xml:"options"`
	XMLName      xml.Name                  `xml:"configuration" json:"-"`
}

func Load

func Load(location string, myID protocol.NodeID) (Configuration, error)

func New added in v0.9.14

func New(location string, myID protocol.NodeID) Configuration

func (*Configuration) GetNodeConfiguration added in v0.9.5

func (cfg *Configuration) GetNodeConfiguration(nodeid protocol.NodeID) *NodeConfiguration

func (*Configuration) NodeMap added in v0.8.14

func (cfg *Configuration) NodeMap() map[protocol.NodeID]NodeConfiguration

func (*Configuration) RepoMap added in v0.8.14

func (cfg *Configuration) RepoMap() map[string]RepositoryConfiguration

func (*Configuration) Save added in v0.9.14

func (cfg *Configuration) Save() error

type GUIConfiguration

type GUIConfiguration struct {
	Enabled  bool   `xml:"enabled,attr" default:"true"`
	Address  string `xml:"address" default:"127.0.0.1:8080"`
	User     string `xml:"user,omitempty"`
	Password string `xml:"password,omitempty"`
	UseTLS   bool   `xml:"tls,attr"`
	APIKey   string `xml:"apikey,omitempty"`
}

type InternalParam added in v0.8.10

type InternalParam struct {
	Key string `xml:"key,attr"`
	Val string `xml:"val,attr"`
}

type InternalVersioningConfiguration added in v0.8.10

type InternalVersioningConfiguration struct {
	Type   string          `xml:"type,attr,omitempty"`
	Params []InternalParam `xml:"param"`
}

type NodeConfiguration

type NodeConfiguration struct {
	NodeID      protocol.NodeID `xml:"id,attr"`
	Name        string          `xml:"name,attr,omitempty"`
	Addresses   []string        `xml:"address,omitempty"`
	Compression bool            `xml:"compression,attr"`
	CertName    string          `xml:"certName,attr,omitempty"`
}

type NodeConfigurationList

type NodeConfigurationList []NodeConfiguration

func (NodeConfigurationList) Len

func (l NodeConfigurationList) Len() int

func (NodeConfigurationList) Less

func (l NodeConfigurationList) Less(a, b int) bool

func (NodeConfigurationList) Swap

func (l NodeConfigurationList) Swap(a, b int)

type OptionsConfiguration

type OptionsConfiguration struct {
	ListenAddress      []string `xml:"listenAddress" default:"0.0.0.0:22000"`
	GlobalAnnServer    string   `xml:"globalAnnounceServer" default:"announce.syncthing.net:22026"`
	GlobalAnnEnabled   bool     `xml:"globalAnnounceEnabled" default:"true"`
	LocalAnnEnabled    bool     `xml:"localAnnounceEnabled" default:"true"`
	LocalAnnPort       int      `xml:"localAnnouncePort" default:"21025"`
	LocalAnnMCAddr     string   `xml:"localAnnounceMCAddr" default:"[ff32::5222]:21026"`
	ParallelRequests   int      `xml:"parallelRequests" default:"16"`
	MaxSendKbps        int      `xml:"maxSendKbps"`
	MaxRecvKbps        int      `xml:"maxRecvKbps"`
	ReconnectIntervalS int      `xml:"reconnectionIntervalS" default:"60"`
	StartBrowser       bool     `xml:"startBrowser" default:"true"`
	UPnPEnabled        bool     `xml:"upnpEnabled" default:"true"`
	UPnPLease          int      `xml:"upnpLeaseMinutes" default:"0"`
	UPnPRenewal        int      `xml:"upnpRenewalMinutes" default:"30"`
	URAccepted         int      `xml:"urAccepted"` // Accepted usage reporting version; 0 for off (undecided), -1 for off (permanently)
	RestartOnWakeup    bool     `xml:"restartOnWakeup" default:"true"`

	Deprecated_RescanIntervalS int    `xml:"rescanIntervalS,omitempty" json:"-"`
	Deprecated_UREnabled       bool   `xml:"urEnabled,omitempty" json:"-"`
	Deprecated_URDeclined      bool   `xml:"urDeclined,omitempty" json:"-"`
	Deprecated_ReadOnly        bool   `xml:"readOnly,omitempty" json:"-"`
	Deprecated_GUIEnabled      bool   `xml:"guiEnabled,omitempty" json:"-"`
	Deprecated_GUIAddress      string `xml:"guiAddress,omitempty" json:"-"`
}

type RepositoryConfiguration

type RepositoryConfiguration struct {
	ID              string                        `xml:"id,attr"`
	Directory       string                        `xml:"directory,attr"`
	Nodes           []RepositoryNodeConfiguration `xml:"node"`
	ReadOnly        bool                          `xml:"ro,attr"`
	RescanIntervalS int                           `xml:"rescanIntervalS,attr" default:"60"`
	IgnorePerms     bool                          `xml:"ignorePerms,attr"`
	Invalid         string                        `xml:"-"` // Set at runtime when there is an error, not saved
	Versioning      VersioningConfiguration       `xml:"versioning"`
	// contains filtered or unexported fields
}

func (*RepositoryConfiguration) NodeIDs

func (r *RepositoryConfiguration) NodeIDs() []protocol.NodeID

type RepositoryNodeConfiguration added in v0.9.6

type RepositoryNodeConfiguration struct {
	NodeID protocol.NodeID `xml:"id,attr"`

	Deprecated_Name      string   `xml:"name,attr,omitempty" json:"-"`
	Deprecated_Addresses []string `xml:"address,omitempty" json:"-"`
}

type RepositoryNodeConfigurationList added in v0.9.6

type RepositoryNodeConfigurationList []RepositoryNodeConfiguration

func (RepositoryNodeConfigurationList) Len added in v0.9.6

func (RepositoryNodeConfigurationList) Less added in v0.9.6

func (RepositoryNodeConfigurationList) Swap added in v0.9.6

func (l RepositoryNodeConfigurationList) Swap(a, b int)

type VersioningConfiguration added in v0.8.10

type VersioningConfiguration struct {
	Type   string `xml:"type,attr"`
	Params map[string]string
}

func (*VersioningConfiguration) MarshalXML added in v0.8.10

func (c *VersioningConfiguration) MarshalXML(e *xml.Encoder, start xml.StartElement) error

func (*VersioningConfiguration) UnmarshalXML added in v0.8.10

func (c *VersioningConfiguration) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL