Skip to content

Commit

Permalink
Fix some links in docs and contrib (matrix-org#10370)
Browse files Browse the repository at this point in the history
  • Loading branch information
dklimpel authored Jul 13, 2021
1 parent d9b3637 commit e938f69
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 17 deletions.
1 change: 1 addition & 0 deletions changelog.d/10370.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix some links in `docs` and `contrib`.
2 changes: 1 addition & 1 deletion contrib/docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ services:
- POSTGRES_USER=synapse
- POSTGRES_PASSWORD=changeme
# 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
volumes:
# You may store the database tables in a local folder..
Expand Down
4 changes: 2 additions & 2 deletions contrib/grafana/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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/
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/
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)
2 changes: 1 addition & 1 deletion contrib/prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[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

Expand Down
10 changes: 6 additions & 4 deletions contrib/purge_api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@ Purge history API examples

# `purge_history.sh`

A bash file, that uses the [purge history API](/docs/admin_api/purge_history_api.rst) to
purge all messages in a list of rooms up to a certain event. You can select a
A bash file, that uses the
[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.

Just configure the variables DOMAIN, ADMIN, ROOMS_ARRAY and TIME at the top of
the script.

# `purge_remote_media.sh`

A bash file, that uses the [purge history API](/docs/admin_api/purge_history_api.rst) to
purge all old cached remote media.
A bash file, that uses the
[purge history API](https://matrix-org.github.io/synapse/latest/admin_api/purge_history_api.html)
to purge all old cached remote media.
2 changes: 1 addition & 1 deletion contrib/purge_api/purge_history.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# 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

Expand Down
3 changes: 2 additions & 1 deletion contrib/systemd-with-workers/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
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).
14 changes: 8 additions & 6 deletions docs/systemd-with-workers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ contains an example configuration for the `federation_reader` worker.
## Synapse configuration files

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
config in the [workers](https://github.com/matrix-org/synapse/tree/develop/docs/systemd-with-workers/workers/)
folder.
configuration files and reverse-proxy correctly.
Below is a sample `federation_reader` worker configuration file.
```yaml
{{#include workers/federation_reader.yaml}}
```

Systemd manages daemonization itself, so ensure that none of the configuration
files set either `daemonize` or `worker_daemonize`.
Expand Down Expand Up @@ -72,12 +74,12 @@ systemctl restart matrix-synapse.target

**Optional:** If further hardening is desired, the file
`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
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
understand what the override file is doing. The same file will need to be copied
to
understand what the override file is doing. The same file will need to be copied to
`/etc/systemd/system/[email protected]/override-hardened-worker.conf`
(this directory may also have to be created) in order to apply the same
hardening options to any worker processes.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/configuration/logging_sample_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ a fresh config using Synapse by following the instructions in

```yaml
{{#include ../../sample_log_config.yaml}}
``__`
```

0 comments on commit e938f69

Please sign in to comment.