get_iplayer

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 get_iplayer
   • What get_iplayer affects
   • Setup requirements
   • Beginning with get_iplayer
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

The get_iplayer module lets you access content from the BBC iPlayer service.

Module Description

This module installs get_iplayer from its source location on the web. This provides a command line client and a web-based PVR service. The module also installs a service for PVR functionality. The software can only access video content from a UK-based IP address.

Setup

What get_iplayer affects

• Creates /etc/get_iplayer directory
• Installs software into /usr/local
• Creates get_iplayer service in native service provider
• Runs service on port 1935

Setup requirements

A system running a RHEL-based or Debian-based OS. On RHEL, extra YUM repositories must be added to satisfy the package requirements. These repositories are EPEL and Nux Dextop. They can be added them manually or by including the following Forge modules:

https://forge.puppet.com/stahnma/epel https://forge.puppet.com/m0byd1ck/nux

Beginning with get_iplayer

 include 'get_iplayer'

The above gets the client software installed. Make sure to follow the setup requirements above. The command line client can be accessed by running:

/usr/bin/get_iplayer

The PVR service can be accessed from:

http://localhost:1935

Usage

Change the PVR service listen address

The PVR service runs on localhost (127.0.0.1) by default so to access it remotely, set the listen_address parameter:

 class { 'get_iplayer':
   listen_address => '0.0.0.0'
 }

Change the PVR service listen port

 class { 'get_iplayer':
   listen_port => '1935'
 }

Change the PVR service download directory location

 class { 'get_iplayer':
   output_dir => '/home/joebloggs/Downloads'
 }

Set software version

By default, the latest version of the software is installed from the ftp site. See http://www.infradead.org/get_iplayer/CHANGELOG-get_iplayer for available versions and set the version manually:

 class { 'get_iplayer':
   version => '2.94'
 }

Dealing with software prerequisites

This software has the following prerequisites:

perl perl::CGI perl::Env perl::HTML::Parser perl::HTTP::Cookies perl::libwww::perl perl::XML::Simple rtmpdump or flvstreamer ffmpeg or libav-tools

The module attempts to install these using the ensure_package function. If this causes a problem, prerequisite installation can be skipped:

 class { 'get_iplayer':
   manage_prereqs => false
 }

Additional get_iplayer options for PVR service

To set additional options the options_extra takes a hash:

 class { 'get_iplayer':
   options_extra => { 'subdir' => true, subdirformat => '<nameshort>' }
 }

The above option causes the PVR service to create a subdirectory for the download. For a complete list of options, run:

get_iplayer --dump-options

Reference

Classes

Public Classes

• get_iplayer: Main class, includes all other classes

Private Classes

• get_iplayer::install: Handles the software source.
• get_iplayer::config: Handles the PVR service configuration.
• get_iplayer::service: Handles the PVR service.

Parameters

The below parameters are available in the get_iplayer class:

####base_dir

Target directory for tarball. Defaults to '/usr/local'.

####conf_dir

PVR service config directory. The options file and the generated cache are stored here. Defaults to '/etc/get_iplayer'.

####listen_address

PVR service listen address. Defaults to '127.0.0.1'.

####listen_port

PVR service listen address. Defaults to '1935'.

####manage_prereqs

Installs perl dependencies and external commands (see full description in Setup section). Defaults to true.

####options_extra

Extra options for PVR service (see full description in Setup section). Defaults to an empty hash: {}

####output_dir

Download directory for PVR service. Defaults to '/var/get_iplayer'.

####prereqs

Prerequisite packages. Defaults to a hash in get_iplayer::params.

####service_env_path

Path to service environment file.

####service_path

Path to service file.

####service_template

Templace for service file.

####source_location

FTP location of software source file. VERSION is replaced by the version parameter. Defaults to:

ftp://ftp.infradead.org/pub/get_iplayer/get_iplayer-VERSION.tar.gz

####version

Set version.

Limitations

This module has been tested with Puppet 4.

The module has been tested on:

• CentOS 6/7
• Ubuntu 12.04/14.04/14.10/15.04

Development

Please send pull requests.

523b32c (HEAD, master) update tag to 0.1.4 9e9f531 (origin/master, origin/HEAD) remove trailing comma which is bad for some reason 4be500a add missing fact stub e1afae1 reorder params to use service_provider fact. Update to 2.97. Install staging dependencies in examples manifests 438ac22 (origin/rubocop) add rubocop update spec file to comply 8699f3b (origin/use_github) cover package resources in spec 15d8692 cover all resources in spec ccc17e8 cover all classes in spec 69ed407 remove environment variable 1520d92 remove ruby 1.9 9284c36 set fact required by staging module c1da186 set fact required by staging module 672a6d5 Use Github as source for get_iplayer ce55fa1 use github for default source e867a47 replace double with single quotes d2585a7 switch second vagrant provisioner from shell to puppet 7b6b935 make bundle resources idempotent bdef3ca Merge branch 'vagrant' 3e39f5b Add nux and epel classes to examples and fixtures b66e356 Remove EPEL and Nux YUM repos from the list of requirements. Prereqs is now a simple list so the prereqs class parameter is now an array. Document the requirement for EPEL and Nux in the readme. bbd09ab Use puppet to provision bundle. Add epel to tests manifest b8056a4 Add initial vagrant file 79c1cba Ignore files generated by spec file 1e7e9d9 Add ignore file a37e5d9 Revert "Initial commit" aa268f5 Initial commit a88ba08 (tag: 0.1.3) 0.1.3 tag

• 31f1123 (HEAD, origin/master, origin/HEAD, master) release_checks runs spec, lint and validate
• d5f4f29 validate metadata.json
• 9fdcab8 same as travis.ci
• 6a72a73 add facts to spec
• d2c3884 test drone
• 791c78c test drone
• 6e77430 remove space from versions
• 1d34ece add drone support
• 79991f5 (tag: 0.1.2) New tag
• 6eedd90 Fix unbounded dependency
• 738237f remove older versions of ruby
• 1c92c5b set clone directory
• 453704f test travis
• f2da63f Add travis yaml
• bf30e20 Fix lint errors
• d045887 (tag: 0.1.1) Fix licence and update metadata.json
• f47333e (tag: 0.1.0) Apache license
• 7e78358 trailing space
• 3fc95f5 More lint cleanup
• dfeffae Fix lint errors
• 0dfa769 Add CHANGELOG. Update README.md with module information. Rearrange params.
• efb74a6 Fix syntax error
• 888172c Fill out metadata.json
• f0a1ceb Call validation functions on class parameters
• da8e39b Optionally manage prerequisites. Rename basedir to base_dir
• 692deab don't hack profile env
• ba4b9a8 versioncmp returns int not string
• 72e1232 Use versioncmp differently
• 2b64907 libav-tools no longer used by Ubuntu
• 2299ba1 Redo source retrieval
• 76aa73f Rearrange params file.
• 91baac1 Use systemd on Ubuntu 15.04 and greater
• de6592b Add perl xml simple dependency
• 4e558da avconv in different package
• 4137c1d Ubuntu packages for get_iplayer
• cbaafce First add Debian support
• 1a772d9 add Ubuntu support
• 9ac9452 Change err to fail
• 9ee032d Fix upstart script name
• 6b43e88 syntax error
• 2742317 use os fact hash. prereq packages different for RHEL 6
• c385cbd Try upstart for RHEL6
• 4d4469d Create separate params for rhel6
• 67c1443 rename
• 5804cda Require perl-CGI
• 8b9adf5 Don't redeclare epel-release
• 391fe9b Create resources using ensure_resources. Require epel-release
• 9e61703 fix package name
• 8284778 update with working hash
• ec7a981 fix package name
• c24c69a syntax error. Add dependency
• 5af755d syntax error
• d307da3 syntax error
• 225afaa Array of hashes
• 4c4eb3e Params before get_iplayer so can't use class parameter (duh)
• d0bfd4e Use future parser to iterate over package resources
• 0a6d4bf move default options hash to config class
• d19992e set output dir
• e85e607 fix key name
• 72afc0b fix values
• dfec717 syntax error
• fdf9a47 syntax error
• a4ed910 Add service environment
• 379a147 Add service
• 0700f8e Add source location and basedir params
• 05091ad Test map options
• ed5a6e7 Test map options
• b504fa0 Test map options
• 2c4293e Test map options
• adf1770 fix dir name
• cd3bd69 add environment variables for conf dir
• 8c50a08 syntax error
• 8ad3cf9 install prerequisites
• 7a19b97 Add config manifest. Create params
• 8194b29 Add install class. Add copyright info. Add empty params class
• 01d3141 Initial structure generated by puppet module subcommand
• ad29231 Initial commit