diff options
author | David Robertson <davidr@element.io> | 2022-10-24 14:03:10 +0100 |
---|---|---|
committer | David Robertson <davidr@element.io> | 2022-10-24 14:12:58 +0100 |
commit | 32e64faffe38d3a1be2994e6fc8cec174ee3ef45 (patch) | |
tree | 512f8632aabd180cb2c94ca32537465d2c495af5 | |
parent | Move config pages into config dir (diff) | |
download | synapse-32e64faffe38d3a1be2994e6fc8cec174ee3ef45.tar.xz |
Move admin docs to admin section (excluding admin api)
-rw-r--r-- | docs/SUMMARY.md | 22 | ||||
-rw-r--r-- | docs/administration/README.md (renamed from docs/usage/administration/README.md) | 0 | ||||
-rw-r--r-- | docs/administration/admin_faq.md (renamed from docs/usage/administration/admin_faq.md) | 10 | ||||
-rw-r--r-- | docs/administration/database_maintenance_tools.md (renamed from docs/usage/administration/database_maintenance_tools.md) | 6 | ||||
-rw-r--r-- | docs/administration/manhole.md (renamed from docs/manhole.md) | 2 | ||||
-rw-r--r-- | docs/administration/metrics-howto.md (renamed from docs/metrics-howto.md) | 2 | ||||
-rw-r--r-- | docs/administration/monthly_active_users.md (renamed from docs/usage/administration/monthly_active_users.md) | 4 | ||||
-rw-r--r-- | docs/administration/reporting_homeserver_usage_statistics.md (renamed from docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md) | 12 | ||||
-rw-r--r-- | docs/administration/request_log.md (renamed from docs/usage/administration/request_log.md) | 0 | ||||
-rw-r--r-- | docs/administration/state_groups.md (renamed from docs/usage/administration/state_groups.md) | 0 | ||||
-rw-r--r-- | docs/administration/understanding_synapse_through_grafana_graphs.md (renamed from docs/usage/administration/understanding_synapse_through_grafana_graphs.md) | 4 | ||||
-rw-r--r-- | docs/administration/useful_sql_for_admins.md (renamed from docs/usage/administration/useful_sql_for_admins.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/config_documentation.md | 16 | ||||
-rw-r--r-- | docs/welcome_and_overview.md | 6 |
14 files changed, 42 insertions, 42 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 048ee80ff5..94c3fdecdc 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -50,7 +50,7 @@ - [Workers](usage/configuration/workers.md) - [Using `synctl` with Workers](usage/configuration/synctl_workers.md) - [Systemd](usage/configuration/systemd-with-workers/README.md) - - [Administration](usage/administration/README.md) + - [Administration](administration/README.md) - [Admin API](usage/administration/admin_api/README.md) - [Account Validity](admin_api/account_validity.md) - [Background Updates](usage/administration/admin_api/background_updates.md) @@ -66,16 +66,16 @@ - [Users](admin_api/user_admin_api.md) - [Server Version](admin_api/version_api.md) - [Federation](usage/administration/admin_api/federation.md) - - [Manhole](manhole.md) - - [Monitoring](metrics-howto.md) - - [Reporting Homeserver Usage Statistics](usage/administration/monitoring/reporting_homeserver_usage_statistics.md) - - [Monthly Active Users](usage/administration/monthly_active_users.md) - - [Understanding Synapse Through Grafana Graphs](usage/administration/understanding_synapse_through_grafana_graphs.md) - - [Useful SQL for Admins](usage/administration/useful_sql_for_admins.md) - - [Database Maintenance Tools](usage/administration/database_maintenance_tools.md) - - [State Groups](usage/administration/state_groups.md) - - [Request log format](usage/administration/request_log.md) - - [Admin FAQ](usage/administration/admin_faq.md) + - [Manhole](administration/manhole.md) + - [Monitoring](administration/metrics-howto.md) + - [Reporting Homeserver Usage Statistics](administration/reporting_homeserver_usage_statistics.md) + - [Monthly Active Users](administration/monthly_active_users.md) + - [Understanding Synapse Through Grafana Graphs](administration/understanding_synapse_through_grafana_graphs.md) + - [Useful SQL for Admins](administration/useful_sql_for_admins.md) + - [Database Maintenance Tools](administration/database_maintenance_tools.md) + - [State Groups](administration/state_groups.md) + - [Request log format](administration/request_log.md) + - [Admin FAQ](administration/admin_faq.md) - [Scripts]() # Development diff --git a/docs/usage/administration/README.md b/docs/administration/README.md index e1e57546ab..e1e57546ab 100644 --- a/docs/usage/administration/README.md +++ b/docs/administration/README.md diff --git a/docs/usage/administration/admin_faq.md b/docs/administration/admin_faq.md index e349a4e34f..4f06f0ac11 100644 --- a/docs/usage/administration/admin_faq.md +++ b/docs/administration/admin_faq.md @@ -2,7 +2,7 @@ How do I become a server admin? --- -If your server already has an admin account you should use the [User Admin API](../../admin_api/user_admin_api.md#Change-whether-a-user-is-a-server-administrator-or-not) to promote other accounts to become admins. +If your server already has an admin account you should use the [User Admin API](../../administration/admin_api/user_admin_api.md#Change-whether-a-user-is-a-server-administrator-or-not) to promote other accounts to become admins. 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. @@ -35,7 +35,7 @@ SELECT NAME from users; Manually resetting passwords --- Users can reset their password through their client. Alternatively, a server admin -can reset a user's password using the [admin API](../../admin_api/user_admin_api.md#reset-password). +can reset a user's password using the [admin API](../../administration/admin_api/user_admin_api.md#reset-password). I have a problem with my server. Can I just delete my database and start again? @@ -101,7 +101,7 @@ ORDER BY num_rows desc LIMIT 10; ``` -You can also use the [List Room API](../../admin_api/rooms.md#list-room-api) +You can also use the [List Room API](../../administration/admin_api/rooms.md#list-room-api) and `order_by` `state_events`. @@ -122,7 +122,7 @@ Help!! Synapse is slow and eats all my RAM/CPU! ----------------------------------------------- First, ensure you are running the latest version of Synapse, using Python 3 -with a [PostgreSQL database](../../setup/postgres.md). +with a [PostgreSQL database](../setup/postgres.md). Synapse's architecture is quite RAM hungry currently - we deliberately cache a lot of recent room data and metadata in RAM in order to speed up @@ -157,7 +157,7 @@ massive excess of outgoing federation requests (see [discussion](https://github. indicate that your server is also issuing far more outgoing federation requests than can be accounted for by your users' activity, this is a likely cause. The misbehavior can be worked around by disabling presence -in the Synapse config file: [see here](../configuration/config_documentation.md#presence). +in the Synapse config file: [see here](../usage/configuration/config_documentation.md#presence). Running out of File Handles diff --git a/docs/usage/administration/database_maintenance_tools.md b/docs/administration/database_maintenance_tools.md index 92b805d413..c6cf0c990e 100644 --- a/docs/usage/administration/database_maintenance_tools.md +++ b/docs/administration/database_maintenance_tools.md @@ -2,13 +2,13 @@ This blog post by Victor Berger explains how to use many of the tools listed on # List of useful tools and scripts for maintenance Synapse database: -## [Purge Remote Media API](../../admin_api/media_admin_api.md#purge-remote-media-api) +## [Purge Remote Media API](../../administration/admin_api/media_admin_api.md#purge-remote-media-api) The purge remote media API allows server admins to purge old cached remote media. -## [Purge Local Media API](../../admin_api/media_admin_api.md#delete-local-media) +## [Purge Local Media API](../../administration/admin_api/media_admin_api.md#delete-local-media) This API deletes the *local* media from the disk of your own server. -## [Purge History API](../../admin_api/purge_history_api.md) +## [Purge History API](../../administration/admin_api/purge_history_api.md) The purge history API allows server admins to purge historic events from their database, reclaiming disk space. ## [synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state) diff --git a/docs/manhole.md b/docs/administration/manhole.md index 4e5bf833ce..1d04fc244c 100644 --- a/docs/manhole.md +++ b/docs/administration/manhole.md @@ -15,7 +15,7 @@ environments where untrusted users have shell access. To enable it, first add the `manhole` listener configuration in your `homeserver.yaml`. You can find information on how to do that -in the [configuration manual](usage/configuration/config_documentation.md#manhole_settings). +in the [configuration manual](../usage/configuration/config_documentation.md#manhole_settings). The configuration is slightly different if you're using docker. #### Docker config diff --git a/docs/metrics-howto.md b/docs/administration/metrics-howto.md index 3d4098ab94..c9156f2783 100644 --- a/docs/metrics-howto.md +++ b/docs/administration/metrics-howto.md @@ -92,7 +92,7 @@ ## Monitoring workers -To monitor a Synapse installation using [workers](usage/configuration/workers.md), +To monitor a Synapse installation using [workers](../usage/configuration/workers.md), every worker needs to be monitored independently, in addition to the main homeserver process. This is because workers don't send their metrics to the main homeserver process, but expose them diff --git a/docs/usage/administration/monthly_active_users.md b/docs/administration/monthly_active_users.md index d4e9037284..c0e233d234 100644 --- a/docs/usage/administration/monthly_active_users.md +++ b/docs/administration/monthly_active_users.md @@ -3,11 +3,11 @@ Synapse can be configured to record the number of monthly active users (also referred to as MAU) on a given homeserver. For clarity's sake, MAU only tracks local users. -Please note that the metrics recorded by the [Homeserver Usage Stats](../../usage/administration/monitoring/reporting_homeserver_usage_statistics.md) +Please note that the metrics recorded by the [Homeserver Usage Stats](reporting_homeserver_usage_statistics.md) are calculated differently. The `monthly_active_users` from the usage stats does not take into account any of the rules below, and counts any users who have made a request to the homeserver in the last 30 days. -See the [configuration manual](../../usage/configuration/config_documentation.md#limit_usage_by_mau) for details on how to configure MAU. +See the [configuration manual](../usage/configuration/config_documentation.md#limit_usage_by_mau) for details on how to configure MAU. ## Calculating active users diff --git a/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md b/docs/administration/reporting_homeserver_usage_statistics.md index 4e53f9883a..7f3b124529 100644 --- a/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md +++ b/docs/administration/reporting_homeserver_usage_statistics.md @@ -6,9 +6,9 @@ provide the foundation a glimpse into the number of Synapse homeservers participating in the network, as well as statistics such as the number of rooms being created and messages being sent. This feature is sometimes affectionately called "phone home" stats. Reporting -[is optional](../../configuration/config_documentation.md#report_stats) +[is optional](../usage/configuration/config_documentation.md#report_stats) and the reporting endpoint -[can be configured](../../configuration/config_documentation.md#report_stats_endpoint), +[can be configured](../usage/configuration/config_documentation.md#report_stats_endpoint), in case you would like to instead report statistics from a set of homeservers to your own infrastructure. @@ -52,15 +52,15 @@ The following statistics are sent to the configured reporting endpoint: | `r30v2_users_ios` | int | The number of 30 day retained users, as defined above. Filtered only to clients with ("riot" or "element") and "ios" (case-insensitive) in the user agent string. | | `r30v2_users_electron` | int | The number of 30 day retained users, as defined above. Filtered only to clients with ("riot" or "element") and "electron" (case-insensitive) in the user agent string. | | `r30v2_users_web` | int | The number of 30 day retained users, as defined above. Filtered only to clients with "mozilla" or "gecko" (case-insensitive) in the user agent string. | -| `cache_factor` | int | The configured [`global factor`](../../configuration/config_documentation.md#caching) value for caching. | -| `event_cache_size` | int | The configured [`event_cache_size`](../../configuration/config_documentation.md#caching) value for caching. | +| `cache_factor` | int | The configured [`global factor`](../usage/configuration/config_documentation.md#caching) value for caching. | +| `event_cache_size` | int | The configured [`event_cache_size`](../usage/configuration/config_documentation.md#caching) value for caching. | | `database_engine` | string | The database engine that is in use. Either "psycopg2" meaning PostgreSQL is in use, or "sqlite3" for SQLite3. | | `database_server_version` | string | The version of the database server. Examples being "10.10" for PostgreSQL server version 10.0, and "3.38.5" for SQLite 3.38.5 installed on the system. | | `log_level` | string | The log level in use. Examples are "INFO", "WARNING", "ERROR", "DEBUG", etc. | [^1]: Native matrix users and guests are always counted. If the -[`track_puppeted_user_ips`](../../configuration/config_documentation.md#track_puppeted_user_ips) +[`track_puppeted_user_ips`](../usage/configuration/config_documentation.md#track_puppeted_user_ips) option is set to `true`, "puppeted" users (users that an Application Service have performed [an action on behalf of](https://spec.matrix.org/v1.3/application-service-api/#identity-assertion)) will also be counted. Note that an Application Service can "puppet" any user in their @@ -71,7 +71,7 @@ will additionally be counted as a user (irrespective of `track_puppeted_user_ips ## Using a Custom Statistics Collection Server If statistics reporting is enabled, the endpoint that Synapse sends metrics to is configured by the -[`report_stats_endpoint`](../../configuration/config_documentation.md#report_stats_endpoint) config +[`report_stats_endpoint`](../usage/configuration/config_documentation.md#report_stats_endpoint) config option. By default, statistics are sent to Matrix.org. If you would like to set up your own statistics collection server and send metrics there, you may diff --git a/docs/usage/administration/request_log.md b/docs/administration/request_log.md index 82f5ac7b96..82f5ac7b96 100644 --- a/docs/usage/administration/request_log.md +++ b/docs/administration/request_log.md diff --git a/docs/usage/administration/state_groups.md b/docs/administration/state_groups.md index f1dee7accf..f1dee7accf 100644 --- a/docs/usage/administration/state_groups.md +++ b/docs/administration/state_groups.md diff --git a/docs/usage/administration/understanding_synapse_through_grafana_graphs.md b/docs/administration/understanding_synapse_through_grafana_graphs.md index 6d6db0ebfe..56d47adf6e 100644 --- a/docs/usage/administration/understanding_synapse_through_grafana_graphs.md +++ b/docs/administration/understanding_synapse_through_grafana_graphs.md @@ -2,7 +2,7 @@ It is possible to monitor much of the internal state of Synapse using [Prometheus](https://prometheus.io) metrics and [Grafana](https://grafana.com/). -A guide for configuring Synapse to provide metrics is available [here](../../metrics-howto.md) +A guide for configuring Synapse to provide metrics is available [here](../../administration/metrics-howto.md) and information on setting up Grafana is [here](https://github.com/matrix-org/synapse/tree/master/contrib/grafana). In this setup, Prometheus will periodically scrape the information Synapse provides and store a record of it over time. Grafana is then used as an interface to query and @@ -79,6 +79,6 @@ indicator of problems, and a symptom of other problems though, so check other gr If you're still having performance problems with your Synapse instance and you've tried everything you can, it may just be a lack of system resources. Consider adding -more CPU and RAM, and make use of [worker mode](../configuration/workers.md) +more CPU and RAM, and make use of [worker mode](../usage/configuration/workers.md) to make use of multiple CPU cores / multiple machines for your homeserver. diff --git a/docs/usage/administration/useful_sql_for_admins.md b/docs/administration/useful_sql_for_admins.md index f3b97f9576..f3b97f9576 100644 --- a/docs/usage/administration/useful_sql_for_admins.md +++ b/docs/administration/useful_sql_for_admins.md diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 9add017ca1..20ed41e16a 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -427,9 +427,9 @@ Sub-options for each listener include: * `type`: the type of listener. Normally `http`, but other valid options are: - * `manhole`: (see the docs [here](../../manhole.md)), + * `manhole`: (see the docs [here](../../administration/manhole.md)), - * `metrics`: (see the docs [here](../../metrics-howto.md)), + * `metrics`: (see the docs [here](../../administration/metrics-howto.md)), * `tls`: set to true to enable TLS for this listener. Will use the TLS key/cert specified in tls_private_key_path / tls_certificate_path. @@ -438,7 +438,7 @@ Sub-options for each listener include: * `request_id_header`: The header extracted from each incoming request that is used as the basis for the request ID. The request ID is used in - [logs](../administration/request_log.md#request-log-format) and tracing to + [logs](../../administration/request_log.md#request-log-format) and tracing to correlate and match up requests. When unset, Synapse will automatically generate sequential request IDs. This option is useful when Synapse is behind a [reverse-proxy](../../setup/reverse_proxy.md). @@ -468,7 +468,7 @@ Valid resource names are: * `media`: the media API (/_matrix/media). -* `metrics`: the metrics interface. See [here](../../metrics-howto.md). +* `metrics`: the metrics interface. See [here](../../administration/metrics-howto.md). * `openid`: OpenID authentication. See [here](user_authentication/single_sign_on/openid.md). @@ -525,7 +525,7 @@ listeners: ### `manhole_settings` Connection settings for the manhole. You can find more information -on the manhole [here](../../manhole.md). Manhole sub-options include: +on the manhole [here](../../administration/manhole.md). Manhole sub-options include: * `username` : the username for the manhole. This defaults to 'matrix'. * `password`: The password for the manhole. This defaults to 'rabbithole'. * `ssh_priv_key_path` and `ssh_pub_key_path`: The private and public SSH key pair used to encrypt the manhole traffic. @@ -602,7 +602,7 @@ server owner wants to limit to the number of monthly active users. When enabled reached the server returns a `ResourceLimitError` with error type `Codes.RESOURCE_LIMIT_EXCEEDED`. Defaults to false. If this is enabled, a value for `max_mau_value` must also be set. -See [Monthly Active Users](../administration/monthly_active_users.md) for details on how to configure MAU. +See [Monthly Active Users](../../administration/monthly_active_users.md) for details on how to configure MAU. Example configuration: ```yaml @@ -1139,7 +1139,7 @@ number of entries that can be stored. * `cache_autotuning` and its sub-options `max_cache_memory_usage`, `target_cache_memory_usage`, and `min_cache_ttl` work in conjunction with each other to maintain a balance between cache memory - usage and cache entry availability. You must be using [jemalloc](../administration/admin_faq.md#help-synapse-is-slow-and-eats-all-my-ramcpu) + usage and cache entry availability. You must be using [jemalloc](../../administration/admin_faq.md#help-synapse-is-slow-and-eats-all-my-ramcpu) to utilize this option, and all three of the options must be specified for this feature to work. This option defaults to off, enable it by providing values for the sub-options listed below. Please note that the feature will not work and may cause unstable behavior (such as excessive emptying of caches or exceptions) if all of the values are not provided. @@ -2498,7 +2498,7 @@ metrics_flags: Whether or not to report homeserver usage statistics. This is originally set when generating the config. Set this option to true or false to change the current behavior. See -[Reporting Homeserver Usage Statistics](../administration/monitoring/reporting_homeserver_usage_statistics.md) +[Reporting Homeserver Usage Statistics](../../administration/reporting_homeserver_usage_statistics.md) for information on what data is reported. Statistics will be reported 5 minutes after Synapse starts, and then every 3 hours diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index 8a92865020..427997bd92 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -17,15 +17,15 @@ This documentation covers topics for **installation**, **configuration** and * Administer your instance using the [Admin API](usage/administration/admin_api/index.html), installing [pluggable - modules](modules/index.html), or by accessing the [manhole](manhole.md). + modules](modules/index.html), or by accessing the [manhole](administration/manhole.md). -* Learn how to [read log lines](usage/administration/request_log.md), configure +* Learn how to [read log lines](administration/request_log.md), configure [logging](usage/configuration/logging_sample_config.md) or set up [structured logging](usage/configuration/structured_logging.md). * Scale Synapse through additional [worker processes](usage/configuration/workers.md). -* Set up [monitoring and metrics](metrics-howto.md) to keep an eye on your +* Set up [monitoring and metrics](administration/metrics-howto.md) to keep an eye on your Synapse instance's performance. ## Developing on Synapse |