~fnux/matrix-cdist-types

ref: refs/heads/master matrix-cdist-types/type/__matrix_synapse/man.rst -rw-r--r-- 2.3 KiB
880a06f8Timothée Floure Adapt doc and CI for non-singleton riot type 1 year, 2 months ago
                                                                                
1
2
3
4
5
6
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
cdist-type__matrix_synapse(7)
======================

NAME
----
cdist-type__matrix_synapse - Install and configure Synapse, a Matrix homeserver


DESCRIPTION
-----------
This type install and configure the Synapse Matrix homeserver. This is a
signleton type.


REQUIRED PARAMETERS
-------------------
server_name
  Name of your homeserver (e.g. ungleich.ch) used as part of your MXIDs. This
  value cannot be changed without meddling with the database once the server is
  being used.

base_url
  Public URL of your homeserver (e.g. http://matrix.ungleich.ch).

database_engine
  'sqlite3' or 'postgresql'

database_name
  Path to the database if SQLite3 is used or database name if PostgresSQL is
  used.

OPTIONAL PARAMETERS
-------------------
database_host
  Database node address, only used with PostgresSQL.

database_user
  Database user, only used with PostgresSQL.

database_password
  Database password, only used with PostgresSQL.

ldap_uri
  Address of your LDAP server.

ldap_base_dn
  Base DN of your LDAP tree.

ldap_uid_attribute
  LDAP attriute mapping to Synapse's uid field, default to uid.

ldap_mail_attribute
  LDAP attriute mapping to Synapse's mail field, default to mail.

ldap_name_attribute
  LDAP attriute mapping to Synapse's name field, default to givenName.

ldap_bind_dn
  User used to authenticate against your LDAP server.

ldap_bind_password
  Password used to authenticate against your LDAP server.

ldap_filter
  LDAP user filter, defaulting to `(objectClass=posixAccount)`.

BOOLEAN PARAMETERS
------------------
allow_registration
  Enables user registration on the homeserver.

allow_ldap_auth
  Enables ldap-backed authentication.

report_stats
  Whether or not to report anonymized homeserver usage statistics.

EXAMPLES
--------

.. code-block:: sh

    __matrix_synapse --server_name ungleich.ch \
      --base_url https://matrix.ungleich.ch \
      --database_engine sqlite3 \
      --database_name /var/lib/matrix-syanpse/homeserver.db

SEE ALSO
--------
- `cdist-type__matrix_riot(7) <cdist-type__matrix_riot.html>`_


AUTHORS
-------
Timothée Floure <timothee.floure@ungleich.ch>


COPYING
-------
Copyright \(C) 2019 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.