Forge Home

coturn

Install and configure Coturn

2,277 downloads

502 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.2.0 (latest)
  • 2.1.0
  • 2.0.0
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Jan 29th 2022
This version is compatible with:
  • Puppet Enterprise 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 'adullact-coturn', '2.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add adullact-coturn
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install adullact-coturn --version 2.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.

Download

Documentation

adullact/coturn — version 2.2.0 Jan 29th 2022

coturn

Table of Contents

  1. Description
  2. Setup - The basics of getting started with coturn
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

The Puppet module installs and configures a TURN service with Coturn.

Setup

Setup Requirements

Module dependencies are listed in metadata.json file.

Beginning with coturn

As minimalistic setup, it is enought to give a realm :

  class { 'coturn' :
    realm => 'coturn.example.org',
  }

Usage

For instance, we can change listening port and restrict the binded ip addresses :

  class { 'coturn' :
    realm          => 'coturn.example.org',
    listening_port => 8080,
    listening_ips  => [
      '10.0.0.10',
    ],
  }

For WebRTC adding the 3 following parameters are required :

  class { 'coturn' :
    lt_cred_mech       => true,
    use_auth_secret    => true,
    static_auth_secret => 'alongstringsharedsecretwithwebrtcserver',
  }

Notes :

  • Since the current version of Puppet module does not modify tables in SQLite database, the dynamic auth method permited by Coturn can not be used. So we have to use the static auth method.
  • In WebRTC usage it should be interesting to bind on 443 port to pass through firewalls. Since, port 443 is lower than 1024, the defaut non root user proc_user will not be able to open socket. So we will have to use proc_user parameter to root.

Reference

Details are in REFERENCE.md file.

Limitations

Supported OSes are given is metadata.json file.

Development

Home at URL https://gitlab.adullact.net/adullact/puppet-coturn

Issues and MR are welcome.

Release Notes/Contributors/Etc.

Details in CHANGELOG.md.

Copyright (C) 2018 Association des Développeurs et Utilisateurs de Logiciels Libres
                     pour les Administrations et Colléctivités Territoriales.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/agpl.html>.