Puppet Class: synapse

Inherited by:
synapse::repo
synapse::config
synapse::install
synapse::service
Defined in:
manifests/init.pp

Summary

Installs and configures Matrix Synapse

Overview

Installs and configures Matrix Synapse.

Examples:

include synapse

Parameters:

  • user (String) (defaults to: 'matrix-synapse')
  • group (String) (defaults to: 'users')
  • repo_manage (Boolean) (defaults to: false)
  • repo_sources (Hash) (defaults to: {})
  • package_manage (Boolean) (defaults to: true)
  • package_ensure (String) (defaults to: 'latest')
  • package_name (String) (defaults to: 'matrix-synapse')
  • package_extras (Array[String]) (defaults to: [])
  • server_name (String) (defaults to: 'example.com')
  • listen_port (Integer) (defaults to: 8008)
  • listen_address (String) (defaults to: '127.0.0.1')
  • conf_dir (String) (defaults to: '/etc/matrix-synapse')
  • data_dir (String) (defaults to: '/var/lib/matrix-synapse')
  • database_name (String) (defaults to: 'sqlite3')
  • database_args (Hash) (defaults to: {'database' => "${data_dir}/synapse.db"})
  • media_store_path (String) (defaults to: "${data_dir}/media")
  • uploads_path (String) (defaults to: "${data_dir}/uploads")
  • macaroon_secret_key (String) (defaults to: 'changeme')
  • service_manage (Boolean) (defaults to: true)
  • service_name (String) (defaults to: 'matrix-synapse')
  • service_ensure (String) (defaults to: 'running')
  • additional_config (Hash) (defaults to: {})
  • registration_enabled (Boolean) (defaults to: false)
  • registration_secret (String) (defaults to: 'changeme') 


7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'manifests/init.pp', line 7

class synapse(
    String  $user = 'matrix-synapse',
    String  $group = 'users',
    Boolean $repo_manage = false,
    Hash    $repo_sources = {},
    Boolean $package_manage = true,
    String  $package_ensure = 'latest',
    String  $package_name = 'matrix-synapse',
    Array[String]
        $package_extras = [],
    String  $server_name = 'example.com',
    Integer $listen_port = 8008,
    String  $listen_address = '127.0.0.1',
    String  $conf_dir = '/etc/matrix-synapse',
    String  $data_dir = '/var/lib/matrix-synapse',
    String  $database_name = 'sqlite3',
    Hash    $database_args = {'database' => "${data_dir}/synapse.db"},
    String  $media_store_path = "${data_dir}/media",
    String  $uploads_path = "${data_dir}/uploads",
    String  $macaroon_secret_key = 'changeme',
    Boolean $service_manage = true,
    String  $service_name = 'matrix-synapse',
    String  $service_ensure = 'running',
    Hash    $additional_config = {},
    Boolean $registration_enabled = false,
    String  $registration_secret = 'changeme',
) {
    include "${module_name}::repo"
    include "${module_name}::install"
    include "${module_name}::config"
    include "${module_name}::service"
}