Forge Home

torrent_client

A client for downloading files via the BitTorrent protocol from a torrent-server.

7,248 downloads

7,057 latest version

4.9 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.

Version information

  • 0.2.0 (latest)
  • 0.1.0
released Apr 6th 2016
This version is compatible with:
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'msmith-torrent_client', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add msmith-torrent_client
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install msmith-torrent_client --version 0.2.0

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

msmith/torrent_client — version 0.2.0 Apr 6th 2016

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with torrent_client
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

A client for downloading files via the BitTorrent protocol from a torrent-server.

Module Description

This module uses libtorrent BitTorrent library written in C++ to download files served from a torrent-server. Using BitTorrent to transfer files can result in faster transfers with less load on the file server.

The module includes two classes:

  • torrent_client to configure the system for downloading files using BitTorrent
  • torrent_file to download individual files

Setup

Beginning with torrent_client

Install libtorrent and boost as pre-requisites for building the torrent_client Ruby gem.

On Mac OS X, that can be done via Homebrew

brew install boost libtorrent-rasterbar

Usage

class {'::torrent_client':
  provider => 'puppet_gem',
}

Torrent_File {
  server => 'http://filehost:8000/torrent',
  port   => 5555,
}

torrent_file {'large file':
  path => '/tmp',
}

Reference

Classes

torrent_client

Install client prereqs; currently only torrent_client.

  • provider: select which package provider to use to install Ruby gems. Defaults to puppet_gem.

Resources

torrent_file

Downloads a file.

  • file: namevar, name of the file as stored on the server
  • ensure: ensure the file is present/absent
  • path: (required) fully qualified file path for a directory to download the file to
  • server: (required) torrent server name and port
  • port: port to use for the BitTorrent, defaults to 5555