Forge Home


Configuration and management of Tor relays


6,487 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

  • 0.2.0 (latest)
  • 0.1.2
  • 0.1.1
  • 0.1.0 (deleted)
released Oct 13th 2017
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.0.0 < 6.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'arcaik-tor', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add arcaik-tor
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install arcaik-tor --version 0.2.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: tor, router, onion


arcaik/tor — version 0.2.0 Oct 13th 2017


Build Status


From the Tor project website: Tor is free software and an open network that helps you defend against traffic analysis, a form of network surveillance that threatens personal freedom and privacy, confidential business activities and relationships, and state security.

Table of Contents

  1. Module description
  2. Usage
  3. Reference
  1. Limitations
  2. Development

Module description

This module helps you run Tor relays by installing, configuring, and managing Tor service instances.


The main tor class manages the installation options.

The tor::instance type manages a Tor instance configuration.

Beginning with tor

You must first include the main class with: include ::tor, then you can create an instance with:

tor::instance { 'foo':
  settings => {
    Nickname => 'foo',
    OrPort   => 9050,
    DirPort  => 9030,

The instances parameters of the main class, will be passed to create_resources.

You may put you configuration options in hiera:

      Nickname: 'foo'
      OrPort: 9050
      DirPort: 9030


Public classes

Class tor


Optional. String. Sets the name of the Tor package (default: tor).


Optional. String. Controls the package resource's ensure attribute (default: present).

See Resource Type: package for a list of allowed values.


Optional. Stdlib::Absolutepath. Sets the directory where Tor's configuration files are located (default: /etc/tor).


Option. Stdlib::Absolutepath. Sets the directory where Tor's instances configuration files are located (default: /etc/tor/instances).


Option. Hash. Sets the instances that will be passed to create_resources.

Private classes

  • tor::params
  • tor::install: handles the packages installation.
  • tor::config: handles the configuration file management.

Public defined types

Defined type tor::instance:



Optional. String (absent or present).


Optional. Hash. Sets the Tor instance configuration values (default: an empty hash).

To repeat an options multiple times, its value can be an Array.

For instance:

tor::instance { "foo":
  settings => {
    Nickname => 'foo',
    OrPort   => [ 9050, "9051 NoAdvertise" ]
    DirPort  => 9030,


This module only works with systemd. It has only been tested on Debian 8 (Jessie).


Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. Please follow our guidelines when contributing changes.

For more information, see our module contribution guide.