From 838b869afc275ae26e39ada8b72f78b1f7f5c6dc Mon Sep 17 00:00:00 2001 From: H-Shay Date: Wed, 15 Jun 2022 18:32:22 +0000 Subject: deploy: cba1c5cbc293b2601d81b0cb9b1a28ec6f1e26a1 --- .../usage/configuration/config_documentation.html | 330 ++++++++++----------- 1 file changed, 165 insertions(+), 165 deletions(-) (limited to 'develop/usage/configuration/config_documentation.html') diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html index 0f25b8b561..1739d97c4c 100644 --- a/develop/usage/configuration/config_documentation.html +++ b/develop/usage/configuration/config_documentation.html @@ -207,7 +207,7 @@ is an option that Synapse doesn't recognize and thus ignores.

enabled: false

In this manual, all top-level settings (ones with no indentation) are identified -at the beginning of their section (i.e. "Config option: example_setting") and +at the beginning of their section (i.e. "### example_setting") and the sub-options, if any, are identified and listed in the body of the section. In addition, each setting has an example of its usage, with the proper indentation shown.

@@ -240,7 +240,7 @@ shown.

See here for more documentation on how to configure or create custom modules for Synapse.

-

Config option: modules

+

modules

Use the module sub-option to add modules under this option to extend functionality. The module setting then has a sub-option, config, which can be used to define some configuration for the module.

@@ -257,7 +257,7 @@ for the module.

Server

Define your homeserver name and other base options.

-

Config option: server_name

+

server_name

This sets the public-facing domain of the server.

The server_name name will appear at the end of usernames and room addresses created on your server. For example if the server_name was example.com, @@ -279,19 +279,19 @@ lowercase and may contain an explicit port.

server_name: localhost:8080
-

Config option: pid_file

+

pid_file

When running Synapse as a daemon, the file to store the pid in. Defaults to none.

Example configuration:

pid_file: DATADIR/homeserver.pid
-

Config option: web_client_location

+

web_client_location

The absolute URL to the web client which / will redirect to. Defaults to none.

Example configuration:

web_client_location: https://riot.example.com/
-

Config option: public_baseurl

+

public_baseurl

The public-facing base URL that clients use to access this Homeserver (not including _matrix/...). This is the same URL a user might enter into the 'Custom Homeserver URL' field on their client. If you use Synapse with a @@ -303,7 +303,7 @@ Otherwise, it should be the URL to reach Synapse's client HTTP listener (see 

public_baseurl: https://example.com/
-

Config option: serve_server_wellknown

+

serve_server_wellknown

By default, other servers will try to reach our server on port 8448, which can be inconvenient in some environments.

Provided https://<server_name>/ on port 443 is routed to Synapse, this @@ -316,7 +316,7 @@ information.

serve_server_wellknown: true
-

Config option: soft_file_limit

+

soft_file_limit

Set the soft limit on the number of file descriptors synapse can use. Zero is used to indicate synapse should set the soft limit to the hard limit. Defaults to 0.

@@ -324,7 +324,7 @@ Defaults to 0. 

soft_file_limit: 3
-

Config option: presence

+

presence

Presence tracking allows users to see the state (e.g online/offline) of other local and remote users. Set the enabled sub-option to false to
disable presence tracking on this homeserver. Defaults to true. @@ -334,7 +334,7 @@ This option replaces the previous top-level 'use_presence' option.

enabled: false
-

Config option: require_auth_for_profile_requests

+

require_auth_for_profile_requests

Whether to require authentication to retrieve profile data (avatars, display names) of other users through the client API. Defaults to false. Note that profile data is also available via the federation API, unless allow_profile_lookup_over_federation is set to false.

@@ -342,7 +342,7 @@ via the federation API, unless allow_profile_lookup_over_federation 
require_auth_for_profile_requests: true
-

Config option: limit_profile_requests_to_users_who_share_rooms

+

limit_profile_requests_to_users_who_share_rooms

Use this option to require a user to share a room with another user in order to retrieve their profile information. Only checked on Client-Server requests. Profile requests from other servers should be checked by the @@ -351,7 +351,7 @@ requesting server. Defaults to false.

limit_profile_requests_to_users_who_share_rooms: true
-

Config option: include_profile_data_on_invite

+

include_profile_data_on_invite

Use this option to prevent a user's profile data from being retrieved and displayed in a room until they have joined it. By default, a user's profile data is included in an invite event, regardless of the values @@ -361,7 +361,7 @@ Defaults to true.

include_profile_data_on_invite: false
-

Config option: allow_public_rooms_without_auth

+

allow_public_rooms_without_auth

If set to true, removes the need for authentication to access the server's public rooms directory through the client API, meaning that anyone can query the room directory. Defaults to false.

@@ -369,14 +369,14 @@ query the room directory. Defaults to false.

allow_public_rooms_without_auth: true
-

Config option: allow_public_rooms_without_auth

+

allow_public_rooms_without_auth

If set to true, allows any other homeserver to fetch the server's public rooms directory via federation. Defaults to false.

Example configuration:

allow_public_rooms_over_federation: true
-

Config option: default_room_version

+

default_room_version

The default room version for newly created rooms on this server.

Known room versions are listed here

For example, for room version 1, default_room_version should be set @@ -386,14 +386,14 @@ to "1". 

default_room_version: "8"
-

Config option: gc_thresholds

+

gc_thresholds

The garbage collection threshold parameters to pass to gc.set_threshold, if defined. Defaults to none.

Example configuration:

gc_thresholds: [700, 10, 10]
-

Config option: gc_min_interval

+

gc_min_interval

The minimum time in seconds between each GC for a generation, regardless of the GC thresholds. This ensures that we don't do GC too frequently. A value of [1s, 10s, 30s] indicates that a second must pass between consecutive generation 0 GCs, etc.

@@ -402,28 +402,28 @@ indicates that a second must pass between consecutive generation 0 GCs, etc.

gc_min_interval: [0.5s, 30s, 1m]
-

Config option: filter_timeline_limit

+

filter_timeline_limit

Set the limit on the returned events in the timeline in the get and sync operations. Defaults to 100. A value of -1 means no upper limit.

Example configuration:

filter_timeline_limit: 5000
-

Config option: block_non_admin_invites

+

block_non_admin_invites

Whether room invites to users on this server should be blocked (except those sent by local server admins). Defaults to false.

Example configuration:

block_non_admin_invites: true
-

Config option: enable_search

+

If set to false, new messages will not be indexed for searching and users will receive errors when searching for messages. Defaults to true.

Example configuration:

enable_search: false
-

Config option: ip_range_blacklist

+

ip_range_blacklist

This option prevents outgoing requests from being sent to the specified blacklisted IP address CIDR ranges. If this option is not specified then it defaults to private IP address ranges (see the example below).

@@ -456,7 +456,7 @@ listed here, since they correspond to unroutable addresses.)

- 'fec0::/10'
-

Config option: ip_range_whitelist

+

ip_range_whitelist

List of IP address CIDR ranges that should be allowed for federation, identity servers, push servers, and for checking key validity for third-party invite events. This is useful for specifying exceptions to @@ -469,7 +469,7 @@ list.

- '192.168.1.1'
-

Config option: listeners

+

listeners

List of ports that Synapse should listen on, their purpose and their configuration.

Sub-options for each listener include:

@@ -593,7 +593,7 @@ additional endpoints which should be loaded via dynamic modules.

type: manhole
-

Config option: manhole_settings

+

manhole_settings

Connection settings for the manhole. You can find more information on the manhole here. Manhole sub-options include:

-

Config option: rc_message

+

rc_message

Ratelimiting settings for client messaging.

This is a ratelimiting option for messages that ratelimits sending based on the account the client is using. It defaults to: per_second: 0.2, burst_count: 10.

@@ -1188,7 +1188,7 @@ is using. It defaults to: per_second: 0.2, burst_count: 10
-

Config option: rc_registration

+

rc_registration

This option ratelimits registration requests based on the client's IP address. It defaults to per_second: 0.17, burst_count: 3.

Example configuration:

@@ -1197,7 +1197,7 @@ It defaults to per_second: 0.17, burst_count: 3.

burst_count: 2
-

Config option: rc_registration_token_validity

+

rc_registration_token_validity

This option checks the validity of registration tokens that ratelimits requests based on the client's IP address. Defaults to per_second: 0.1, burst_count: 5.

@@ -1207,7 +1207,7 @@ Defaults to per_second: 0.1, burst_count: 5.

burst_count: 6
-

Config option: rc_login

+

rc_login

This option specifies several limits for login: