Forge Home

synapse

Installs and configures Matrix Synapse

1,241 downloads

454 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

  • 1.0.1 (latest)
  • 1.0.0
released Apr 25th 2022
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.21.0 < 8.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'cheasles-synapse', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add cheasles-synapse
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install cheasles-synapse --version 1.0.1

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

cheasles/synapse — version 1.0.1 Apr 25th 2022

Matrix Synapse

This module installs and configures Matrix Synapse.

Table of Contents

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

Description

This module installs and configures Matrix Synapse.

Setup

What synapse affects

  • Configures Apt to use the Matrix repositories (if enabled).
  • Installs the Synapse package using the system package manager.
  • Configures Synapse using the settings specific in the manifest.
  • Manages the Synapse service.

Setup Requirements

This module by default configures Synapse to listen on 127.0.0.1:8008. If you want to connect to it remotely, you'll need to configure a frontend webserver or change the default bind address.

Beginning with synapse

To get started, simply include the synapse class as follows:

include ::synapse

The default settings will install Synapse and configure it to listen on 127.0.0.1:8008. You should configure a frontend webserver to proxy through to that address.

You should provide new values for registration_secret and macaroon_secret_key.

Usage

Secrets

The default configuration doesn't provide secure values for registration_secret and macaroon_secret_key. You can set them with the following Hiera:

synapse::registration_secret: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
synapse::macaroon_secret_key: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

Changing the Default Bind Address

To change what address Synapse binds to, use the following Hiera:

synapse::listen_address: 127.0.0.1
synapse::listen_port: 8008

LDAP Integration

To enable LDAP integration for logging in, you can use the following:

synapse::registration_enabled: false
synapse::additional_config:
  password_providers:
    - module: 'ldap_auth_provider.LdapAuthProvider'
      config:
        enabled: true
        uri: 'my-ldap-server.com'
        start_tls: true
        base: 'ou=Users,dc=my-ldap-server,dc=com'
        attributes:
            uid: "cn"
            mail: "mail"
            name: "givenName"
        # Search auth if anonymous search not enabled
        bind_dn: 'cn=reader,dc=my-ldap-server,dc=com'
        bind_password: 'reader password'
        filter: '(objectClass=posixAccount)'

Limitations

There are currently no known issues.

Development

If you'd like to contribute, please see CONTRIBUTING.