Forge Home

speedtest

Install Ookla SpeedTest Mini on Linux

14,011 downloads

6,515 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.2.1 (latest)
  • 0.2.0
  • 0.1.1
  • 0.1.0
released Nov 8th 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 'jgazeley-speedtest', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jgazeley-speedtest
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jgazeley-speedtest --version 0.2.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

jgazeley/speedtest — version 0.2.1 Nov 8th 2017

speedtest

Table of Contents

  1. Overview
  2. Usage - Configuration options and additional functionality
  3. Limitations - OS compatibility, etc.
  4. Development - Guide for contributing to the module

Overview

This module installs Ookla Speedtest Mini.

Speedtest Mini is free but not freely redistributable and therefore cannot be included with this module. However this module will attempt to download it directly from Ookla. If this is not possible, you will need to create an account with Ookla and download mini.zip from their website. This module will then use mini.zip to install and configure Speedtest Mini.

This module relies on puppetlabs/apache to handle the web server, on puppetlabs/firewall to install the optional firewall rule and on maestrodev/wget to fetch the zip file from Ookla.

Usage

To download Speedtest Mini directly from Ookla:

class site_speedtest {
  class { 'speedtest':
    download => true,
    webroot  => '/var/www/speedtest',
    vhost    => 'speedtest.example.com',
    firewall => true,
  }
}

To fetch mini.zip yourself and present it from Puppet:

class site_speedtest {
  class { 'speedtest':
    source   => 'puppet:///modules/site_speedtest/mini.zip',
    webroot  => '/var/www/speedtest',
    vhost    => 'speedtest.example.com',
    firewall => true,
  }
}

download

Whether to attempt to fetch Speedtest Mini directly from Ookla. Optional, defaults to true.

url

URL to download Speedtest Mini. Defaults to http://c.speedtest.net/mini/mini.zip

source

Path to mini.zip using the Puppet fileserver. Required if $getfile == true.

webroot

Path to the web root on your system. Optional, defaults to /var/www/speedtest.

vhost

Domain name from which Speedtest Mini should be served. Optional, defaults to $::fqdn

firewall

Whether to make a firewall exception on port 80. Optional, defaults to false

Limitations

This module was written for use with CentOS 6. It has not been tested on any other platforms but it ought to work pretty much anywhere that supports Apache. Please let me know if it works on other distributions.

Development

Feel free to send issues and pull requests to improve this simple module.