Forge Home


Manages the /etc/updatedb.conf file and service


804 latest version

5.0 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

  • 2.1.0 (latest)
  • 2.0.0
  • 1.1.0
  • 1.0.0
released Jul 3rd 2022
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
  • Puppet >= 6.1.0 < 8.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-mlocate', '2.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-mlocate
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-mlocate --version 2.1.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.

Tags: mlocate, locate


puppet/mlocate — version 2.1.0 Jul 3rd 2022


License Build Status Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Table of Contents

  1. Module Description - What the module does and why it is useful
  2. Setup - The basics of getting started with ntp

Module Description

  • Install mlocate package
  • Configures /etc/updatedb.conf
  • Maintains a cron or timer to run mlocate.


Install mlocate and configure with default configuration.

include mlocate

Configure everything we can.

  ensure            => true,
  prunefs           => ['9p', 'afs', 'autofs', 'bdev'],
  prune_bind_mounts => true,
  prunenames        => ['.git', 'CVS'],
  prunepaths        => ['/afs', 'mnt' ],
  period            => 'daily',
  force_updatedb    => true,

The parameters prunefs, prunenames and prunepaths are configured with a unique merge strategy within hiera so the defaults can be easily extended.

  - winnt
  - .cache
  - /cvmfs

If you wish to switch to plocate instead you can use the package_names parameter to switch to that implementation instead.

  - plocate