89 lines
2.4 KiB
ReStructuredText
89 lines
2.4 KiB
ReStructuredText
cdist-type__ungleich_matrix(7)
|
|
==============================
|
|
|
|
NAME
|
|
----
|
|
cdist-type__ungleich_matrix - ungleich matrix enviroment
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
This type deploys a Matrix homeserver (synapse) and web client (element) on
|
|
ungleich's infrastructure. This is a singleton type.
|
|
|
|
|
|
REQUIRED PARAMETERS
|
|
-------------------
|
|
matrix-domain
|
|
Name of your homeserver, as used in MXIDs (e.g. ungleich.ch).
|
|
|
|
synapse-domain
|
|
Public address of the Matrix homeserver. This must be a domain name, as it is
|
|
used to generate TLS certificates and configuration for the web server.
|
|
|
|
element-address
|
|
Public address of the Element web client. This must be a domain name, as it is
|
|
used to generate TLS certificates and configuration for the web server.
|
|
|
|
element-version
|
|
Version of the Element client to be deployed.
|
|
|
|
synapse-smtp-user
|
|
SMTP user to ungleich's mail infrastructure. Used by Synapse to send
|
|
notifications over email.
|
|
|
|
synapse-smtp-password
|
|
SMTP password to ungleich's mail infrastructure (see synapse-smtp-user).
|
|
|
|
synapse-smtp-password
|
|
|
|
OPTIONAL PARAMETERS
|
|
-------------------
|
|
synapse-extra-parameters
|
|
Extra parameters passed to the `__matrix_synapse` type.
|
|
|
|
element-extra-parameters
|
|
Extra parameters passed to the `__matrix_element` type.
|
|
|
|
BOOLEAN PARAMETERS
|
|
------------------
|
|
None.
|
|
|
|
|
|
EXAMPLES
|
|
--------
|
|
|
|
.. code-block:: sh
|
|
|
|
__ungleich_matrix \
|
|
--matrix-domain matrix-staging.ungleich.ch \
|
|
--synapse-domain staging.matrix.ungleich.cloud \
|
|
--element-domain matrix-staging.ungleich.ch \
|
|
--element-version "1.7.20" \
|
|
--synapse-smtp-user "matrix@ungleich.ch" \
|
|
--synapse-smtp-password "secret" \
|
|
--synapse-extra-parameters " \
|
|
--enable-ldap-auth \
|
|
--ldap-uri ldaps://ldap1.ungleich.ch \
|
|
--ldap-base-dn dc=ungleich,dc=ch \
|
|
--ldap-bind-dn uid=matrix-synapse,ou=services,dc=ungleich,dc=ch \
|
|
--ldap-bind-password secret"
|
|
|
|
SEE ALSO
|
|
--------
|
|
- `cdist-type__matrix_synapse(7) <cdist-type__matrix_synapse.html>`_
|
|
- `cdist-type__matrix_element(7) <cdist-type__matrix_element.html>`_
|
|
|
|
|
|
AUTHORS
|
|
-------
|
|
Timothée Floure <timothee.floure@ungleich.ch>
|
|
|
|
|
|
COPYING
|
|
-------
|
|
Copyright \(C) 2020 Timothée Floure. You can redistribute it
|
|
and/or modify it under the terms of the GNU General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|