xoxys.matrix/templates/opt/matrix/config/homeserver.yml.j2

535 lines
16 KiB
Plaintext
Raw Normal View History

2019-01-19 00:30:45 +00:00
#jinja2: lstrip_blocks: True
2019-08-12 15:17:48 +00:00
{{ ansible_managed | comment }}
2019-01-19 00:30:45 +00:00
## Server ##
2019-08-12 15:17:48 +00:00
# The domain name of the server, with optional explicit port
server_name: "{{ matrix_server_url }}"
2019-01-19 00:30:45 +00:00
# When running as a daemon, the file to store the pid in
pid_file: /var/run/homeserver.pid
# The path to the web client which will be served at /_matrix/client/
# if 'webclient' is configured under the 'listeners' configuration.
2019-08-15 09:24:55 +00:00
# web_client_location: "{{ matrix_web_client_location }}"
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# The public-facing base URL that clients use to access this HS
public_baseurl: "{{ matrix_client_url }}"
2019-01-19 00:30:45 +00:00
# Set to false to disable presence tracking on this homeserver.
2019-08-12 15:17:48 +00:00
use_presence: false
# Whether to require authentication to retrieve profile data (avatars,
# display names) of other users through the client API.
require_auth_for_profile_requests: false
# If set to 'false', requires authentication to access the server's public rooms
# directory through the client API.
allow_public_rooms_without_auth: true
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# If set to 'false', forbids any other homeserver to fetch the server's public
# rooms directory via federation. Defaults to 'true'.
allow_public_rooms_over_federation: true
# The default room version for newly created rooms.
# https://matrix.org/docs/spec/#complete-list-of-room-versions
default_room_version: "4"
2019-01-19 00:30:45 +00:00
# Set the limit on the returned events in the timeline in the get
2019-08-12 15:17:48 +00:00
# and sync operations.
filter_timeline_limit: {{ matrix_filter_timeline_limit }}
2019-01-19 00:30:45 +00:00
# Whether room invites to users on this server should be blocked
2019-08-12 15:17:48 +00:00
# (except those sent by local server admins).
block_non_admin_invites: false
# Room searching
enable_search: true
2019-01-19 00:30:45 +00:00
# Restrict federation to the following whitelist of domains.
2019-08-14 10:17:43 +00:00
# federation_domain_whitelist: []
2019-08-12 15:17:48 +00:00
federation_ip_range_blacklist:
- "127.0.0.0/8"
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
- "100.64.0.0/10"
- "169.254.0.0/16"
- "::1/128"
- "fe80::/64"
- "fc00::/7"
2019-01-19 00:30:45 +00:00
# List of ports that Synapse should listen on, their purpose and their
# configuration.
listeners:
2021-04-03 14:48:40 +00:00
{% if matrix_https_bind_ips is defined and matrix_https_bind_ips | length > 0 %}
2019-08-12 15:17:48 +00:00
# TLS-enabled listener: for when matrix traffic is sent directly to synapse.
2019-01-19 00:30:45 +00:00
- port: {{ matrix_https_bind_port }}
2019-01-21 20:06:06 +00:00
bind_addresses:
2019-08-12 15:38:20 +00:00
{{ matrix_https_bind_ips | to_nice_yaml | indent(6) }}
2019-01-19 00:30:45 +00:00
type: http
2019-08-12 15:24:01 +00:00
{% if matrix_tls_enabled %}
2019-01-19 00:30:45 +00:00
tls: true
2019-08-12 15:24:01 +00:00
{% endif %}
2019-01-19 00:30:45 +00:00
x_forwarded: false
resources:
2019-08-12 15:17:48 +00:00
- names: [client, federation]
2019-01-19 00:30:45 +00:00
compress: false
2021-04-03 14:48:40 +00:00
{% endif %}
{% if matrix_http_bind_ips is defined and matrix_http_bind_ips | length > 0 %}
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy
# that unwraps TLS.
2019-01-19 00:30:45 +00:00
- port: {{ matrix_http_bind_port }}
tls: false
2019-01-21 21:01:50 +00:00
bind_addresses:
2019-08-12 15:38:20 +00:00
{{ matrix_http_bind_ips | to_nice_yaml | indent(6) }}
2019-01-19 00:30:45 +00:00
type: http
2019-08-12 15:17:48 +00:00
x_forwarded: true
2019-01-19 00:30:45 +00:00
resources:
2019-08-12 15:17:48 +00:00
- names: [client, federation]
2019-01-19 00:30:45 +00:00
compress: false
2021-04-03 14:48:40 +00:00
{% endif %}
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
## Homeserver blocking ##
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# How to reach the server admin, used in ResourceLimitError
#
#admin_contact: 'mailto:admin@server.com'
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# Global blocking
2019-01-19 00:30:45 +00:00
#
2019-08-12 15:17:48 +00:00
#hs_disabled: False
#hs_disabled_message: 'Human readable reason for why the HS is blocked'
#hs_disabled_limit_type: 'error code(str), to help clients decode reason'
# Monthly Active User Blocking
2019-01-19 00:30:45 +00:00
#
2019-08-12 15:17:48 +00:00
# Used in cases where the admin or server owner wants to limit to the
# number of monthly active users.
2019-01-19 00:30:45 +00:00
#
2019-08-12 15:17:48 +00:00
# 'limit_usage_by_mau' disables/enables monthly active user blocking. When
# anabled and a limit is reached the server returns a 'ResourceLimitError'
# with error type Codes.RESOURCE_LIMIT_EXCEEDED
2019-01-19 00:30:45 +00:00
#
2019-08-12 15:17:48 +00:00
# 'max_mau_value' is the hard limit of monthly active users above which
# the server will start blocking user actions.
2019-01-19 00:30:45 +00:00
#
2019-08-12 15:17:48 +00:00
# 'mau_trial_days' is a means to add a grace period for active users. It
# means that users must be active for this number of days before they
# can be considered active and guards against the case where lots of users
# sign up in a short space of time never to return after their initial
# session.
2019-01-19 00:30:45 +00:00
#
2019-08-12 15:17:48 +00:00
#limit_usage_by_mau: False
#max_mau_value: 50
#mau_trial_days: 2
2019-01-19 00:30:45 +00:00
# If enabled, the metrics for the number of monthly active users will
# be populated, however no one will be limited. If limit_usage_by_mau
# is true, this is implied to be true.
#
2019-08-12 15:17:48 +00:00
#mau_stats_only: False
2019-01-19 00:30:45 +00:00
# Sometimes the server admin will want to ensure certain accounts are
# never blocked by mau checking. These accounts are specified here.
#
2019-08-12 15:17:48 +00:00
#mau_limit_reserved_threepids:
# - medium: 'email'
# address: 'reserved_user@example.com'
# Used by phonehome stats to group together related servers.
#server_context: context
# Whether to require a user to be in the room to add an alias to it.
# Defaults to 'true'.
2019-08-11 22:32:36 +00:00
#
2019-08-12 15:17:48 +00:00
#require_membership_for_aliases: false
# Whether to allow per-room membership profiles through the send of membership
# events with profile information that differ from the target's global profile.
# Defaults to 'true'.
2019-08-11 22:32:36 +00:00
#
2019-08-12 15:17:48 +00:00
#allow_per_room_profiles: false
2019-08-12 15:24:01 +00:00
{% if matrix_tls_enabled %}
2019-08-12 15:17:48 +00:00
## TLS ##
tls_certificate_path: "{{ matrix_tls_cert_path }}"
tls_private_key_path: "{{ matrix_tls_key_path }}"
tls_dh_params_path: "{{ matrix_tls_dhparam_path }}"
# Whether to verify TLS server certificates for outbound federation requests.
federation_verify_certificates: true
# The minimum TLS version that will be used for outbound federation requests.
federation_client_minimum_tls_version: 1.2
# Skip federation certificate verification on the following whitelist
# of domains.
2019-08-15 09:24:55 +00:00
# federation_certificate_verification_whitelist: []
2019-08-12 15:24:01 +00:00
{% endif %}
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
## Database ##
2019-01-19 00:30:45 +00:00
database:
2019-10-27 14:40:17 +00:00
{% if matrix_db_type == "pgsql" %}
2019-01-19 00:30:45 +00:00
name: psycopg2
2019-01-19 02:14:11 +00:00
args:
2019-10-27 14:40:17 +00:00
user: {{ matrix_db_user }}
password: {{ matrix_db_password }}
dbname: {{ matrix_db_name }}
host: {{ matrix_db_server }}
port: {{ matrix_db_port }}
sslmode: {{ matrix_db_ssl_mode }}
sslrootcert: {{ matrix_db_ssl_root_cert }}
2019-01-19 02:14:11 +00:00
cp_min: 5
cp_max: 10
2019-01-19 00:30:45 +00:00
{% else %}
name: "sqlite3"
args:
database: "{{ matrix_data_dir }}/homeserver.db"
{% endif %}
# Number of events to cache in memory.
event_cache_size: "10K"
2019-08-12 15:17:48 +00:00
## Logging ##
2019-01-19 00:30:45 +00:00
# A yaml python logging config file
2019-01-19 14:06:56 +00:00
log_config: "{{ matrix_conf_dir }}/logging.config"
2019-01-19 00:30:45 +00:00
## Ratelimiting ##
2019-08-12 15:17:48 +00:00
# Ratelimiting settings for client actions (registration, login, messaging).
rc_message:
per_second: 0.2
burst_count: 10
rc_registration:
per_second: 0.17
burst_count: 3
rc_login:
address:
2019-11-06 20:55:41 +00:00
per_second: {{ matrix_rc_login_address.per_second | default(0.17) }}
burst_count: {{ matrix_rc_login_address.burst_count | default(3) }}
2019-08-12 15:17:48 +00:00
account:
2019-11-06 20:55:41 +00:00
per_second: {{ matrix_rc_login_account.per_second | default(0.17) }}
burst_count: {{ matrix_rc_login_account.burst_count | default(3) }}
2019-08-12 15:17:48 +00:00
failed_attempts:
per_second: 0.17
burst_count: 3
# Ratelimiting settings for incoming federation
rc_federation:
window_size: 1000
sleep_limit: 10
sleep_delay: 500
reject_limit: 50
concurrent: 3
2019-01-19 00:30:45 +00:00
# Directory where uploaded images and attachments are stored.
media_store_path: "{{ matrix_data_dir }}/media_store"
# Directory where in-progress uploads are stored.
uploads_path: "{{ matrix_data_dir }}/uploads"
# The largest allowed upload size in bytes
2019-08-12 15:17:48 +00:00
max_upload_size: 10M
2019-01-19 00:30:45 +00:00
# Maximum number of pixels that will be thumbnailed
2019-08-12 15:17:48 +00:00
max_image_pixels: 32M
2019-01-19 00:30:45 +00:00
# Whether to generate new thumbnails on the fly to precisely match
# the resolution requested by the client. If true then whenever
# a new resolution is requested by the client the server will
# generate a new thumbnail. If false the server will pick a thumbnail
# from a precalculated list.
dynamic_thumbnails: false
2019-08-12 15:17:48 +00:00
# List of thumbnails to precalculate when an image is uploaded.
2019-01-19 00:30:45 +00:00
thumbnail_sizes:
2019-08-12 15:17:48 +00:00
- width: 32
height: 32
method: crop
- width: 96
height: 96
method: crop
- width: 320
height: 240
method: scale
- width: 640
height: 480
method: scale
- width: 800
height: 600
method: scale
# Is the preview URL API enabled?
url_preview_enabled: {{ 'true' if matrix_url_preview_enabled else 'false' }}
# List of IP address CIDR ranges that the URL preview spider is denied
# from accessing.
2019-08-11 22:41:13 +00:00
{% if matrix_url_preview_ip_blacklist is defined %}
2019-01-21 20:03:18 +00:00
url_preview_ip_range_blacklist:
2019-08-12 15:38:20 +00:00
{{ matrix_url_preview_ip_blacklist | to_nice_yaml | indent(2) }}
2019-01-21 20:03:18 +00:00
{% endif %}
2019-01-19 00:30:45 +00:00
# List of IP address CIDR ranges that the URL preview spider is allowed
# to access even if they are specified in url_preview_ip_range_blacklist.
2019-08-14 10:17:43 +00:00
# url_preview_ip_range_whitelist: []
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# Optional list of URL matches that the URL preview spider is
# denied from accessing.
2019-01-21 20:03:18 +00:00
{% if matrix_url_preview_url_blacklist is defined %}
url_preview_url_blacklist:
2019-08-12 15:38:20 +00:00
{{ matrix_url_preview_url_blacklist | to_nice_yaml | indent(2) }}
2019-01-21 20:03:18 +00:00
{% endif %}
2019-01-19 00:30:45 +00:00
# The largest allowed URL preview spidering size in bytes
2019-01-21 20:03:18 +00:00
max_spider_size: "{{ matrix_url_preview_max_spider_size }}"
2019-01-19 00:30:45 +00:00
## Captcha ##
2019-08-12 15:17:48 +00:00
enable_registration_captcha: false
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
## TURN ##
2019-01-19 00:30:45 +00:00
# The public URIs of the TURN server to give to clients
2019-08-12 15:17:48 +00:00
#
2019-01-19 00:30:45 +00:00
#turn_uris: []
# The shared secret used to compute passwords for the TURN server
2019-08-12 15:17:48 +00:00
#
2019-01-19 00:30:45 +00:00
#turn_shared_secret: "YOUR_SHARED_SECRET"
# The Username and password if the TURN server needs them and
# does not use a token
2019-08-12 15:17:48 +00:00
#
2019-01-19 00:30:45 +00:00
#turn_username: "TURNSERVER_USERNAME"
#turn_password: "TURNSERVER_PASSWORD"
# How long generated TURN credentials last
2019-08-12 15:17:48 +00:00
#
#turn_user_lifetime: 1h
2019-01-19 00:30:45 +00:00
# Whether guests should be allowed to use the TURN server.
# This defaults to True, otherwise VoIP will be unreliable for guests.
# However, it does introduce a slight security risk as it allows users to
# connect to arbitrary endpoints without having first signed up for a
# valid account (e.g. by passing a CAPTCHA).
2019-08-12 15:17:48 +00:00
#
#turn_allow_guests: True
2019-01-19 00:30:45 +00:00
## Registration ##
2019-08-11 23:27:42 +00:00
# Enable registration for new users.
2019-08-12 15:17:48 +00:00
enable_registration: false
2019-01-19 00:30:45 +00:00
# Set the number of bcrypt rounds used to generate password hash.
# Larger numbers increase the work factor needed to generate the hash.
bcrypt_rounds: 12
# 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.
2019-08-12 15:17:48 +00:00
allow_guest_access: false
2019-01-19 00:30:45 +00:00
# The identity server which we suggest that clients should use when users log
# in on this server.
2019-08-12 15:17:48 +00:00
default_identity_server: https://matrix.org
2019-01-19 00:30:45 +00:00
## Metrics ###
# Enable collection and rendering of performance metrics
enable_metrics: False
2019-08-12 15:17:48 +00:00
# Whether or not to report anonymized homeserver usage statistics.
report_stats: false
2019-01-19 00:30:45 +00:00
## API Configuration ##
2019-08-12 15:17:48 +00:00
# A secret which is used to sign access tokens. If none is specified,
2019-01-19 00:30:45 +00:00
# the registration_shared_secret is used, if one is given; otherwise,
# a secret key is derived from the signing key.
2019-08-12 15:50:21 +00:00
macaroon_secret_key: "{{ matrix_macaroon_secret_key }}"
2019-01-19 00:30:45 +00:00
# Used to enable access token expiration.
2019-08-12 15:17:48 +00:00
#expire_access_token: False
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# A secret which is used to calculate HMACs for form values, to stop
2019-01-19 00:30:45 +00:00
# falsification of values. Must be specified for the User Consent
# forms to work.
2019-08-12 15:50:21 +00:00
form_secret: "{{ matrix_form_secret }}"
2019-01-19 00:30:45 +00:00
## Signing Keys ##
# Path to the signing key to sign messages with
signing_key_path: "{{ matrix_conf_dir }}/{{ matrix_server_url }}.signing.key"
2019-01-19 00:30:45 +00:00
# The keys that the server used to sign messages with but won't use
# to sign new messages. E.g. it has lost its private key
2019-08-12 15:17:48 +00:00
#
#old_signing_keys:
2019-01-19 00:30:45 +00:00
# "ed25519:auto":
# # Base64 encoded public key
# key: "The public part of your old signing key."
# # Millisecond POSIX timestamp when the key expired.
# expired_ts: 123456789123
# How long key response published by this server is valid for.
2019-08-12 15:17:48 +00:00
key_refresh_interval: 1d
2019-01-19 00:30:45 +00:00
# The trusted servers to download signing keys from.
2019-08-12 15:17:48 +00:00
trusted_key_servers:
- server_name: "matrix.org"
2019-08-11 23:27:42 +00:00
2019-01-19 00:30:45 +00:00
password_config:
2019-08-12 15:17:48 +00:00
enabled: true
{% if matrix_ldap_auth_enabled %}
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
password_providers:
- module: "ldap_auth_provider.LdapAuthProvider"
config:
enabled: true
uri: "{{ matrix_ldap_auth_server }}"
start_tls: "{{ matrix_ldap_auth_use_starttls }}"
base: "{{ matrix_ldap_auth_basedn }}"
attributes:
uid: "{{ matrix_ldap_auth_uid_attr }}"
mail: "{{ matrix_ldap_auth_mail_attr }}"
name: "{{ matrix_ldap_auth_name_attr }}"
{% if matrix_ldap_auth_binddn is defined %}
bind_dn: "{{ matrix_ldap_auth_binddn }}"
{% endif %}
{% if matrix_ldap_auth_bind_password is defined %}
bind_password: "{{ matrix_ldap_auth_bind_password }}"
{% endif %}
{% if matrix_ldap_auth_filter is defined %}
filter: "{{ matrix_ldap_auth_filter }}"
{% endif %}
{% endif %}
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
# Enable sending emails for password resets, notification events or
# account expiry notices
2019-01-19 00:30:45 +00:00
#
# If your SMTP server requires authentication, the optional smtp_user &
# smtp_pass variables should be used
#
#email:
# enable_notifs: false
# smtp_host: "localhost"
2019-08-12 15:17:48 +00:00
# smtp_port: 25 # SSL: 465, STARTTLS: 587
2019-01-19 00:30:45 +00:00
# smtp_user: "exampleusername"
# smtp_pass: "examplepassword"
# require_transport_security: False
# notif_from: "Your Friendly %(app)s Home Server <noreply@example.com>"
# app_name: Matrix
2019-08-12 15:17:48 +00:00
#
# # Enable email notifications by default
# #
# notif_for_new_users: True
#
# # Defining a custom URL for Riot is only needed if email notifications
# # should contain links to a self-hosted installation of Riot; when set
# # the "app_name" setting is ignored
# #
# riot_base_url: "http://localhost/riot"
#
# # Enable sending password reset emails via the configured, trusted
# # identity servers
# #
# # IMPORTANT! This will give a malicious or overtaken identity server
# # the ability to reset passwords for your users! Make absolutely sure
# # that you want to do this! It is strongly recommended that password
# # reset emails be sent by the homeserver instead
# #
# # If this option is set to false and SMTP options have not been
# # configured, resetting user passwords via email will be disabled
# #
# #trust_identity_server_for_password_resets: false
#
# # Configure the time that a validation email or text message code
# # will expire after sending
# #
# # This is currently used for password resets
# #
# #validation_token_lifetime: 1h
#
# # Template directory. All template files should be stored within this
# # directory. If not set, default templates from within the Synapse
# # package will be used
# #
# # For the list of default templates, please see
# # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
# #
2019-01-19 00:30:45 +00:00
# #template_dir: res/templates
2019-08-12 15:17:48 +00:00
#
# # Templates for email notifications
# #
2019-01-19 00:30:45 +00:00
# notif_template_html: notif_mail.html
# notif_template_text: notif_mail.txt
2019-08-12 15:17:48 +00:00
#
# # Templates for account expiry notices
# #
# expiry_template_html: notice_expiry.html
# expiry_template_text: notice_expiry.txt
#
# # Templates for password reset emails sent by the homeserver
# #
# #password_reset_template_html: password_reset.html
# #password_reset_template_text: password_reset.txt
#
# # Templates for password reset success and failure pages that a user
# # will see after attempting to reset their password
# #
# #password_reset_template_success_html: password_reset_success.html
# #password_reset_template_failure_html: password_reset_failure.html
2019-01-19 00:30:45 +00:00
# Clients requesting push notifications can either have the body of
# the message sent in the notification poke along with other details
# like the sender, or just the event ID and room ID (`event_id_only`).
# If clients choose the former, this option controls whether the
# notification request includes the content of the event (other details
# like the sender are still included). For `event_id_only` push, it
# has no effect.
2019-08-12 15:17:48 +00:00
#
2019-01-19 00:30:45 +00:00
# For modern android devices the notification content will still appear
# because it is loaded by the app. iPhone, however will send a
# notification saying only that a message arrived and who it came from.
#
#push:
2019-08-12 15:17:48 +00:00
# include_content: true
2019-01-19 00:30:45 +00:00
2019-08-12 15:17:48 +00:00
#spam_checker:
# module: "my_custom_project.SuperSpamChecker"
# config:
# example_option: 'things'
2019-08-11 23:27:42 +00:00
2019-08-12 15:17:48 +00:00
# Uncomment to allow non-server-admin users to create groups on this server
2019-01-19 00:30:45 +00:00
enable_group_creation: false
2019-08-12 15:17:48 +00:00
# Uncomment to disable searching the public room list. When disabled
# blocks searching local and remote room lists for local and remote
# users by always returning an empty list for all queries.
enable_room_list_search: true
2019-01-19 00:30:45 +00:00
# The `alias_creation` option controls who's allowed to create aliases
# on this server.
alias_creation_rules:
2019-08-12 15:17:48 +00:00
- user_id: "*"
alias: "*"
room_id: "*"
action: allow
# The `room_list_publication_rules` option controls who can publish and
# which rooms can be published in the public room list.
room_list_publication_rules:
- user_id: "*"
alias: "*"
room_id: "*"
action: allow
## Opentracing ##
# These settings enable opentracing, which implements distributed tracing.
opentracing:
enabled: false