2020-06-25 09:16:20 +00:00
|
|
|
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
|
|
|
|
|
-------------------
|
2021-02-12 08:58:10 +00:00
|
|
|
server-name
|
2020-06-25 09:16:20 +00:00
|
|
|
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.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
base-url
|
2020-06-25 09:16:20 +00:00
|
|
|
Public URL of your homeserver (e.g. http://matrix.ungleich.ch).
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
database-engine
|
2020-06-25 09:16:20 +00:00
|
|
|
'sqlite3' or 'postgresql'
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
database-name
|
2020-06-25 09:16:20 +00:00
|
|
|
Path to the database if SQLite3 is used or database name if PostgresSQL is
|
|
|
|
|
used.
|
|
|
|
|
|
|
|
|
|
OPTIONAL PARAMETERS
|
|
|
|
|
-------------------
|
2021-02-12 08:58:10 +00:00
|
|
|
database-host
|
2020-06-25 09:16:20 +00:00
|
|
|
Database node address, only used with PostgresSQL.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
database-user
|
2020-06-25 09:16:20 +00:00
|
|
|
Database user, only used with PostgresSQL.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
database-password
|
2020-06-25 09:16:20 +00:00
|
|
|
Database password, only used with PostgresSQL.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-uri
|
2020-06-25 09:16:20 +00:00
|
|
|
Address of your LDAP server.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-base-dn
|
2020-06-25 09:16:20 +00:00
|
|
|
Base DN of your LDAP tree.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-uid-attribute
|
2020-06-25 09:16:20 +00:00
|
|
|
LDAP attriute mapping to Synapse's uid field, default to uid.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-mail-attribute
|
2020-06-25 09:16:20 +00:00
|
|
|
LDAP attriute mapping to Synapse's mail field, default to mail.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-name-attribute
|
2020-06-25 09:16:20 +00:00
|
|
|
LDAP attriute mapping to Synapse's name field, default to givenName.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-bind-dn
|
2020-06-25 09:16:20 +00:00
|
|
|
User used to authenticate against your LDAP server in 'search' mode.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-bind-password
|
2020-06-25 09:16:20 +00:00
|
|
|
Password used to authenticate against your LDAP server in 'search' mode.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-filter
|
2020-06-25 09:16:20 +00:00
|
|
|
LDAP user filter, defaulting to `(objectClass=posixAccount)`.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
turn-uri
|
2020-06-25 09:16:20 +00:00
|
|
|
URI to TURN server, can be provided multiple times if there is more than one
|
|
|
|
|
server.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
turn-shared-secret
|
2020-06-25 09:16:20 +00:00
|
|
|
Shared secret used to access the TURN REST API.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
turn-user-lifetime
|
2020-06-25 09:16:20 +00:00
|
|
|
Lifetime of TURN credentials. Defaults to 1h.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
max-upload-size
|
2020-06-25 09:16:20 +00:00
|
|
|
Maximum size for user-uploaded files. Defaults to 10M.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
rc-message-per-second
|
2020-06-25 09:16:20 +00:00
|
|
|
Message rate-limiting (per second). Defaults to 0.17.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
rc-message-burst
|
2020-06-25 09:16:20 +00:00
|
|
|
Message rate-limiting (burst). Defaults to 3.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
rc-login-per-second
|
2020-06-25 09:16:20 +00:00
|
|
|
Login rate-limiting (per-second). Defaults to 0.17.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
rc-login-burst
|
2020-06-25 09:16:20 +00:00
|
|
|
Login rate-limiting (burst). Defaults to 3.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
branding-auth-header-logo-url
|
2020-06-25 09:16:20 +00:00
|
|
|
A logo that is shown in the header during authentication flows.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
branding-auth-footer-links
|
2020-06-25 09:16:20 +00:00
|
|
|
A list of links to show in the authentication page footer: `[{"text": "Link text", "url": "https://link.target"}, {"text": "Other link", ...}]`
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
registration-allows-email-pattern
|
2020-06-25 09:16:20 +00:00
|
|
|
Only allow email addresses matching specified filter. Can be specified multiple times. A pattern must look like `.*@vector\.im`.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
auto-join-room
|
2020-06-25 09:16:20 +00:00
|
|
|
Room where newly-registered users are automatically added. Can be specified multiple times.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
app-service-config-file
|
2020-06-25 09:16:20 +00:00
|
|
|
Path (on remote) of an application service configuration file to load. Can be specified multiple times.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
extra-setting
|
2020-06-25 09:16:20 +00:00
|
|
|
Arbitrary string to be added to the configuration file. Can be specified multiple times.
|
|
|
|
|
|
|
|
|
|
BOOLEAN PARAMETERS
|
|
|
|
|
------------------
|
2021-02-12 08:58:10 +00:00
|
|
|
allow-registration
|
2020-06-25 09:16:20 +00:00
|
|
|
Enables user registration on the homeserver.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
enable-ldap-auth
|
2020-06-25 09:16:20 +00:00
|
|
|
Enables ldap-backed authentication.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
ldap-search-mode
|
2020-06-25 09:16:20 +00:00
|
|
|
Enables 'search' mode for LDAP auth backend.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
report-stats
|
2020-06-25 09:16:20 +00:00
|
|
|
Whether or not to report anonymized homeserver usage statistics.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
expose-metrics
|
2020-06-25 09:16:20 +00:00
|
|
|
Expose metrics endpoint for Prometheus.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
disable-federation
|
2020-06-25 09:16:20 +00:00
|
|
|
Disable federation to the broader matrix network.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
registration-require-email
|
2020-06-25 09:16:20 +00:00
|
|
|
Make email a required field on registration.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
allow-public-rooms-over-federation
|
2020-06-25 09:16:20 +00:00
|
|
|
Allow other homeservers to fetch this server's public room directory.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
allow-public-rooms-without-auth
|
2020-06-25 09:16:20 +00:00
|
|
|
If set to 'false', requires authentication to access the server's public rooms directory through the client API.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
enable-server-notices
|
2020-06-25 09:16:20 +00:00
|
|
|
Enable the server notices room.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
global-cache-factor
|
2020-06-25 09:16:20 +00:00
|
|
|
Controls the global cache factor, which is the default cache factor
|
|
|
|
|
for all caches if a specific factor for that cache is not otherwise
|
|
|
|
|
set. Defaults to 0.5.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
event-cache-size
|
2020-06-25 09:16:20 +00:00
|
|
|
Number of events to cache in memory. Defaults to 10K.
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
allow-guest-access
|
2020-06-25 09:16:20 +00:00
|
|
|
Allows users to register as guests without a password/email/etc, and
|
|
|
|
|
participate in rooms hosted on this server which have been made accessible to
|
|
|
|
|
anonymous users.
|
|
|
|
|
|
|
|
|
|
EXAMPLES
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
.. code-block:: sh
|
|
|
|
|
|
2021-02-12 08:58:10 +00:00
|
|
|
__matrix_synapse --server-name ungleich.ch \
|
|
|
|
|
--base-url https://matrix.ungleich.ch \
|
|
|
|
|
--database-engine sqlite3 \
|
|
|
|
|
--database-name /var/lib/matrix-syanpse/homeserver.db
|
2020-06-25 09:16:20 +00:00
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
2021-02-12 08:58:10 +00:00
|
|
|
- `cdist-type__matrix_element(7) <cdist-type__matrix_element.html>`_
|
2020-06-25 09:16:20 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
