Overview

The btsync puppet module allows you to manage multiple BitTorrent Sync instances with Puppet and systemd.

Usage

Just include the btsync::system class to enable a system-wide configuration with the webui enabled. This by default this will have the webui accessible via localhost only.

include btsync::system

If you wish to enable remote access to the webui:

class { 'btsync::system':
    webui => 'remote',
}

Syncing individual folders

Declare a folder to be synced. This will create an individual service per folder. Lots more options are available below.

btsync::folder { '/path/to/folder':
    secret => 'abcdefg',
    path   => '/alternate/path/instead/of/title',
    owner  => 'root',
    group  => 'root',
}

Reference

Classes:

• btsync

Resources:

• btsync::system
• btsync::folder

Class: btsync

Install btsync. You should not declare this class explicitely, it should be done by either the btsync::system or btsync::folder classes.

Class: btsync::system

This resource is used to declare a system-wide btsync daemon to be run.

listening_port

The port the daemon should listen on for new connections. (NOT the webui port). 0 is random. Default: 0

storage_path

The path to store internal data for the btsync application. Default: /var/lib/btsync

use_upnp

Use UPnP for port mapping Default: true

download_limit

Limit the download speed for this folder. Default: 0

upload_limit

Limit the upload speed for this folder. Default: 0

webui_listen

The address/port on which to run the webui. Default: 127.0.0.1:8888

login

The login username for the webui. Leaving this and password undefined results in the configuration wizard running when you first connect to the webui.

password

The password for webui access. Leaving this and login undefined results in the configuration wizard running when you first connect to the webui.

directory_root

The default path to show when browsing for a folder in the webui. Default: /

Class: btsync::folder

This resource is used to declare an individual folder that is to be synced. Each instance will result in its own service being generated.

ensure

Either present or absent. If set to absent it will cause an error after the removal due to bug PUP-2188.

secret

A read/write or read-only secret generated with btsync --generate-secret or btsync --get-ro-secret $secret

path

The path to sync; Defaults to title.

owner

The owner for the folder and subdirectories

group

The group for the folder and subdirectories

listening_port

Port for the daemon to listen on. 0 will randomize on start. Default: 0

use_upnp

Use UPnP for port mapping Default: true

download_limit

Limit the download speed for this folder. Default: 0

upload_limit

Limit the upload speed for this folder. Default: 0

use_relay_server

Use relay server when direct connection fails. Default: false

use_tracker

Use a torrent tracker to find peers. Default: false

use_dht

Use DHT to find peers. Default: true

search_lan

Search for peers on the local network. Default: true

sync_trash

Enable SyncArchive to store files deleted on remote devices. Default: true

overwrite_changes

Restore modified files to original version, ONLY for Read-Only folders. Default: false

ignore_list

An array of entries to add to the IgnoreList file. The default list (desktop.ini, .DS_Store, etc) will always be active. Default: []

TODO

• Create unit tests
• Add explicit support for extra OSes