mirrors/synapse
mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2025-03-15 12:17:48 +00:00
Code Activity

deploy: 1613857b90

Browse source
This commit is contained in:
anoadragon453 2022-10-04 09:04:16 +00:00
parent 0bced5604c
commit aa8ce525fa
4 changed files with 44 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
develop/print.html
View file

@ -3396,7 +3396,7 @@ be inconvenient in some environments.</p>
option configures Synapse to serve a file at <code>https://&lt;server_name&gt;/.well-known/matrix/server</code>. option configures Synapse to serve a file at <code>https://&lt;server_name&gt;/.well-known/matrix/server</code>.
This will tell other servers to send traffic to port 443 instead.</p> This will tell other servers to send traffic to port 443 instead.</p>
<p>This option currently defaults to false.</p> <p>This option currently defaults to false.</p>
<p>See https://matrix-org.github.io/synapse/latest/delegate.html for more <p>See <a href="usage/configuration/../../delegate.html">Delegation of incoming federation traffic</a> for more
information.</p> information.</p>
<p>Example configuration:</p> <p>Example configuration:</p>
<pre><code class="language-yaml">serve_server_wellknown: true <pre><code class="language-yaml">serve_server_wellknown: true
@ -5723,7 +5723,7 @@ sub-properties:</p>
<li> <li>
<p><code>module</code>: The class name of a custom mapping module. Default is <p><code>module</code>: The class name of a custom mapping module. Default is
<code>synapse.handlers.oidc.JinjaOidcMappingProvider</code>. <code>synapse.handlers.oidc.JinjaOidcMappingProvider</code>.
See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers See <a href="usage/configuration/../../sso_mapping_providers.html#openid-mapping-providers">OpenID Mapping Providers</a>
for information on implementing a custom mapping provider.</p> for information on implementing a custom mapping provider.</p>
</li> </li>
<li> <li>
@ -6160,23 +6160,29 @@ will also not affect rooms created by other servers.</p>
<p>This setting defines options related to the user directory.</p> <p>This setting defines options related to the user directory.</p>
<p>This option has the following sub-options:</p> <p>This option has the following sub-options:</p>
<ul> <ul>
<li><code>enabled</code>: Defines whether users can search the user directory. If false then <li>
empty responses are returned to all queries. Defaults to true.</li> <p><code>enabled</code>: Defines whether users can search the user directory. If false then
<li><code>search_all_users</code>: Defines whether to search all users visible to your HS when searching empty responses are returned to all queries. Defaults to true.</p>
</li>
<li>
<p><code>search_all_users</code>: Defines whether to search all users visible to your HS when searching
the user directory. If false, search results will only contain users the user directory. If false, search results will only contain users
visible in public rooms and users sharing a room with the requester. visible in public rooms and users sharing a room with the requester.
Defaults to false. Defaults to false.</p>
NB. If you set this to true, and the last time the user_directory search <p>NB. If you set this to true, and the last time the user_directory search
indexes were (re)built was before Synapse 1.44, you'll have to indexes were (re)built was before Synapse 1.44, you'll have to
rebuild the indexes in order to search through all known users. rebuild the indexes in order to search through all known users.</p>
These indexes are built the first time Synapse starts; admins can <p>These indexes are built the first time Synapse starts; admins can
manually trigger a rebuild via API following the instructions at manually trigger a rebuild via the API following the instructions
https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run <a href="usage/configuration/../administration/admin_api/background_updates.html#run">for running background updates</a>,
Set to true to return search results containing all known users, even if that set to true to return search results containing all known users, even if that
user does not share a room with the requester.</li> user does not share a room with the requester.</p>
<li><code>prefer_local_users</code>: Defines whether to prefer local users in search query results. </li>
<li>
<p><code>prefer_local_users</code>: Defines whether to prefer local users in search query results.
If set to true, local users are more likely to appear above remote users when searching the If set to true, local users are more likely to appear above remote users when searching the
user directory. Defaults to false.</li> user directory. Defaults to false.</p>
</li>
</ul> </ul>
<p>Example configuration:</p> <p>Example configuration:</p>
<pre><code class="language-yaml">user_directory: <pre><code class="language-yaml">user_directory:

2
develop/searchindex.js
View file

File diff suppressed because one or more lines are too long

2
develop/searchindex.json
View file

File diff suppressed because one or more lines are too long

36
develop/usage/configuration/config_documentation.html
View file

@ -288,7 +288,7 @@ be inconvenient in some environments.</p>
option configures Synapse to serve a file at <code>https://&lt;server_name&gt;/.well-known/matrix/server</code>. option configures Synapse to serve a file at <code>https://&lt;server_name&gt;/.well-known/matrix/server</code>.
This will tell other servers to send traffic to port 443 instead.</p> This will tell other servers to send traffic to port 443 instead.</p>
<p>This option currently defaults to false.</p> <p>This option currently defaults to false.</p>
<p>See https://matrix-org.github.io/synapse/latest/delegate.html for more <p>See <a href="../../delegate.html">Delegation of incoming federation traffic</a> for more
information.</p> information.</p>
<p>Example configuration:</p> <p>Example configuration:</p>
<pre><code class="language-yaml">serve_server_wellknown: true <pre><code class="language-yaml">serve_server_wellknown: true
@ -2615,7 +2615,7 @@ sub-properties:</p>
<li> <li>
<p><code>module</code>: The class name of a custom mapping module. Default is <p><code>module</code>: The class name of a custom mapping module. Default is
<code>synapse.handlers.oidc.JinjaOidcMappingProvider</code>. <code>synapse.handlers.oidc.JinjaOidcMappingProvider</code>.
See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers See <a href="../../sso_mapping_providers.html#openid-mapping-providers">OpenID Mapping Providers</a>
for information on implementing a custom mapping provider.</p> for information on implementing a custom mapping provider.</p>
</li> </li>
<li> <li>
@ -3052,23 +3052,29 @@ will also not affect rooms created by other servers.</p>
<p>This setting defines options related to the user directory.</p> <p>This setting defines options related to the user directory.</p>
<p>This option has the following sub-options:</p> <p>This option has the following sub-options:</p>
<ul> <ul>
<li><code>enabled</code>: Defines whether users can search the user directory. If false then <li>
empty responses are returned to all queries. Defaults to true.</li> <p><code>enabled</code>: Defines whether users can search the user directory. If false then
<li><code>search_all_users</code>: Defines whether to search all users visible to your HS when searching empty responses are returned to all queries. Defaults to true.</p>
</li>
<li>
<p><code>search_all_users</code>: Defines whether to search all users visible to your HS when searching
the user directory. If false, search results will only contain users the user directory. If false, search results will only contain users
visible in public rooms and users sharing a room with the requester. visible in public rooms and users sharing a room with the requester.
Defaults to false. Defaults to false.</p>
NB. If you set this to true, and the last time the user_directory search <p>NB. If you set this to true, and the last time the user_directory search
indexes were (re)built was before Synapse 1.44, you'll have to indexes were (re)built was before Synapse 1.44, you'll have to
rebuild the indexes in order to search through all known users. rebuild the indexes in order to search through all known users.</p>
These indexes are built the first time Synapse starts; admins can <p>These indexes are built the first time Synapse starts; admins can
manually trigger a rebuild via API following the instructions at manually trigger a rebuild via the API following the instructions
https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run <a href="../administration/admin_api/background_updates.html#run">for running background updates</a>,
Set to true to return search results containing all known users, even if that set to true to return search results containing all known users, even if that
user does not share a room with the requester.</li> user does not share a room with the requester.</p>
<li><code>prefer_local_users</code>: Defines whether to prefer local users in search query results. </li>
<li>
<p><code>prefer_local_users</code>: Defines whether to prefer local users in search query results.
If set to true, local users are more likely to appear above remote users when searching the If set to true, local users are more likely to appear above remote users when searching the
user directory. Defaults to false.</li> user directory. Defaults to false.</p>
</li>
</ul> </ul>
<p>Example configuration:</p> <p>Example configuration:</p>
<pre><code class="language-yaml">user_directory: <pre><code class="language-yaml">user_directory: