coturn puppet module

Table of Contents

1. Overview
2. Usage
3. Reference
4. Contribuiting

Overview

Simple module to configure coturn TURN/STUN server.

Please make a pull request if additional configuration items are needed !

Usage

To use include coturn class, and add parameters to youre hiera database.

Reference

see REFERENCE.md

Contributing

Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint and the available spec tests in order to follow the recommended Puppet style guidelines from the Puppet Labs style guide.

Authors

This module is mainly written by Cirrax GmbH.

See the list of contributors for a list of all contributors.

Reference

Table of Contents

Classes

• coturn: main configuration class for coturn
• coturn::service: Installs services coturn

Classes

coturn

Main class to configure coturn

Parameters

The following parameters are available in the coturn class:

• config_file
• mode
• owner
• group
• package_name
• use_auth_secret
• no_stdout_log
• syslog
• simple_log
• verbose
• extra_verbose
• log_file
• static_auth_secret
• realm

config_file

Data type: String

the coturn configuration file

Default value: '/etc/turnserver.conf'

mode

Data type: String

mode to use for coturn config file

Default value: '0644'

owner

Data type: String

owner of coturn config file

Default value: 'root'

group

Data type: String

group of the coturn config file

Default value: 'root'

package_name

Data type: String

package to install

Default value: 'coturn'

use_auth_secret

Data type: Boolean

enable use-auth-secret

Default value: false

no_stdout_log

Data type: Boolean

Flag to prevent stdout log messages

Default value: false

syslog

Data type: Boolean

redirect all log output into system log (syslog)

Default value: false

simple_log

Data type: Boolean

if true, no log file rollover will be used

Default value: false

verbose

Data type: Boolean

if true, enables verbose mode

Default value: false

extra_verbose

Data type: Boolean

if true, enables Verbose mode (extra verbose)

Default value: false

log_file

Data type: Optional[String]

Option to set the log file path

Default value: undef

static_auth_secret

Data type: Optional[String]

'Static' authentication secret value

Default value: undef

realm

Data type: Optional[String]

the default realm to be used

Default value: undef

coturn::service

coturn::service

Parameters

The following parameters are available in the coturn::service class:

• service_name
• service_ensure
• service_enable
• enable_turnserver
• default_file
• daemon_args

service_name

Data type: String

Service name for coturn.

Default value: 'coturn'

service_ensure

Data type: String

Whether the service should be running. Defaults to 'running'

Default value: 'running'

service_enable

Data type: Boolean

Whether the service should be enabled. Defaults to true

Default value: true

enable_turnserver

Data type: Boolean

do we enable coturn in the default_file ? set to false to disable.

Default value: true

default_file

Data type: Optional[String]

use a file in /etc/default to enable server. this is the filename with path.

Default value: undef

daemon_args

Data type: Optional[String]

if default_file is set, this parameter can be used to set the startup options (DAEMON_ARGS) there. if set to 'absent', the option will be deleted.

Default value: undef