Code Monkey home page Code Monkey logo

puppet-tor's Introduction

Tor

Build Status

Overview

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.

Usage

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:

---
tor::instances:
  foo:
    settings:
      Nickname: 'foo'
      OrPort: 9050
      DirPort: 9030

Reference

Public classes

Class tor

Parameters
package_name

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

package_ensure

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

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

config_dir

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

instances_config_dir

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

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:

Parameters

ensure

Optional. String (absent or present).

settings

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

To repeat the torrc options multiple times, you can use an Array as value for members of settings.

For instance:

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

Limitations

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

Development

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.

puppet-tor's People

Contributors

johanfleury avatar

Watchers

James Cloos avatar Zach Crownover avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.