Skip to content
Snippets Groups Projects
Unverified Commit e938f696 authored by Dirk Klimpel's avatar Dirk Klimpel Committed by GitHub
Browse files

Fix some links in `docs` and `contrib` (#10370)

parent d9b3637e
No related branches found
No related tags found
No related merge requests found
Fix some links in `docs` and `contrib`.
\ No newline at end of file
...@@ -56,7 +56,7 @@ services: ...@@ -56,7 +56,7 @@ services:
- POSTGRES_USER=synapse - POSTGRES_USER=synapse
- POSTGRES_PASSWORD=changeme - POSTGRES_PASSWORD=changeme
# ensure the database gets created correctly # ensure the database gets created correctly
# https://github.com/matrix-org/synapse/blob/master/docs/postgres.md#set-up-database # https://matrix-org.github.io/synapse/latest/postgres.html#set-up-database
- POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=C --lc-ctype=C - POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=C --lc-ctype=C
volumes: volumes:
# You may store the database tables in a local folder.. # You may store the database tables in a local folder..
......
# Using the Synapse Grafana dashboard # Using the Synapse Grafana dashboard
0. Set up Prometheus and Grafana. Out of scope for this readme. Useful documentation about using Grafana with Prometheus: http://docs.grafana.org/features/datasources/prometheus/ 0. Set up Prometheus and Grafana. Out of scope for this readme. Useful documentation about using Grafana with Prometheus: http://docs.grafana.org/features/datasources/prometheus/
1. Have your Prometheus scrape your Synapse. https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md 1. Have your Prometheus scrape your Synapse. https://matrix-org.github.io/synapse/latest/metrics-howto.html
2. Import dashboard into Grafana. Download `synapse.json`. Import it to Grafana and select the correct Prometheus datasource. http://docs.grafana.org/reference/export_import/ 2. Import dashboard into Grafana. Download `synapse.json`. Import it to Grafana and select the correct Prometheus datasource. http://docs.grafana.org/reference/export_import/
3. Set up required recording rules. https://github.com/matrix-org/synapse/tree/master/contrib/prometheus 3. Set up required recording rules. [contrib/prometheus](../prometheus)
...@@ -34,7 +34,7 @@ Add a new job to the main prometheus.yml file: ...@@ -34,7 +34,7 @@ Add a new job to the main prometheus.yml file:
``` ```
An example of a Prometheus configuration with workers can be found in An example of a Prometheus configuration with workers can be found in
[metrics-howto.md](https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md). [metrics-howto.md](https://matrix-org.github.io/synapse/latest/metrics-howto.html).
To use `synapse.rules` add To use `synapse.rules` add
......
...@@ -3,8 +3,9 @@ Purge history API examples ...@@ -3,8 +3,9 @@ Purge history API examples
# `purge_history.sh` # `purge_history.sh`
A bash file, that uses the [purge history API](/docs/admin_api/purge_history_api.rst) to A bash file, that uses the
purge all messages in a list of rooms up to a certain event. You can select a [purge history API](https://matrix-org.github.io/synapse/latest/admin_api/purge_history_api.html)
to purge all messages in a list of rooms up to a certain event. You can select a
timeframe or a number of messages that you want to keep in the room. timeframe or a number of messages that you want to keep in the room.
Just configure the variables DOMAIN, ADMIN, ROOMS_ARRAY and TIME at the top of Just configure the variables DOMAIN, ADMIN, ROOMS_ARRAY and TIME at the top of
...@@ -12,5 +13,6 @@ the script. ...@@ -12,5 +13,6 @@ the script.
# `purge_remote_media.sh` # `purge_remote_media.sh`
A bash file, that uses the [purge history API](/docs/admin_api/purge_history_api.rst) to A bash file, that uses the
purge all old cached remote media. [purge history API](https://matrix-org.github.io/synapse/latest/admin_api/purge_history_api.html)
to purge all old cached remote media.
#!/usr/bin/env bash #!/usr/bin/env bash
# this script will use the api: # this script will use the api:
# https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_history_api.rst # https://matrix-org.github.io/synapse/latest/admin_api/purge_history_api.html
# #
# It will purge all messages in a list of rooms up to a cetrain event # It will purge all messages in a list of rooms up to a cetrain event
......
The documentation for using systemd to manage synapse workers is now part of The documentation for using systemd to manage synapse workers is now part of
the main synapse distribution. See [docs/systemd-with-workers](../../docs/systemd-with-workers). the main synapse distribution. See
[docs/systemd-with-workers](https://matrix-org.github.io/synapse/latest/systemd-with-workers/index.html).
...@@ -15,9 +15,11 @@ contains an example configuration for the `federation_reader` worker. ...@@ -15,9 +15,11 @@ contains an example configuration for the `federation_reader` worker.
## Synapse configuration files ## Synapse configuration files
See [workers.md](../workers.md) for information on how to set up the See [workers.md](../workers.md) for information on how to set up the
configuration files and reverse-proxy correctly. You can find an example worker configuration files and reverse-proxy correctly.
config in the [workers](https://github.com/matrix-org/synapse/tree/develop/docs/systemd-with-workers/workers/) Below is a sample `federation_reader` worker configuration file.
folder. ```yaml
{{#include workers/federation_reader.yaml}}
```
Systemd manages daemonization itself, so ensure that none of the configuration Systemd manages daemonization itself, so ensure that none of the configuration
files set either `daemonize` or `worker_daemonize`. files set either `daemonize` or `worker_daemonize`.
...@@ -72,12 +74,12 @@ systemctl restart matrix-synapse.target ...@@ -72,12 +74,12 @@ systemctl restart matrix-synapse.target
**Optional:** If further hardening is desired, the file **Optional:** If further hardening is desired, the file
`override-hardened.conf` may be copied from `override-hardened.conf` may be copied from
`contrib/systemd/override-hardened.conf` in this repository to the location [contrib/systemd/override-hardened.conf](https://github.com/matrix-org/synapse/tree/develop/contrib/systemd/)
in this repository to the location
`/etc/systemd/system/matrix-synapse.service.d/override-hardened.conf` (the `/etc/systemd/system/matrix-synapse.service.d/override-hardened.conf` (the
directory may have to be created). It enables certain sandboxing features in directory may have to be created). It enables certain sandboxing features in
systemd to further secure the synapse service. You may read the comments to systemd to further secure the synapse service. You may read the comments to
understand what the override file is doing. The same file will need to be copied understand what the override file is doing. The same file will need to be copied to
to
`/etc/systemd/system/matrix-synapse-worker@.service.d/override-hardened-worker.conf` `/etc/systemd/system/matrix-synapse-worker@.service.d/override-hardened-worker.conf`
(this directory may also have to be created) in order to apply the same (this directory may also have to be created) in order to apply the same
hardening options to any worker processes. hardening options to any worker processes.
......
...@@ -11,4 +11,4 @@ a fresh config using Synapse by following the instructions in ...@@ -11,4 +11,4 @@ a fresh config using Synapse by following the instructions in
```yaml ```yaml
{{#include ../../sample_log_config.yaml}} {{#include ../../sample_log_config.yaml}}
``__` ```
\ No newline at end of file \ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment