deploy: 4eb2f4e02b
This commit is contained in:
reivilibre
@@ -215,7 +215,7 @@ the remote server before trying again, in ms. This is <code>0</code> if no furth
|
||||
<li><code>failure_ts</code> - nullable integer - The first time Synapse tried and failed to reach the
|
||||
remote server, in ms. This is <code>null</code> if communication with the remote server has never failed.</li>
|
||||
<li><code>last_successful_stream_ordering</code> - nullable integer - The stream ordering of the most
|
||||
recent successfully-sent <a href="understanding_synapse_through_grafana_graphs.html#federation">PDU</a>
|
||||
recent successfully-sent <a href="../understanding_synapse_through_grafana_graphs.html#federation">PDU</a>
|
||||
to this destination, or <code>null</code> if this information has not been tracked yet.</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -288,7 +288,7 @@ Room objects contain the following fields:
|
||||
<ul>
|
||||
<li><code>room_id</code> - string - The ID of the room.</li>
|
||||
<li><code>stream_ordering</code> - integer - The stream ordering of the most recent
|
||||
successfully-sent <a href="understanding_synapse_through_grafana_graphs.html#federation">PDU</a>
|
||||
successfully-sent <a href="../understanding_synapse_through_grafana_graphs.html#federation">PDU</a>
|
||||
to this destination in this room.</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@@ -151,7 +151,7 @@
|
||||
<p>Many of the API calls in the admin api will require an <code>access_token</code> for a
|
||||
server admin. (Note that a server admin is distinct from a room admin.)</p>
|
||||
<p>An existing user can be marked as a server admin by updating the database directly.</p>
|
||||
<p>Check your <a href="config_documentation.html#database">database settings</a> in the configuration file, connect to the correct database using either <code>psql [database name]</code> (if using PostgreSQL) or <code>sqlite3 path/to/your/database.db</code> (if using SQLite) and elevate the user <code>@foo:bar.com</code> to administrator.</p>
|
||||
<p>Check your <a href="../../configuration/config_documentation.html#database">database settings</a> in the configuration file, connect to the correct database using either <code>psql [database name]</code> (if using PostgreSQL) or <code>sqlite3 path/to/your/database.db</code> (if using SQLite) and elevate the user <code>@foo:bar.com</code> to administrator.</p>
|
||||
<pre><code class="language-sql">UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';
|
||||
</code></pre>
|
||||
<p>A new server admin user can also be created using the <code>register_new_matrix_user</code>
|
||||
@@ -168,10 +168,10 @@ providing the token as either a query parameter or a request header. To add it a
|
||||
<pre><code class="language-sh">curl --header "Authorization: Bearer <access_token>" <the_rest_of_your_API_request>
|
||||
</code></pre>
|
||||
<p>For example, suppose we want to
|
||||
<a href="user_admin_api.html#query-user-account">query the account</a> of the user
|
||||
<a href="../../../admin_api/user_admin_api.html#query-user-account">query the account</a> of the user
|
||||
<code>@foo:bar.com</code>. We need an admin access token (e.g.
|
||||
<code>syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk</code>), and we need to know which port
|
||||
Synapse's <a href="config_documentation.html#listeners"><code>client</code> listener</a> is listening
|
||||
Synapse's <a href="../../configuration/config_documentation.html#listeners"><code>client</code> listener</a> is listening
|
||||
on (e.g. <code>8008</code>). Then we can use the following command to request the account
|
||||
information from the Admin API.</p>
|
||||
<pre><code class="language-sh">curl --header "Authorization: Bearer syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk" -X GET http://127.0.0.1:8008/_synapse/admin/v2/users/@foo:bar.com
|
||||
|
||||
@@ -153,7 +153,7 @@ registration requests, as proposed in
|
||||
and stabilised in version 1.2 of the Matrix specification.
|
||||
To use it, you will need to enable the <code>registration_requires_token</code> config
|
||||
option, and authenticate by providing an <code>access_token</code> for a server admin:
|
||||
see <a href="../admin_api">Admin API</a>.</p>
|
||||
see <a href="../admin_api/">Admin API</a>.</p>
|
||||
<h2 id="registration-token-objects"><a class="header" href="#registration-token-objects">Registration token objects</a></h2>
|
||||
<p>Most endpoints make use of JSON objects that contain details about tokens.
|
||||
These objects have the following fields:</p>
|
||||
|
||||
@@ -148,7 +148,7 @@
|
||||
|
||||
<h2 id="admin-faq"><a class="header" href="#admin-faq">Admin FAQ</a></h2>
|
||||
<h2 id="how-do-i-become-a-server-admin"><a class="header" href="#how-do-i-become-a-server-admin">How do I become a server admin?</a></h2>
|
||||
<p>If your server already has an admin account you should use the <a href="../../admin_api/user_admin_api.html#Change-whether-a-user-is-a-server-administrator-or-not">User Admin API</a> to promote other accounts to become admins.</p>
|
||||
<p>If your server already has an admin account you should use the <a href="../../admin_api/user_admin_api.html#change-whether-a-user-is-a-server-administrator-or-not">User Admin API</a> to promote other accounts to become admins.</p>
|
||||
<p>If you don't have any admin accounts yet you won't be able to use the admin API, so you'll have to edit the database manually. Manually editing the database is generally not recommended so once you have an admin account: use the admin APIs to make further changes.</p>
|
||||
<pre><code class="language-sql">UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';
|
||||
</code></pre>
|
||||
@@ -216,7 +216,7 @@ error (typically along the lines of "Invalid signature"). They might s
|
||||
something like the following in their logs:</p>
|
||||
<pre><code>2019-09-11 19:32:04,271 - synapse.federation.transport.server - 288 - WARNING - GET-11752 - authenticate_request failed: 401: Invalid signature for server <server> with key ed25519:a_EqML: Unable to verify signature for <server>
|
||||
</code></pre>
|
||||
<p>This is normally caused by a misconfiguration in your reverse-proxy. See <a href="docs/reverse_proxy.html">the reverse proxy docs</a> and double-check that your settings are correct.</p>
|
||||
<p>This is normally caused by a misconfiguration in your reverse-proxy. See <a href="../../reverse_proxy.html">the reverse proxy docs</a> and double-check that your settings are correct.</p>
|
||||
<h2 id="help-synapse-is-slow-and-eats-all-my-ramcpu"><a class="header" href="#help-synapse-is-slow-and-eats-all-my-ramcpu">Help!! Synapse is slow and eats all my RAM/CPU!</a></h2>
|
||||
<p>First, ensure you are running the latest version of Synapse, using Python 3
|
||||
with a <a href="../../postgres.html">PostgreSQL database</a>.</p>
|
||||
|
||||
@@ -218,7 +218,7 @@ option. By default, statistics are sent to Matrix.org.</p>
|
||||
consider using one of the following known implementations:</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/matrix-org/panopticon">Matrix.org's Panopticon</a></li>
|
||||
<li><a href="https://gitlab.com/famedly/company/devops/services/barad-dur">Famedly's Barad-dûr</a></li>
|
||||
<li><a href="https://gitlab.com/famedly/infra/services/barad-dur">Famedly's Barad-dûr</a></li>
|
||||
</ul>
|
||||
|
||||
</main>
|
||||
|
||||
@@ -147,7 +147,7 @@
|
||||
</div>
|
||||
|
||||
<h1 id="request-log-format"><a class="header" href="#request-log-format">Request log format</a></h1>
|
||||
<p>HTTP request logs are written by synapse (see <a href="../synapse/http/site.py"><code>site.py</code></a> for details).</p>
|
||||
<p>HTTP request logs are written by synapse (see <a href="https://github.com/matrix-org/synapse/tree/develop/synapse/http/site.py"><code>synapse/http/site.py</code></a> for details).</p>
|
||||
<p>See the following for how to decode the dense data available from the default logging configuration.</p>
|
||||
<pre><code>2020-10-01 12:00:00,000 - synapse.access.http.8008 - 311 - INFO - PUT-1000- 192.168.0.1 - 8008 - {another-matrix-server.com} Processed request: 0.100sec/-0.000sec (0.000sec, 0.000sec) (0.001sec/0.090sec/3) 11B !200 "PUT /_matrix/federation/v1/send/1600000000000 HTTP/1.1" "Synapse/1.20.1" [0 dbevts]
|
||||
-AAAAAAAAAAAAAAAAAAAAA- -BBBBBBBBBBBBBBBBBBBBBB- -C- -DD- -EEEEEE- -FFFFFFFFF- -GG- -HHHHHHHHHHHHHHHHHHHHHHH- -IIIIII- -JJJJJJJ- -KKKKKK-, -LLLLLL- -MMMMMMM- -NNNNNN- O -P- -QQ- -RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR- -SSSSSSSSSSSS- -TTTTTT-
|
||||
|
||||
@@ -1276,7 +1276,7 @@ connection pool. For a reference to valid arguments, see:</p>
|
||||
<ul>
|
||||
<li>for <a href="https://docs.python.org/3/library/sqlite3.html#sqlite3.connect">sqlite</a></li>
|
||||
<li>for <a href="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS">postgres</a></li>
|
||||
<li>for <a href="https://twistedmatrix.com/documents/current/api/twisted.enterprise.adbapi.ConnectionPool.html#__init__">the connection pool</a></li>
|
||||
<li>for <a href="https://docs.twistedmatrix.com/en/stable/api/twisted.enterprise.adbapi.ConnectionPool.html#__init__">the connection pool</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -3545,7 +3545,7 @@ other workers.</p>
|
||||
<hr />
|
||||
<h3 id="worker_daemonize"><a class="header" href="#worker_daemonize"><code>worker_daemonize</code></a></h3>
|
||||
<p>Specifies whether the worker should be started as a daemon process.
|
||||
If Synapse is being managed by <a href="../../systemd-with-workers/README.html">systemd</a>, this option
|
||||
If Synapse is being managed by <a href="../../systemd-with-workers/">systemd</a>, this option
|
||||
must be omitted or set to <code>false</code>.</p>
|
||||
<p>Defaults to <code>false</code>.</p>
|
||||
<p>Example configuration:</p>
|
||||
|
||||
Reference in New Issue
Block a user