Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

rubygemsmirror

A module to create a mirror of rubygems
Project URLRSS FeedReport issues

6,065 downloads

5,619 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.

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

  • 1.1.2 (latest)
  • 1.1.1 (deleted)
  • 1.1.0
  • 1.0.0
  • 0.1.0 (deleted)
released Oct 19th 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-rubygemsmirror', '1.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install jimmypw-rubygemsmirror --version 1.1.2

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/rubygemsmirror — version 1.1.2 Oct 19th 2017

rubygemsmirror

Table of Contents

  1. Description
  2. Setup - The basics of getting started with rubygemsmirror
  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

This module will make it possible to mirror rubygems using the rubygems-mirror gem

Setup

What rubygemsmirror affects

This module will:-

  • install the rubygems-mirrir gem
  • create the gem user
  • set up the home directory at /var/lib/gem
  • write the configuration to /var/lib/gem/.gem/.mirrorrc
  • configure the cron to sync rubygems

Setup Requirements

This module requires ruby to be installed. This module requires the parent directory to be created.

Beginning with rubygemsmirror

Include the ::rubygemsmirror class.

class { 'rubygemsmirror':
  destination => '/var/www/gems'
}

By default manage destination will be set to true and gems will be created. /var/www must already exist.

Beginning with rubygemsmirror

class { 'rubygemsmirror':
  destination,        # Required - Where to put the gems
  Boolean $managecron # Optional - manages cron? (true)
  Array   $cronhours  # Optional - when to sync hours ([06, 18])
  managedestination,  # Optional - Attempt to create destination (true)
  user,               # Optional - Who owns files and runs crons (gem)
  userhome,           # Optional - users home dir (/var/lib/gem)
  delete,             # Optional - Delete removed gems (false)
  threads,            # Optional - Download threads (10)
  retries,            # Optional - How many times to retry (3)
  from,               # Optional - Where to mirror gems from (https://rubygems.org) 
  skiperrors          # Optional - Skip errors (true)
}