Forge Home

shoutcast

Install and configure the shoutcast server.

6,404 downloads

6,266 latest version

4.6 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.1.1 (latest)
  • 0.1.0
released May 22nd 2017
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 'jimmypw-shoutcast', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jimmypw-shoutcast
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jimmypw-shoutcast --version 0.1.1

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

jimmypw/shoutcast — version 0.1.1 May 22nd 2017

shoutcast

Table of Contents

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

Description

Shoutcast is a freely available internet radio server available from: www.shoutcast.com

Setup

What shoutcast affects

This module will install and configure a shoutcast server, systemd unit files, configuration and various streams.

Setup Requirements

To get started you need to have at least one Authhash from shoutcast.com

Beginning with shoutcast

Declare the top-level shoutcast class to set up software and define a stream:

class { 'shoutcast':
  adminpasssword => 'bogusadminpassword',
  password  => 'boguspassword'
}

shoutcast::stream { 'stationname':
  streamid => 1,
  authhash => 'xyxyxyxyxyxyxy'
}

Usage

All of the parameters mentioned above are required. For each there is an optional config parameter that will allow you to inject arbitary configuration in to the configuration file at that point eg...

class { 'shoutcast':
  adminpasssword => 'bogusadminpassword',
  password  => 'boguspassword',
  config => {
    'portbase' => '5555'
  }
}

shoutcast::stream { 'stationname':
  streamid => 1,
  authhash => 'xyxyxyxyxyxyxy',
  config => {
    'streamintrofile' => '/path/to/intro/file.mp3'
  }
}

Limitations

Although the binary provided by shoutcast is a universal binary there is no guarantee that it will run on your system. By default this module will install the 64 bit executable. There is a 32 bit executable but you have to provide the url yourself.

This module does not handle software upgrades. In order to upgrade the software you must rm /opt/shoutcast before re-applying the module to your system.

Release Notes/Contributors/Etc. Optional

24-5-2017 0.1.1 Fixes to tests, improvement to readme file. 23-5-2017 0.1.0 Initial Release