Forge Home

btsync

Creates folders synchronized by btsync

9,644 downloads

9,007 latest version

3.3 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.3 (latest)
  • 0.0.2
  • 0.0.1 (deleted)
released Feb 18th 2014

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'KyleAnderson-btsync', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add KyleAnderson-btsync
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install KyleAnderson-btsync --version 0.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

KyleAnderson/btsync — version 0.0.3 Feb 18th 2014

About

Build Status

This is module makes it easy to manage shared folders using the BitTorrent SyncApp (btsync). Think Dropbox with a bitorrent backend and no server. (and no storage fees) Kinda like an eventually consistent filesystem.

Installation

puppet module install KyleAnderson/btsync

Then put your btsync binary in the btsync/files/ directory based on the arch:

cd modules/btsync/files
./download-btsyncs.sh

Examples

Simple shared folder with defaults:

class { 'btsync': }
btsync::shared_folder { '/media/sync': secret => 'HIKVMVKXNORH33X......' }

A more complicated example, explicit settings, dropbox-like, random port:

class { 'btsync': listening_port => 0, upload_limit => 50, download_limit => 500 }
btsync::shared_folder { '/media/sync': 
  secret           => 'HIKVMVKXNORH33X......' }
  use_relay_server => true,
  use_tracker      => true,
  use_dht          => true,
  search_lan       => true,
  use_sync_trash   => true,
}

Pro. Internal only with explicity node declaration running as www-data:

class { 'btsync': user => 'www-data', use_upnp => false }
btsync::shared_folder { '/var/www/': 
  secret           => 'HIKVMVKXNORH33X......' }
  use_relay_server => false,
  use_tracker      => false,
  use_dht          => false,
  search_lan       => true,
  use_sync_trash   => false,
  known_hosts      => [ "web1:6881", "web2:6881", "web3:6881" ],
} 

Bugs

  • In order to make valid json with puppet-concat, I have to add an empty trailing {} without a comma. btsync complains but works anyway
  • Only supporting upstart scripts for now
  • Would be nice to support multiple instances of btsync running for performance or security reasons. Maybe someday.

License

Apache License, Version 2.0

Contact

Kyle Anderson kyle@xkyle.com

Support

https://github.com/solarkennedy/puppet-btsync