mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-22 20:45:48 +00:00
198 lines
10 KiB
Plaintext
198 lines
10 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community
|
|
# members
|
|
# This file is distributed under the same license as the
|
|
# matrix-docker-ansible-deploy package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2024-12-16 12:05+0900\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language: jp\n"
|
|
"Language-Team: jp <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=utf-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
"Generated-By: Babel 2.16.0\n"
|
|
|
|
#: ../../../docs/maintenance-synapse.md:1
|
|
msgid "Synapse maintenance"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:3
|
|
msgid "This document shows you how to perform various maintenance tasks related to the Synapse chat server."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:5
|
|
msgid "Table of contents:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:7
|
|
msgid "[Purging old data with the Purge History API](#purging-old-data-with-the-purge-history-api), for when you wish to delete in-use (but old) data from the Synapse database"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:9
|
|
msgid "[Compressing state with rust-synapse-compress-state](#compressing-state-with-rust-synapse-compress-state)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:11
|
|
msgid "[Browse and manipulate the database](#browse-and-manipulate-the-database), for when you really need to take matters into your own hands"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:13
|
|
msgid "[Make Synapse faster](#make-synapse-faster)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:15
|
|
msgid "Purging old data with the Purge History API"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:17
|
|
msgid "You can use the **[Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md)** to delete old messages on a per-room basis. **This is destructive** (especially for non-federated rooms), because it means **people will no longer have access to history past a certain point**."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:19
|
|
msgid "To make use of this Synapse Admin API, **you'll need an admin access token** first. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:21
|
|
msgid "Synapse's Admin API is not exposed to the internet by default, following [official Synapse reverse-proxying recommendations](https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md#synapse-administration-endpoints). To expose it you will need to add `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true` to your `vars.yml` file."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:23
|
|
msgid "Follow the [Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md) documentation page for the actual purging instructions."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:25
|
|
msgid "After deleting data, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:27
|
|
msgid "Compressing state with rust-synapse-compress-state"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:29
|
|
msgid "[rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state) can be used to optimize some `_state` tables used by Synapse. If your server participates in large rooms this is the most effective way to reduce the size of your database."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:31
|
|
msgid "**Note**: besides running the `rust-synapse-compress-state` tool manually, you can also enable its `synapse-auto-compressor` tool by [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md). The automatic tool will run on a schedule every day and you won't have to compress state manually ever again."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:33
|
|
msgid "`rust-synapse-compress-state` should be safe to use (even when Synapse is running), but it's always a good idea to [make Postgres backups](./maintenance-postgres.md#backing-up-postgresql) first."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:35
|
|
msgid "To ask the playbook to run rust-synapse-compress-state, execute:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:41
|
|
msgid "The shortcut command with `just` program is also available: `just run-tags rust-synapse-compress-state`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:43
|
|
msgid "By default, all rooms with more than `100000` state group rows will be compressed. If you need to adjust this, pass: `--extra-vars='matrix_synapse_rust_synapse_compress_state_min_state_groups_required=SOME_NUMBER_HERE'` to the command above."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:45
|
|
msgid "After state compression, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:47
|
|
msgid "Browse and manipulate the database"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:49
|
|
msgid "When the [Synapse Admin API](https://github.com/element-hq/synapse/tree/master/docs/admin_api) and the other tools do not provide a more convenient way, having a look at synapse's postgresql database can satisfy a lot of admins' needs."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:51
|
|
msgid "Editing the database manually is not recommended or supported by the Synapse developers. If you are going to do so you should [make a database backup](./maintenance-postgres.md#backing-up-postgresql)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:53
|
|
msgid "First, set up an SSH tunnel to your Matrix server (skip if it is your local machine):"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:60
|
|
msgid "Then start up an ephemeral [adminer](https://www.adminer.org/) container on the Matrix server, connecting it to the `matrix` network and linking the postgresql container:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:66
|
|
msgid "You should then be able to browse the adminer database administration GUI at http://localhost:1799/ after entering your DB credentials (found in the `host_vars` or on the server in `{{matrix_synapse_config_dir_path}}/homeserver.yaml` under `database.args`)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:68
|
|
msgid "⚠️️ Be **very careful** with this, there is **no undo** for impromptu DB operations."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:70
|
|
msgid "Make Synapse faster"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:72
|
|
msgid "Synapse's presence feature which tracks which users are online and which are offline can use a lot of processing power. You can disable presence by adding `matrix_synapse_presence_enabled: false` to your `vars.yml` file."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:74
|
|
msgid "If you have enough compute resources (CPU & RAM), you can make Synapse better use of them by [enabling load-balancing with workers](configuring-playbook-synapse.md#load-balancing-with-workers)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:76
|
|
msgid "[Tuning your PostgreSQL database](maintenance-postgres.md#tuning-postgresql) could also improve Synapse performance. The playbook tunes the integrated Postgres database automatically, but based on your needs you may wish to adjust tuning variables manually. If you're using an [external Postgres database](configuring-playbook-external-postgres.md), you will also need to tune Postgres manually."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:78
|
|
msgid "Tuning caches and cache autotuning"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:80
|
|
msgid "Tuning Synapse's cache factor is useful for performance increases but also as part of controlling Synapse's memory use. Use the variable `matrix_synapse_caches_global_factor` to set the cache factor as part of this process."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:82
|
|
msgid "**The playbook defaults the global cache factor to a large value** (e.g. `10`). A smaller value (e.g. `0.5`) will decrease the amount used for caches, but will [not necessarily decrease RAM usage as a whole](https://github.com/matrix-org/synapse/issues/3939)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:84
|
|
msgid "Tuning the cache factor is useful only to a limited degree (as its crude to do in isolation) and therefore users who are tuning their cache factor should likely look into tuning autotune variables as well (see below)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:86
|
|
msgid "Cache autotuning is **enabled by default** and controlled via the following variables:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:88
|
|
msgid "`matrix_synapse_cache_autotuning_max_cache_memory_usage` - defaults to 1/8 of total RAM with a cap of 2GB; values are specified in bytes"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:89
|
|
msgid "`matrix_synapse_cache_autotuning_target_cache_memory_usage` - defaults to 1/16 of total RAM with a cap of 1GB; values are specified in bytes"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:90
|
|
msgid "`matrix_synapse_cache_autotuning_min_cache_ttl` - defaults to `30s`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:92
|
|
msgid "You can **learn more about cache-autotuning and the global cache factor settings** in the [Synapse's documentation on caches and associated values](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caches-and-associated-values)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:94
|
|
msgid "To **disable cache auto-tuning**, unset all values:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:102
|
|
msgid "Users who wish to lower Synapse's RAM footprint should look into lowering the global cache factor and tweaking the autotune variables (or disabling auto-tuning). If your cache factor is too low for a given auto tune setting your caches will not reach autotune thresholds and autotune won't be able to do its job. Therefore, when auto-tuning is enabled (which it is by default), it's recommended to have your cache factor be large."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/maintenance-synapse.md:104
|
|
msgid "See also [How do I optimize this setup for a low-power server?](faq.md#how-do-i-optimize-this-setup-for-a-low-power-server)."
|
|
msgstr ""
|