Whether to enable Syncthing continuous file synchronization.
+Whether to enable Syncthing, a self-hosted open-source alternative to Dropbox and Bittorrent Sync. +Further declarative configuration options only supported on Linux devices. +.
Type: boolean
@@ -73961,6 +73963,85 @@ booleanExample:
true
Declared by:
+
+
+<home-manager/modules/services/syncthing.nix>
+
+ |
services.syncthing.package
+
+
+The syncthing package to use.
+ +Type: +package
+ +Default:
+pkgs.syncthing
Declared by:
+
+
+<home-manager/modules/services/syncthing.nix>
+
+ |
services.syncthing.allProxy
+
+
+Overwrites the all_proxy environment variable for the Syncthing
+process to the given value. This is normally used to let Syncthing
+connect through a SOCKS5 proxy server. See
+https://docs.syncthing.net/users/proxying.html.
Type: +null or string
+ +Default:
+null
Example:
+"socks5://address.com:1234"
Declared by:
+
+
+<home-manager/modules/services/syncthing.nix>
+
+ |
services.syncthing.cert
+
+
+Path to the cert.pem file, which will be copied into Syncthing’s
+config directory.
Type: +null or string
+ +Default:
+null
Declared by:
|
@@ -73977,7 +74058,7 @@ boolean
Extra command-line arguments to pass to syncthing. +Extra command-line arguments to pass to syncthing Type: list of string @@ -73986,10 +74067,765 @@ list of string[ ]
Example: Declared by: +
services.syncthing.guiAddress
+
+
+The address to serve the web interface at. + +Type: +string + +Default:
+ Declared by: +
services.syncthing.key
+
+
+Path to the Type: +null or string + +Default:
+ Declared by: +
services.syncthing.overrideDevices
+
+
+Whether to delete the devices which are not configured via the
+devices option.
+If set to Type: +boolean + +Default:
+ Declared by: +
services.syncthing.overrideFolders
+
+
+Whether to delete the folders which are not configured via the
+folders option.
+If set to Type: +boolean + +Default:
+ Declared by: +
services.syncthing.passwordFile
+
+
+Path to the gui password file. + +Type: +null or path + +Default:
+ Declared by: +
services.syncthing.settings
+
+
+Extra configuration options for Syncthing. +See https://docs.syncthing.net/users/config.html. +Note that this attribute set does not exactly match the documented +XML format. Instead, this is the format of the JSON REST API. There +are slight differences. For example, this XML: corresponds to the Nix code: Type: +JSON value + +Default:
+ Example: Declared by: +
services.syncthing.settings.devices
+
+
+Peers/devices which Syncthing should communicate with. Note that you can still add devices manually, but those changes +will be reverted on restart if overrideDevices +is enabled. + +Type: +attribute set of (JSON value) + +Default:
+ Example: Declared by: +
services.syncthing.settings.devices.<name>.autoAcceptFolders
+
+
+Automatically create or share folders that this device advertises at the default path. +See https://docs.syncthing.net/users/config.html?highlight=autoaccept#config-file-format. + +Type: +boolean + +Default:
+ Declared by: +
services.syncthing.settings.devices.<name>.id
+
+
+The device ID. See https://docs.syncthing.net/dev/device-ids.html. + +Type: +string + +Declared by: +
services.syncthing.settings.devices.<name>.name
+
+
+The name of the device. + +Type: +string + +Default:
+ Declared by: +
services.syncthing.settings.folders
+
+
+Folders which should be shared by Syncthing. Note that you can still add folders manually, but those changes +will be reverted on restart if overrideFolders +is enabled. + +Type: +attribute set of (JSON value) + +Default:
+ Example: Declared by: +
services.syncthing.settings.folders.<name>.enable
+
+
+Whether to share this folder. +This option is useful when you want to define all folders +in one place, but not every machine should share all folders. + +Type: +boolean + +Default:
+ Declared by: +
services.syncthing.settings.folders.<name>.copyOwnershipFromParent
+
+
+On Unix systems, tries to copy file/folder ownership from +the parent directory (the directory it’s located in). +Requires running Syncthing as a privileged user, or +granting it additional capabilities (e.g. CAP_CHOWN on +Linux). + +Type: +boolean + +Default:
+ Declared by: +
services.syncthing.settings.folders.<name>.devices
+
+
+The devices this folder should be shared with. Each device must +be defined in the devices option. + +Type: +list of string + +Default:
+ Declared by: +
services.syncthing.settings.folders.<name>.id
+
+
+The ID of the folder. Must be the same on all devices. + +Type: +string + +Default:
+ Declared by: +
services.syncthing.settings.folders.<name>.label
+
+
+The label of the folder. + +Type: +string + +Default:
+ Declared by: +
services.syncthing.settings.folders.<name>.path
+
+
+The path to the folder which should be shared.
+Only absolute paths (starting with Type: +string starting with / or ~/ + +Default:
+ Declared by: +
services.syncthing.settings.folders.<name>.type
+
+
+Controls how the folder is handled by Syncthing. +See https://docs.syncthing.net/users/config.html#config-option-folder.type. + +Type: +one of “sendreceive”, “sendonly”, “receiveonly”, “receiveencrypted” + +Default:
+ Declared by: +
services.syncthing.settings.folders.<name>.versioning
+
+
+How to keep changed/deleted files with Syncthing. +There are 4 different types of versioning with different parameters. +See https://docs.syncthing.net/users/versioning.html. + +Type: +null or (JSON value) + +Default:
+ Example: Declared by: +
services.syncthing.settings.folders.<name>.versioning.type
+
+
+The type of versioning. +See https://docs.syncthing.net/users/versioning.html. + +Type: +one of “external”, “simple”, “staggered”, “trashcan” + +Declared by: +
services.syncthing.settings.options
+
+
+The options element contains all other global configuration options + +Type: +JSON value + +Default:
+ Declared by: +
services.syncthing.settings.options.limitBandwidthInLan
+
+
+Whether to apply bandwidth limits to devices in the same broadcast domain as the local device. + +Type: +null or boolean + +Default:
+ Declared by: +
services.syncthing.settings.options.localAnnounceEnabled
+
+
+Whether to send announcements to the local LAN, also use such announcements to find other devices. + +Type: +null or boolean + +Default:
+ Declared by: +
services.syncthing.settings.options.localAnnouncePort
+
+
+The port on which to listen and send IPv4 broadcast announcements to. + +Type: +null or signed integer + +Default:
+ Declared by: +
services.syncthing.settings.options.maxFolderConcurrency
+
+
+This option controls how many folders may concurrently be in I/O-intensive operations such as syncing or scanning. +The mechanism is described in detail in a separate chapter. + +Type: +null or signed integer + +Default:
+ Declared by: +
services.syncthing.settings.options.relaysEnabled
+
+
+When true, relays will be connected to and potentially used for device to device connections. + +Type: +null or boolean + +Default:
+ Declared by: +
services.syncthing.settings.options.urAccepted
+
+
+Whether the user has accepted to submit anonymous usage data. +The default, 0, mean the user has not made a choice, and Syncthing will ask at some point in the future. +“-1” means no, a number above zero means that that version of usage reporting has been accepted. + +Type: +null or signed integer + +Default:
+ Declared by: |