config

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Dec 26, 2018 License: MPL-2.0 Imports: 27 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	OldestHandledVersion = 10
	CurrentVersion       = 28
	MaxRescanIntervalS   = 365 * 24 * 60 * 60
)
View Source 
const DefaultMarkerName = ".stfolder"

Variables

View Source 
var (
	// DefaultTCPPort defines default TCP port used if the URI does not specify one, for example tcp://0.0.0.0
	DefaultTCPPort = 22000
	// DefaultListenAddresses should be substituted when the configuration
	// contains <listenAddress>default</listenAddress>. This is done by the
	// "consumer" of the configuration as we don't want these saved to the
	// config.
	DefaultListenAddresses = []string{
		util.Address("tcp", net.JoinHostPort("0.0.0.0", strconv.Itoa(DefaultTCPPort))),
		"dynamic+https://relays.syncthing.net/endpoint",
	}
	// DefaultDiscoveryServersV4 should be substituted when the configuration
	// contains <globalAnnounceServer>default-v4</globalAnnounceServer>.
	DefaultDiscoveryServersV4 = []string{
		"https://discovery.syncthing.net/v2/?noannounce&id=LYXKCHX-VI3NYZR-ALCJBHF-WMZYSPK-QG6QJA3-MPFYMSO-U56GTUK-NA2MIAW",
		"https://discovery-v4.syncthing.net/v2/?nolookup&id=LYXKCHX-VI3NYZR-ALCJBHF-WMZYSPK-QG6QJA3-MPFYMSO-U56GTUK-NA2MIAW",
	}
	// DefaultDiscoveryServersV6 should be substituted when the configuration
	// contains <globalAnnounceServer>default-v6</globalAnnounceServer>.
	DefaultDiscoveryServersV6 = []string{
		"https://discovery.syncthing.net/v2/?noannounce&id=LYXKCHX-VI3NYZR-ALCJBHF-WMZYSPK-QG6QJA3-MPFYMSO-U56GTUK-NA2MIAW",
		"https://discovery-v6.syncthing.net/v2/?nolookup&id=LYXKCHX-VI3NYZR-ALCJBHF-WMZYSPK-QG6QJA3-MPFYMSO-U56GTUK-NA2MIAW",
	}
	// DefaultDiscoveryServers should be substituted when the configuration
	// contains <globalAnnounceServer>default</globalAnnounceServer>.
	DefaultDiscoveryServers = append(DefaultDiscoveryServersV4, DefaultDiscoveryServersV6...)
	// DefaultTheme is the default and fallback theme for the web UI.
	DefaultTheme = "default"
)
View Source 
var (
	ErrPathNotDirectory = errors.New("folder path not a directory")
	ErrPathMissing      = errors.New("folder path missing")
	ErrMarkerMissing    = errors.New("folder marker missing")
)

Functions

This section is empty.

Types

type AuthMode 

type AuthMode int
const (
	AuthModeStatic AuthMode = iota // default is static
	AuthModeLDAP
)

func (AuthMode) MarshalText 

func (t AuthMode) MarshalText() ([]byte, error)

func (AuthMode) String 

func (t AuthMode) String() string

func (*AuthMode) UnmarshalText 

func (t *AuthMode) UnmarshalText(bs []byte) error

type Committer 

type Committer interface {
	VerifyConfiguration(from, to Configuration) error
	CommitConfiguration(from, to Configuration) (handled bool)
	String() string
}

The Committer interface is implemented by objects that need to know about or have a say in configuration changes.

When the configuration is about to be changed, VerifyConfiguration() is called for each subscribing object, with the old and new configuration. A nil error is returned if the new configuration is acceptable (i.e. does not contain any errors that would prevent it from being a valid config). Otherwise an error describing the problem is returned.

If any subscriber returns an error from VerifyConfiguration(), the configuration change is not committed and an error is returned to whoever tried to commit the broken config.

If all verification calls returns nil, CommitConfiguration() is called for each subscribing object. The callee returns true if the new configuration has been successfully applied, otherwise false. Any Commit() call returning false will result in a "restart needed" response to the API/user. Note that the new configuration will still have been applied by those who were capable of doing so.

type Configuration 

type Configuration struct {
	Version        int                   `xml:"version,attr" json:"version"`
	Folders        []FolderConfiguration `xml:"folder" json:"folders"`
	Devices        []DeviceConfiguration `xml:"device" json:"devices"`
	GUI            GUIConfiguration      `xml:"gui" json:"gui"`
	LDAP           LDAPConfiguration     `xml:"ldap" json:"ldap"`
	Options        OptionsConfiguration  `xml:"options" json:"options"`
	IgnoredDevices []ObservedDevice      `xml:"remoteIgnoredDevice" json:"remoteIgnoredDevices"`
	PendingDevices []ObservedDevice      `xml:"pendingDevice" json:"pendingDevices"`
	XMLName        xml.Name              `xml:"configuration" json:"-"`

	MyID            protocol.DeviceID `xml:"-" json:"-"` // Provided by the instantiator.
	OriginalVersion int               `xml:"-" json:"-"` // The version we read from disk, before any conversion
}

func New 

func New(myID protocol.DeviceID) Configuration

func ReadJSON 

func ReadJSON(r io.Reader, myID protocol.DeviceID) (Configuration, error)

func ReadXML 

func ReadXML(r io.Reader, myID protocol.DeviceID) (Configuration, error)

func (Configuration) Copy 

func (cfg Configuration) Copy() Configuration

func (*Configuration) DeviceMap 

func (cfg *Configuration) DeviceMap() map[protocol.DeviceID]DeviceConfiguration

DeviceMap returns a map of device ID to device configuration for the given configuration.

func (*Configuration) WriteXML 

func (cfg *Configuration) WriteXML(w io.Writer) error

type DeviceConfiguration 

type DeviceConfiguration struct {
	DeviceID                 protocol.DeviceID    `xml:"id,attr" json:"deviceID"`
	Name                     string               `xml:"name,attr,omitempty" json:"name"`
	Addresses                []string             `xml:"address,omitempty" json:"addresses"`
	Compression              protocol.Compression `xml:"compression,attr" json:"compression"`
	CertName                 string               `xml:"certName,attr,omitempty" json:"certName"`
	Introducer               bool                 `xml:"introducer,attr" json:"introducer"`
	SkipIntroductionRemovals bool                 `xml:"skipIntroductionRemovals,attr" json:"skipIntroductionRemovals"`
	IntroducedBy             protocol.DeviceID    `xml:"introducedBy,attr" json:"introducedBy"`
	Paused                   bool                 `xml:"paused" json:"paused"`
	AllowedNetworks          []string             `xml:"allowedNetwork,omitempty" json:"allowedNetworks"`
	AutoAcceptFolders        bool                 `xml:"autoAcceptFolders" json:"autoAcceptFolders"`
	MaxSendKbps              int                  `xml:"maxSendKbps" json:"maxSendKbps"`
	MaxRecvKbps              int                  `xml:"maxRecvKbps" json:"maxRecvKbps"`
	IgnoredFolders           []ObservedFolder     `xml:"ignoredFolder" json:"ignoredFolders"`
	PendingFolders           []ObservedFolder     `xml:"pendingFolder" json:"pendingFolders"`
	MaxRequestKiB            int                  `xml:"maxRequestKiB" json:"maxRequestKiB"`
}

func NewDeviceConfiguration 

func NewDeviceConfiguration(id protocol.DeviceID, name string) DeviceConfiguration

func (DeviceConfiguration) Copy 

func (cfg DeviceConfiguration) Copy() DeviceConfiguration

func (*DeviceConfiguration) IgnoredFolder 

func (cfg *DeviceConfiguration) IgnoredFolder(folder string) bool

type FolderConfiguration 

type FolderConfiguration struct {
	ID                    string                      `xml:"id,attr" json:"id"`
	Label                 string                      `xml:"label,attr" json:"label" restart:"false"`
	FilesystemType        fs.FilesystemType           `xml:"filesystemType" json:"filesystemType"`
	Path                  string                      `xml:"path,attr" json:"path"`
	Type                  FolderType                  `xml:"type,attr" json:"type"`
	Devices               []FolderDeviceConfiguration `xml:"device" json:"devices"`
	RescanIntervalS       int                         `xml:"rescanIntervalS,attr" json:"rescanIntervalS"`
	FSWatcherEnabled      bool                        `xml:"fsWatcherEnabled,attr" json:"fsWatcherEnabled"`
	FSWatcherDelayS       int                         `xml:"fsWatcherDelayS,attr" json:"fsWatcherDelayS"`
	IgnorePerms           bool                        `xml:"ignorePerms,attr" json:"ignorePerms"`
	AutoNormalize         bool                        `xml:"autoNormalize,attr" json:"autoNormalize"`
	MinDiskFree           Size                        `xml:"minDiskFree" json:"minDiskFree"`
	Versioning            VersioningConfiguration     `xml:"versioning" json:"versioning"`
	Copiers               int                         `xml:"copiers" json:"copiers"` // This defines how many files are handled concurrently.
	PullerMaxPendingKiB   int                         `xml:"pullerMaxPendingKiB" json:"pullerMaxPendingKiB"`
	Hashers               int                         `xml:"hashers" json:"hashers"` // Less than one sets the value to the number of cores. These are CPU bound due to hashing.
	Order                 PullOrder                   `xml:"order" json:"order"`
	IgnoreDelete          bool                        `xml:"ignoreDelete" json:"ignoreDelete"`
	ScanProgressIntervalS int                         `xml:"scanProgressIntervalS" json:"scanProgressIntervalS"` // Set to a negative value to disable. Value of 0 will get replaced with value of 2 (default value)
	PullerPauseS          int                         `xml:"pullerPauseS" json:"pullerPauseS"`
	MaxConflicts          int                         `xml:"maxConflicts" json:"maxConflicts"`
	DisableSparseFiles    bool                        `xml:"disableSparseFiles" json:"disableSparseFiles"`
	DisableTempIndexes    bool                        `xml:"disableTempIndexes" json:"disableTempIndexes"`
	Paused                bool                        `xml:"paused" json:"paused"`
	WeakHashThresholdPct  int                         `xml:"weakHashThresholdPct" json:"weakHashThresholdPct"` // Use weak hash if more than X percent of the file has changed. Set to -1 to always use weak hash.
	MarkerName            string                      `xml:"markerName" json:"markerName"`
	UseLargeBlocks        bool                        `xml:"useLargeBlocks" json:"useLargeBlocks"`

	DeprecatedReadOnly       bool    `xml:"ro,attr,omitempty" json:"-"`
	DeprecatedMinDiskFreePct float64 `xml:"minDiskFreePct,omitempty" json:"-"`
	DeprecatedPullers        int     `xml:"pullers,omitempty" json:"-"`
	// contains filtered or unexported fields
}

func NewFolderConfiguration 

func NewFolderConfiguration(myID protocol.DeviceID, id, label string, fsType fs.FilesystemType, path string) FolderConfiguration

func (*FolderConfiguration) CheckAvailableSpace 

func (f *FolderConfiguration) CheckAvailableSpace(req int64) error

func (*FolderConfiguration) CheckPath 

func (f *FolderConfiguration) CheckPath() error

CheckPath returns nil if the folder root exists and contains the marker file

func (FolderConfiguration) Copy 

func (f FolderConfiguration) Copy() FolderConfiguration

func (*FolderConfiguration) CreateMarker 

func (f *FolderConfiguration) CreateMarker() error

func (*FolderConfiguration) CreateRoot 

func (f *FolderConfiguration) CreateRoot() (err error)

func (FolderConfiguration) Description added in v0.14.12 

func (f FolderConfiguration) Description() string

func (*FolderConfiguration) DeviceIDs 

func (f *FolderConfiguration) DeviceIDs() []protocol.DeviceID

func (FolderConfiguration) Filesystem 

func (f FolderConfiguration) Filesystem() fs.Filesystem

func (FolderConfiguration) RequiresRestartOnly 

func (f FolderConfiguration) RequiresRestartOnly() FolderConfiguration

RequiresRestartOnly returns a copy with only the attributes that require restart on change.

func (*FolderConfiguration) SharedWith 

func (f *FolderConfiguration) SharedWith(device protocol.DeviceID) bool

func (FolderConfiguration) Versioner 

func (f FolderConfiguration) Versioner() versioner.Versioner

type FolderDeviceConfiguration 

type FolderDeviceConfiguration struct {
	DeviceID     protocol.DeviceID `xml:"id,attr" json:"deviceID"`
	IntroducedBy protocol.DeviceID `xml:"introducedBy,attr" json:"introducedBy"`
}

type FolderType added in v0.14.12 

type FolderType int
const (
	FolderTypeSendReceive FolderType = iota // default is sendreceive
	FolderTypeSendOnly
	FolderTypeReceiveOnly
)

func (FolderType) MarshalText added in v0.14.12 

func (t FolderType) MarshalText() ([]byte, error)

func (FolderType) String added in v0.14.12 

func (t FolderType) String() string

func (*FolderType) UnmarshalText added in v0.14.12 

func (t *FolderType) UnmarshalText(bs []byte) error

type GUIConfiguration 

type GUIConfiguration struct {
	Enabled                   bool     `xml:"enabled,attr" json:"enabled" default:"true"`
	RawAddress                string   `xml:"address" json:"address" default:"127.0.0.1:8384"`
	User                      string   `xml:"user,omitempty" json:"user"`
	Password                  string   `xml:"password,omitempty" json:"password"`
	AuthMode                  AuthMode `xml:"authMode,omitempty" json:"authMode"`
	RawUseTLS                 bool     `xml:"tls,attr" json:"useTLS"`
	APIKey                    string   `xml:"apikey,omitempty" json:"apiKey"`
	InsecureAdminAccess       bool     `xml:"insecureAdminAccess,omitempty" json:"insecureAdminAccess"`
	Theme                     string   `xml:"theme" json:"theme" default:"default"`
	Debugging                 bool     `xml:"debugging,attr" json:"debugging"`
	InsecureSkipHostCheck     bool     `xml:"insecureSkipHostcheck,omitempty" json:"insecureSkipHostcheck"`
	InsecureAllowFrameLoading bool     `xml:"insecureAllowFrameLoading,omitempty" json:"insecureAllowFrameLoading"`
}

func (GUIConfiguration) Address 

func (c GUIConfiguration) Address() string

func (GUIConfiguration) Copy 

func (c GUIConfiguration) Copy() GUIConfiguration

func (GUIConfiguration) IsAuthEnabled 

func (c GUIConfiguration) IsAuthEnabled() bool

func (GUIConfiguration) IsOverridden 

func (c GUIConfiguration) IsOverridden() bool

func (GUIConfiguration) IsValidAPIKey added in v0.12.19 

func (c GUIConfiguration) IsValidAPIKey(apiKey string) bool

IsValidAPIKey returns true when the given API key is valid, including both the value in config and any overrides

func (GUIConfiguration) Network 

func (c GUIConfiguration) Network() string

func (GUIConfiguration) URL 

func (c GUIConfiguration) URL() string

func (GUIConfiguration) UseTLS 

func (c GUIConfiguration) UseTLS() bool

type InternalParam 

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

type InternalVersioningConfiguration 

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

type LDAPConfiguration 

type LDAPConfiguration struct {
	Address            string        `xml:"address,omitempty" json:"addresd"`
	BindDN             string        `xml:"bindDN,omitempty" json:"bindDN"`
	Transport          LDAPTransport `xml:"transport,omitempty" json:"transport"`
	InsecureSkipVerify bool          `xml:"insecureSkipVerify,omitempty" json:"insecureSkipVerify" default:"false"`
}

func (LDAPConfiguration) Copy 

func (c LDAPConfiguration) Copy() LDAPConfiguration

type LDAPTransport 

type LDAPTransport int
const (
	LDAPTransportPlain LDAPTransport = iota // default is plain
	LDAPTransportTLS
	LDAPTransportStartTLS
)

func (LDAPTransport) MarshalText 

func (t LDAPTransport) MarshalText() ([]byte, error)

func (LDAPTransport) String 

func (t LDAPTransport) String() string

func (*LDAPTransport) UnmarshalText 

func (t *LDAPTransport) UnmarshalText(bs []byte) error

type ObservedDevice 

type ObservedDevice struct {
	Time    time.Time         `xml:"time,attr" json:"time"`
	ID      protocol.DeviceID `xml:"id,attr" json:"deviceID"`
	Name    string            `xml:"name,attr" json:"name"`
	Address string            `xml:"address,attr" json:"address"`
}

type ObservedFolder 

type ObservedFolder struct {
	Time  time.Time `xml:"time,attr" json:"time"`
	ID    string    `xml:"id,attr" json:"id"`
	Label string    `xml:"label,attr" json:"label"`
}

type OptionsConfiguration 

type OptionsConfiguration struct {
	ListenAddresses         []string `xml:"listenAddress" json:"listenAddresses" default:"default"`
	GlobalAnnServers        []string `xml:"globalAnnounceServer" json:"globalAnnounceServers" json:"globalAnnounceServer" default:"default" restart:"true"`
	GlobalAnnEnabled        bool     `xml:"globalAnnounceEnabled" json:"globalAnnounceEnabled" default:"true" restart:"true"`
	LocalAnnEnabled         bool     `xml:"localAnnounceEnabled" json:"localAnnounceEnabled" default:"true" restart:"true"`
	LocalAnnPort            int      `xml:"localAnnouncePort" json:"localAnnouncePort" default:"21027" restart:"true"`
	LocalAnnMCAddr          string   `xml:"localAnnounceMCAddr" json:"localAnnounceMCAddr" default:"[ff12::8384]:21027" restart:"true"`
	MaxSendKbps             int      `xml:"maxSendKbps" json:"maxSendKbps"`
	MaxRecvKbps             int      `xml:"maxRecvKbps" json:"maxRecvKbps"`
	ReconnectIntervalS      int      `xml:"reconnectionIntervalS" json:"reconnectionIntervalS" default:"60"`
	RelaysEnabled           bool     `xml:"relaysEnabled" json:"relaysEnabled" default:"true"`
	RelayReconnectIntervalM int      `xml:"relayReconnectIntervalM" json:"relayReconnectIntervalM" default:"10"`
	StartBrowser            bool     `xml:"startBrowser" json:"startBrowser" default:"true"`
	NATEnabled              bool     `xml:"natEnabled" json:"natEnabled" default:"true"`
	NATLeaseM               int      `xml:"natLeaseMinutes" json:"natLeaseMinutes" default:"60"`
	NATRenewalM             int      `xml:"natRenewalMinutes" json:"natRenewalMinutes" default:"30"`
	NATTimeoutS             int      `xml:"natTimeoutSeconds" json:"natTimeoutSeconds" default:"10"`
	URAccepted              int      `xml:"urAccepted" json:"urAccepted"` // Accepted usage reporting version; 0 for off (undecided), -1 for off (permanently)
	URSeen                  int      `xml:"urSeen" json:"urSeen"`         // Report which the user has been prompted for.
	URUniqueID              string   `xml:"urUniqueID" json:"urUniqueId"` // Unique ID for reporting purposes, regenerated when UR is turned on.
	URURL                   string   `xml:"urURL" json:"urURL" default:"https://data.syncthing.net/newdata"`
	URPostInsecurely        bool     `xml:"urPostInsecurely" json:"urPostInsecurely" default:"false"` // For testing
	URInitialDelayS         int      `xml:"urInitialDelayS" json:"urInitialDelayS" default:"1800"`
	RestartOnWakeup         bool     `xml:"restartOnWakeup" json:"restartOnWakeup" default:"true" restart:"true"`
	AutoUpgradeIntervalH    int      `xml:"autoUpgradeIntervalH" json:"autoUpgradeIntervalH" default:"12" restart:"true"` // 0 for off
	UpgradeToPreReleases    bool     `xml:"upgradeToPreReleases" json:"upgradeToPreReleases" restart:"true"`              // when auto upgrades are enabled
	KeepTemporariesH        int      `xml:"keepTemporariesH" json:"keepTemporariesH" default:"24"`                        // 0 for off
	CacheIgnoredFiles       bool     `xml:"cacheIgnoredFiles" json:"cacheIgnoredFiles" default:"false" restart:"true"`
	ProgressUpdateIntervalS int      `xml:"progressUpdateIntervalS" json:"progressUpdateIntervalS" default:"5"`
	LimitBandwidthInLan     bool     `xml:"limitBandwidthInLan" json:"limitBandwidthInLan" default:"false"`
	MinHomeDiskFree         Size     `xml:"minHomeDiskFree" json:"minHomeDiskFree" default:"1 %"`
	ReleasesURL             string   `xml:"releasesURL" json:"releasesURL" default:"https://upgrades.syncthing.net/meta.json" restart:"true"`
	AlwaysLocalNets         []string `xml:"alwaysLocalNet" json:"alwaysLocalNets"`
	OverwriteRemoteDevNames bool     `xml:"overwriteRemoteDeviceNamesOnConnect" json:"overwriteRemoteDeviceNamesOnConnect" default:"false"`
	TempIndexMinBlocks      int      `xml:"tempIndexMinBlocks" json:"tempIndexMinBlocks" default:"10"`
	UnackedNotificationIDs  []string `xml:"unackedNotificationID" json:"unackedNotificationIDs"`
	TrafficClass            int      `xml:"trafficClass" json:"trafficClass"`
	DefaultFolderPath       string   `xml:"defaultFolderPath" json:"defaultFolderPath" default:"~"`
	SetLowPriority          bool     `xml:"setLowPriority" json:"setLowPriority" default:"true"`
	MaxConcurrentScans      int      `xml:"maxConcurrentScans" json:"maxConcurrentScans"`

	DeprecatedUPnPEnabled        bool     `xml:"upnpEnabled,omitempty" json:"-"`
	DeprecatedUPnPLeaseM         int      `xml:"upnpLeaseMinutes,omitempty" json:"-"`
	DeprecatedUPnPRenewalM       int      `xml:"upnpRenewalMinutes,omitempty" json:"-"`
	DeprecatedUPnPTimeoutS       int      `xml:"upnpTimeoutSeconds,omitempty" json:"-"`
	DeprecatedRelayServers       []string `xml:"relayServer,omitempty" json:"-"`
	DeprecatedMinHomeDiskFreePct float64  `xml:"minHomeDiskFreePct" json:"-"`
}

func (OptionsConfiguration) Copy 

func (orig OptionsConfiguration) Copy() OptionsConfiguration

func (OptionsConfiguration) RequiresRestartOnly 

func (orig OptionsConfiguration) RequiresRestartOnly() OptionsConfiguration

RequiresRestartOnly returns a copy with only the attributes that require restart on change.

type PullOrder 

type PullOrder int
const (
	OrderRandom PullOrder = iota // default is random
	OrderAlphabetic
	OrderSmallestFirst
	OrderLargestFirst
	OrderOldestFirst
	OrderNewestFirst
)

func (PullOrder) MarshalText 

func (o PullOrder) MarshalText() ([]byte, error)

func (PullOrder) String 

func (o PullOrder) String() string

func (*PullOrder) UnmarshalText 

func (o *PullOrder) UnmarshalText(bs []byte) error

type Size 

type Size struct {
	Value float64 `json:"value" xml:",chardata"`
	Unit  string  `json:"unit" xml:"unit,attr"`
}

func ParseSize 

func ParseSize(s string) (Size, error)

func (Size) BaseValue 

func (s Size) BaseValue() float64

func (Size) ParseDefault 

func (Size) ParseDefault(s string) (interface{}, error)

func (Size) Percentage 

func (s Size) Percentage() bool

func (Size) String 

func (s Size) String() string

type VersioningConfiguration 

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

func (VersioningConfiguration) Copy 

func (c VersioningConfiguration) Copy() VersioningConfiguration

func (*VersioningConfiguration) MarshalXML 

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

func (*VersioningConfiguration) UnmarshalXML 

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

type Waiter 

type Waiter interface {
	Wait()
}

Waiter allows to wait for the given config operation to complete.

type Wrapper 

type Wrapper struct {
	// contains filtered or unexported fields
}

func Load 

func Load(path string, myID protocol.DeviceID) (*Wrapper, error)

Load loads an existing file on disk and returns a new configuration wrapper.

func Wrap 

func Wrap(path string, cfg Configuration) *Wrapper

Wrap wraps an existing Configuration structure and ties it to a file on disk.

func (*Wrapper) AddOrUpdatePendingDevice 

func (w *Wrapper) AddOrUpdatePendingDevice(device protocol.DeviceID, name, address string)

func (*Wrapper) AddOrUpdatePendingFolder 

func (w *Wrapper) AddOrUpdatePendingFolder(id, label string, device protocol.DeviceID)

func (*Wrapper) CheckHomeFreeSpace 

func (w *Wrapper) CheckHomeFreeSpace() error

CheckHomeFreeSpace returns nil if the home disk has the required amount of free space, or if home disk free space checking is disabled.

func (*Wrapper) ConfigPath 

func (w *Wrapper) ConfigPath() string

func (*Wrapper) Device added in v0.14.12 

func (w *Wrapper) Device(id protocol.DeviceID) (DeviceConfiguration, bool)

Device returns the configuration for the given device and an "ok" bool.

func (*Wrapper) Devices 

func (w *Wrapper) Devices() map[protocol.DeviceID]DeviceConfiguration

Devices returns a map of devices.

func (*Wrapper) Folder added in v0.14.24 

func (w *Wrapper) Folder(id string) (FolderConfiguration, bool)

Folder returns the configuration for the given folder and an "ok" bool.

func (*Wrapper) FolderList 

func (w *Wrapper) FolderList() []FolderConfiguration

FolderList returns a slice of folders.

func (*Wrapper) Folders 

func (w *Wrapper) Folders() map[string]FolderConfiguration

Folders returns a map of folders. Folder structures should not be changed, other than for the purpose of updating via SetFolder().

func (*Wrapper) GUI 

func (w *Wrapper) GUI() GUIConfiguration

GUI returns the current GUI configuration object.

func (*Wrapper) GlobalDiscoveryServers 

func (w *Wrapper) GlobalDiscoveryServers() []string

func (*Wrapper) IgnoredDevice 

func (w *Wrapper) IgnoredDevice(id protocol.DeviceID) bool

IgnoredDevice returns whether or not connection attempts from the given device should be silently ignored.

func (*Wrapper) IgnoredFolder 

func (w *Wrapper) IgnoredFolder(device protocol.DeviceID, folder string) bool

IgnoredFolder returns whether or not share attempts for the given folder should be silently ignored.

func (*Wrapper) LDAP 

func (w *Wrapper) LDAP() LDAPConfiguration

func (*Wrapper) ListenAddresses added in v0.14.12 

func (w *Wrapper) ListenAddresses() []string

func (*Wrapper) MyName 

func (w *Wrapper) MyName() string

func (*Wrapper) Options 

func (w *Wrapper) Options() OptionsConfiguration

Options returns the current options configuration object.

func (*Wrapper) RawCopy added in v0.14.12 

func (w *Wrapper) RawCopy() Configuration

RawCopy returns a copy of the currently wrapped Configuration object.

func (*Wrapper) RemoveDevice added in v0.14.12 

func (w *Wrapper) RemoveDevice(id protocol.DeviceID) (Waiter, error)

RemoveDevice removes the device from the configuration

func (*Wrapper) Replace 

func (w *Wrapper) Replace(cfg Configuration) (Waiter, error)

Replace swaps the current configuration object for the given one.

func (*Wrapper) RequiresRestart added in v0.14.12 

func (w *Wrapper) RequiresRestart() bool

func (*Wrapper) Save 

func (w *Wrapper) Save() error

Save writes the configuration to disk, and generates a ConfigSaved event.

func (*Wrapper) SetDevice 

func (w *Wrapper) SetDevice(dev DeviceConfiguration) (Waiter, error)

SetDevice adds a new device to the configuration, or overwrites an existing device with the same ID.

func (*Wrapper) SetDevices 

func (w *Wrapper) SetDevices(devs []DeviceConfiguration) (Waiter, error)

SetDevices adds new devices to the configuration, or overwrites existing devices with the same ID.

func (*Wrapper) SetFolder 

func (w *Wrapper) SetFolder(fld FolderConfiguration) (Waiter, error)

SetFolder adds a new folder to the configuration, or overwrites an existing folder with the same ID.

func (*Wrapper) SetGUI 

func (w *Wrapper) SetGUI(gui GUIConfiguration) (Waiter, error)

SetGUI replaces the current GUI configuration object.

func (*Wrapper) SetOptions 

func (w *Wrapper) SetOptions(opts OptionsConfiguration) (Waiter, error)

SetOptions replaces the current options configuration object.

func (*Wrapper) Stop 

func (w *Wrapper) Stop()

Stop stops the Serve() loop. Set and Replace operations will panic after a Stop.

func (*Wrapper) Subscribe 

func (w *Wrapper) Subscribe(c Committer)

Subscribe registers the given handler to be called on any future configuration changes.

func (*Wrapper) Unsubscribe 

func (w *Wrapper) Unsubscribe(c Committer)

Unsubscribe de-registers the given handler from any future calls to configuration changes

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.