syncthing

Syncthing module for Puppet.

Project URL RSS Feed Report issues

Module Stats

3,952 downloads

2,127 latest version

5.0 quality score

Version information

released Feb 10th 2020

This version is compatible with:

Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
Puppet >= 4.0.0 < 7.0.0
,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'brwyatt-syncthing', '1.1.6'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add brwyatt-syncthing

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install brwyatt-syncthing --version 1.1.6

Documentation

brwyatt/syncthing — version 1.1.6 Feb 10th 2020

syncthing

Compatibility note: the Puppet 3.7.0 and 3.8.0 compatibility has been dropped from metadata.json because the Puppet Forge does not provide a way to specifiy "compatible with Puppet 3.8.0 with future parser enabled". The module is, in fact, compatible with Puppet 3.7.0/3.8.0 with future parser enabled.

Version 1.0.0 has a (small) number of incompatible changes, most notably:

The version parameter has been renamed to package_version to reflect that this will only affact the version of the package installed, not of binaries.
Almost all defined types relevant to instance configuration now require instance_name in addition to home_path.
On the plus side, it is now possible to create what I like to call "binary" instances that install a defined version of the syncthing binary. See the binary_version parameter for more details.

Overview
Simple setup
- Beginning with Syncthing
- Syncthing instances
Usage - Classes and defined types available for configuration
- Classes and Defined Types
Limitations - OS compatibility, etc.
Special Notes and Acknowledgements

Overview

This module is still very much beta. Syncthing itself is still changing rapidly and has a few quirks.

This Syncthing module is meant to automate large parts of the Syncthing installation, service management and configuration editing. If provides defined types for Syncthing instances and various parts of the Syncthing configuration files.

Daemonization is currently achieved through a modified version of the Yeasoft btsync init.d script. Currently, there are a number of issues, mostly to do with the fact that Syncthing spawns new processes so often.

Simple setup

What syncthing affects:

The syncthing installation directory (/usr/bin/syncthing by default)
Configuration file directory (/etc/syncthing by default)
The init.d script for Syncthing, if present (/etc/init.d/syncthing)

Beginning with Syncthing

Install Syncthing, the service (init.d script) with default paths, no instances:

class { 'syncthing': }

Syncthing instances

Instances can be declared directly in the Syncthing base class, or by defined types:

class { '::syncthing':
  instances => {
    'example' => {
      home_path   => '/home/synctester/example_instance',
      daemon_uid  => 'synctest', # Default: root
      daemon_gid  => 'synctester', # Default: root

      # Variables for standard parameters
      gui_tls     => true,
      gui_address => '0.0.0.0', # (Default)
      gui_port    => '8888', # Default: 8080

      # Override or set arbitrary options
      options     => {
        'listenAddress' => 'tcp4://0.0.0.0:19000',
        'startBrowser'  => 'false',
        'globalAnnounceServer'  => '', # disable defaults globalAnnounceServers
        'globalAnnounceServer'  => $announce_node, # add your private this way
        'globalAnnounceServer2' => $announce_node2, # add a second this way
      },
    }
  }
}

or:

::syncthing::instance { 'example':
  home_path => '/home/synctester/example_instance',
  ...
}

Usage

Classes and Defined Types

Class: `syncthing`

Installs Syncthing and sets up the init.d service. The download URL is determined from the Syncthing Github releases page.

Parameters within syncthing:

`bin`

Override the assumed value for the Syncthing binary name. Defaults to syncthing.

`binpath`

Override the assumed value for the path to the Syncthing binary. Defaults to /usr/local/bin. This will actually by a symlink to the latest downloaded syncthing Binary.

`store_path`

Override the assumed path to store downloaded and extracted Syncthing releases in. Defaults to /usr/local/share/syncthing.

`instancespath`

Override the assumed value to the Syncthing instances configuration files. Defaults to /etc/syncthing.

`package_version`

Override the value used for the installation. Defaults to latest, in which case new releases will be downloaded when they are publishing on the Syncthing Github page. Note that Syncthing also has an auto-update mechanism.

`manage_repo`

Boolean to install syncthing APT repository. Defaults to true. Set it to false to control package installation using your internal / personal repository.

`package_name`

The name of the package that will be used for syncthing installation. Defaults to syncthing. Nice option for those we built their own packages.

`instances`

Hash that will be used to declare syncthing::instance resources.

`folders`

Hash that will be used to declare syncthing::folder resources.

`devices`

Hash that will be used to declare syncthing::device resources.

`services_type`

The module attempts to determine the service provider and, based on this, the service file type to install (systemd, initd), on its own, first using the service_provider fact, then based on the OS version. This may or may not work, depending on your setup. This can be used to override the automatically determined value. Pass in "systemd" or "initd".

`create_home_path`

Override the default value passed to syncthing::instancefor create_home_path.

`daemon_uid`

Override the default value passed to syncthing::instancefor daemon_uid.

`daemon_gid`

Override the default value passed to syncthing::instancefor daemon_gid.

`daemon_umask`

Override the default value passed to syncthing::instancefor daemon_umask.

`daemon_nice`

Override the default value passed to syncthing::instancefordaemon_nice.

`daemon_debug`

Override the default value passed to syncthing::instance for daemon_debug.

`gui`

Override the default value passed to syncthing::instancefor gui.

`gui_tls`

Override the default value passed to syncthing::instancefor gui_tls.

`gui_address`

Override the default value passed to syncthing::instancefor gui_address.

`gui_port`

Override the default value passed to syncthing::instance for gui_port.

`gui_apikey`

Override the default value passed to syncthing::instancefor gui_apikey.

`gui_user`

Override the default value passed to syncthing::instancefor gui_user.

`gui_password`

Override the default value passed to syncthing::instancefor gui_password.

See the notes on gui_password and gui_password_salt in the parameters for syncthing::instance for some important information regarding these two options.

`gui_password_salt`

Override the default value passed to syncthing::instancefor gui_password_salt.

`gui_options`

Override the default value passed to syncthing::instancefor gui_options.

`instance_options`

Override the default value passed to syncthing::instance for options.

`device_compression`

Override the default value passed to syncthing::device for compression .

`device_introducer`

Override the default value passed to syncthing::device for introducer.

`device_options`

Override the default value passed to syncthing::device for options.

Defined Type: `syncthing::instance`

Creates an instance. Provides some parameters for common options and an options parameter to override or set arbitrary options.

  syncthing::instance { 'example':
    home_path  => '/etc/backups/example',
    daemon_uid => 'user',
    gui_tls    => true,
  }

Parameters within syncthing::instance:

`ensure`

Specify whether the instance configuration file is present or absent. Defaults to 'present'. Valid values are 'present' and 'absent'.

`home_path`

The home path for this instance. Where the configuration file and all certificates are stored. Mandatory parameter, will be created by Syncthing if not present.

`create_home_path`

Attempt to recursively create the passed home path prior to calling Syncthing to generate the configuration/certificates. This will be called in the context of the user identified by daemon_uid.

`binary`

Sets this instance to be a "binary instance", meaning it will download a Syncthing binary to the path specified by binary_path and use that binary instead of the package-provided binary.

`binary_path`

If binary is set to true, the Syncthing binary will be downloaded to this path.

`binary_version`

The Syncthing version to get when downloading a Syncthing binary. Defaults to latest.

Note that once a binary has been downloaded, this parameter becomes ineffective due to the fact that only the existance of a binary is checked, not the version.

This has the advantage that a binary instance, once created, can be upgraded independently from other instances, in constrast with "package instances", which all share the package binary and get upgraded/restarted when the package is upgraded.

`daemon_uid`

The UID to run the daemon for this instance as.

`daemon_gid`

The GID to run the daemon for this instance as.

`daemon_umask`

The umask to run the daemon for this instance with.

`daemon_nice`

The niceness level for the instance daemon.

`daemon_debug`

The debug level for the instance daemon.

`gui`

Enable or disable the GUI. Valid values are true or false. Defaults to true.

`gui_tls`

Enable or disable SSL for the GUI. Valid values are true or false. Defaults to true.

`gui_address`

The address the GUI should listen at. Defaults to 0.0.0.0.

`gui_port`

Binding port for the GUI. Defaults to 8080.

`gui_apikey`

The API key for the GUI.

`gui_user`

Providing this and gui_password enables user authentication.

`gui_password`

Password to use to authenticate for the GUI.

If a salt string is provided through the gui_password_salt parameter (see below), then the value passed to gui_password is assumed to be the plaintext password and will be hashed with BCrypt prior to being inserted into the configuration file, using gui_password_salt as salt.

If gui_password_salt is not provided, the value passed to gui_password will be inserted as-is into the configuration file. This way, a BCrypt hash can be provided directly so as not to have plaintext passwords in the Puppet/Hiera files.

One method to hash a password with a random salt to obtain a hash for that password for direct insertion is (requires the bcrypt gem):

ruby -e "require 'bcrypt'; puts BCrypt::Engine.hash_secret('<<<PASSWORD>>>', BCrypt::Engine.generate_salt);"`

`gui_password_salt`

This must be set to a valid BCrypt salt such as $2a$10$vI8aWBnW3fID.ZQ4/zo1G. when providing plaintext passwords for hashing through this module.

One method to generate hashes is (requires the brypt gem):

ruby -e "require 'bcrypt'; salt = BCrypt::Engine.generate_salt; puts salt;"

Setting this parameter will result in the module attempting to generate a BCrypt-encrypted password. This requires the bcrypt gem to be installed on the puppetmaster.

`gui_options`

Set or override arbitrary GUI options. Created as XML nodes in the <gui></gui> element.

`options`

Set or override arbitrary options. Created as XML nodes in the <options></options> element.

Defined Type: `syncthing::device`

Adds a <device> entry to the configuration file for the instance associated with the passed home path.

Direct declarations of this type are possible, but discouraged outside of programatical declarations due to its cumbersome options. Defining devices through the devices parameter of the syncthing::instance class is much more practical in any manual definition scenario.

  ::syncthing::device { 'laptop':
    home_path     => '/etc/backup/instance1',
    instance_name => 'instance1',
    id            => '523LMDC-KKQPKVU-JBPGYQU-IAGHP5B-TU38GN4-G7CEEHG-OOL32IR-YWQSFAX',
    compression   => true,
  }

Parameters within syncthing::device:

`ensure`

Specify whether the device configuration is present or absent. Defaults to 'present'. Valid values are 'present' and 'absent'.

`home_path`

The home path for the instance that should be told about this device. Mandatory parameter.

`instance_name`

The name of the instance that should be told about this device, as passed to the instances parameter on the syncthing class. Mandatory parameter.

`id`

The ID for the device in the usual form.

`device_name`

The name for the device, defaults to the resource name.

`compression`

Value to set for the compression option for this device. Can be true or false, defaults to false.

`introducer`

Value to set for the introducer option for this device. Can be true or false, defaults to false.

`address`

Set an address to use to contact the device. Defaults to dynamic.

`options`

Set or override arbitrary options. Created as XML nodes in the <device></device> element.

Defined Type: `syncthing::folder`

Adds a <folder> entry to the configuration file for the instance associated with the passed home path.

Direct declarations of this type are possible, but discouraged outside of programatical declarations due to its cumbersome options. Defining folders through the folders parameter of the syncthing::instance class is much more practical in any manual definition scenario.

::syncthing::folder { 'laptop':
  home_path     => '/etc/backup/instance1',
  instance_name => 'instance1',
  id            => 'backupfolder1',
  path          => '/home/syncuser/myfiles',
  options       => {
    # Override options here
    # for trashcan versioning :
    'versioning'              => 'trashcan',
    'versioning_cleanoutDays' => '10',
    # for simple versioning
    'versioning'     => 'simple',
    'versioning_keep' => '5',
    # for staggered versioning
    'versioning'               => 'staggered',
    'versioning_maxAge'        => '864000',
    'versioning_cleanInterval' => '3600',
    # for external versioning
    'versioning'         => 'external',
    'versioning_command' => 'cmd',      
  },
  devices       => {
    '523LMDC-KKQPKVU-JBPGYQU-IAGHP5B-TU38GN4-G7CEEHG-OOL32IR-YWQSFAX' => 'present',
  }
}

Parameters within syncthing::folder:

`ensure`

Specify whether the device configuration is present or absent. Defaults to 'present'. Valid values are 'present' and 'absent'.

`home_path`

The home path for the instance that should be told about this folder. Mandatory parameter.

`instance_name`

The name of the instance that should be told about this device, as passed to the instances parameter on the syncthing class. Mandatory parameter.

`id`

The ID for the folder. Defaults to the name parameter.

`path`

Path to the folder that should be synced.

`type`

Value to set for the folder type. Can be readwrite or readonly, defaults to readwrite.

`rescanIntervalS`

Value to set for the rescanIntervalS option for this device. Defaults to 60.

`ignorePerms`

Value to set for the ignorePerms option for this device. Can be true or false, defaults to false.

`autoNormalize`

Value to set for the autoNormalize option for this device. Can be true or false, defaults to false.

`options`

Set or override arbitrary options. Created as XML nodes in the <folder></folder> element.

`devices`

A hash of devices to enable for the folder. Invididual device IDs can be specified and set to present or absent:

::syncthing::folder { 'laptop':
  ...
  devices => {
    '523LMDC-KKQPKVU-JBPGYQU-IAGHP5B-TU38GN4-G7CEEHG-OOL32IR-YWQSFAX' => 'present',
    'IAGHP5B-7IASKM-JBPGYQU-G7CEEHG-TU38GN4-TU38GN4-523LMDC-OOL32IR'  => 'absent',
  }
  ...
}

Defined Type: `syncthing::folder_device`

Adds a <device> entry for the specified folder.

::syncthing::folder { 'backupfolder1_on_laptop':
  home_path     => '/etc/backup/instance1',
  instance_name => 'instance1',
  folder_id     => 'backupfolder1',
  device_id     => '523LMDC-KKQPKVU-JBPGYQU-IAGHP5B-TU38GN4-G7CEEHG-OOL32IR-YWQSFAX',
}

Parameters within syncthing::folder_device:

`ensure`

Specify whether the device entry is present or absent. Defaults to 'present'. Valid values are 'present' and 'absent'.

`home_path`

The home path for the instance that should be told about this device. Mandatory parameter.

`instance_name`

The name of the instance that should be told about this device, as passed to the instances parameter on the syncthing class. Mandatory parameter.

`folder_id`

The ID of the folder.

`device_id`

The ID of the device.

Reference

Classes

Public Classes

syncthing: Basic setup.

Private Classes

syncthing::install_package: Installs the Syncthing package.
syncthing::install_binary: Downloads a Syncthing binary.
syncthing::service: Installs the Syncthing init.d daemon.
syncthing::instance_service: Provides commands that emulate service start/stop/restart for binary Syncthing instances.
syncthing::params: Manages Syncthing parameters.

Defined Types

Public Defined Types

syncthing::instance
syncthing::device
syncthing::folder
syncthing::folder_device: Adds a known device to a folder.

Limitations

Operating system support

Currently, only Debian and Ubuntu are supported. Debian has been tested more extensively. Contributions adding support for further OSes are welcome!

Special Notes and Acknowledgements

This module is a continuation of William Hefter's Syncthing Puppet module which was abandoned July 8th, 2018. Everything this module is or may become is thanks to the time and effort he put in to the project.

GPL 2.0
The GNU General Public License (GPL-2.0)

Version 2, June 1991

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

Preamble

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

NO WARRANTY

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.

One line to give the program's name and a brief idea of what it does.
Copyright (C) <year> <name of author>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.

signature of Ty Coon, 1 April 1989
Ty Coon, President of Vice

This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

syncthing

Version information

This version is compatible with:

Start using this module

Documentation

syncthing

Table of Contents

Overview

Simple setup

Beginning with Syncthing

Syncthing instances

Usage

Classes and Defined Types

Class: syncthing

bin

binpath

store_path

instancespath

package_version

manage_repo

package_name

instances

folders

devices

services_type

create_home_path

daemon_uid

daemon_gid

daemon_umask

daemon_nice

daemon_debug

gui

gui_tls

gui_address

gui_port

gui_apikey

gui_user

gui_password

gui_password_salt

gui_options

instance_options

device_compression

device_introducer

device_options

Defined Type: syncthing::instance

ensure

home_path

create_home_path

binary

binary_path

binary_version

daemon_uid

daemon_gid

daemon_umask

daemon_nice

daemon_debug

gui

gui_tls

gui_address

gui_port

gui_apikey

gui_user

gui_password

gui_password_salt

gui_options

options

Defined Type: syncthing::device

ensure

home_path

instance_name

id

Class: `syncthing`

`bin`

`binpath`

`store_path`

`instancespath`

`package_version`

`manage_repo`

`package_name`

`instances`

`folders`

`devices`

`services_type`

`create_home_path`

`daemon_uid`

`daemon_gid`

`daemon_umask`

`daemon_nice`

`daemon_debug`

`gui`

`gui_tls`

`gui_address`

`gui_port`

`gui_apikey`

`gui_user`

`gui_password`

`gui_password_salt`

`gui_options`

`instance_options`

`device_compression`

`device_introducer`

`device_options`

Defined Type: `syncthing::instance`

`ensure`

`home_path`

`create_home_path`

`binary`

`binary_path`

`binary_version`

`daemon_uid`

`daemon_gid`

`daemon_umask`

`daemon_nice`

`daemon_debug`

`gui`

`gui_tls`

`gui_address`

`gui_port`

`gui_apikey`

`gui_user`

`gui_password`

`gui_password_salt`

`gui_options`

`options`

Defined Type: `syncthing::device`

`ensure`

`home_path`

`instance_name`

`id`

`device_name`

`compression`

`introducer`

`address`

`options`

Defined Type: `syncthing::folder`

`ensure`

`home_path`

`instance_name`

`id`

`path`

`type`

`rescanIntervalS`

`ignorePerms`

`autoNormalize`

`options`

`devices`

Defined Type: `syncthing::folder_device`

`ensure`

`home_path`

`instance_name`

`folder_id`