MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-05 03:28:24 +01:00
Code Issues Projects Releases Wiki Activity

Update book location

Browse source
This commit is contained in:
Erik Johnston 2023-12-13 16:15:22 +00:00
parent 8613f7693e
commit 0455c40085
43 changed files with 120 additions and 122 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.ci/scripts/check_lockfile.py
View file

@ -17,7 +17,7 @@ except Exception:
"""\ """\
Lockfile is not version 2.0. You probably need to upgrade poetry on your local box Lockfile is not version 2.0. You probably need to upgrade poetry on your local box
and re-run `poetry lock --no-update`. See the Poetry cheat sheet at and re-run `poetry lock --no-update`. See the Poetry cheat sheet at
https://matrix-org.github.io/synapse/develop/development/dependencies.html https://element-hq.github.io/synapse/develop/development/dependencies.html
""" """
) )
raise raise

10
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,14 +1,14 @@
### Pull Request Checklist ### Pull Request Checklist
<!-- Please read https://matrix-org.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request -->
* [ ] Pull request is based on the develop branch * [ ] Pull request is based on the develop branch
* [ ] Pull request includes a [changelog file](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: * [ ] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
- Use markdown where necessary, mostly for `code blocks`. - Use markdown where necessary, mostly for `code blocks`.
- End with either a period (.) or an exclamation mark (!). - End with either a period (.) or an exclamation mark (!).
- Start with a capital letter. - Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
* [ ] Pull request includes a [sign off](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#sign-off) * [ ] Pull request includes a [sign off](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#sign-off)
* [ ] [Code style](https://matrix-org.github.io/synapse/latest/code_style.html) is correct * [ ] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct
(run the [linters](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#run-the-linters)) (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))

2
INSTALL.md
View file

@ -1,7 +1,7 @@
# Installation Instructions # Installation Instructions
This document has moved to the This document has moved to the
[Synapse documentation website](https://matrix-org.github.io/synapse/latest/setup/installation.html). [Synapse documentation website](https://element-hq.github.io/synapse/latest/setup/installation.html).
Please update your links. Please update your links.
The markdown source is available in [docs/setup/installation.md](docs/setup/installation.md). The markdown source is available in [docs/setup/installation.md](docs/setup/installation.md).

38
README.rst
View file

@ -17,17 +17,17 @@ Matrix project <https://matrix.org/docs/guides/introduction>`_, and the `formal
Installing and configuration Installing and configuration
============================ ============================
The Synapse documentation describes `how to install Synapse <https://matrix-org.github.io/synapse/latest/setup/installation.html>`_. We recommend using The Synapse documentation describes `how to install Synapse <https://element-hq.github.io/synapse/latest/setup/installation.html>`_. We recommend using
`Docker images <https://matrix-org.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks>`_ or `Debian packages from Matrix.org `Docker images <https://element-hq.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks>`_ or `Debian packages from Matrix.org
<https://matrix-org.github.io/synapse/latest/setup/installation.html#matrixorg-packages>`_. <https://element-hq.github.io/synapse/latest/setup/installation.html#matrixorg-packages>`_.
.. _federation: .. _federation:
Synapse has a variety of `config options Synapse has a variety of `config options
<https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html>`_ <https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html>`_
which can be used to customise its behaviour after installation. which can be used to customise its behaviour after installation.
There are additional details on how to `configure Synapse for federation here There are additional details on how to `configure Synapse for federation here
<https://matrix-org.github.io/synapse/latest/federate.html>`_. <https://element-hq.github.io/synapse/latest/federate.html>`_.
.. _reverse-proxy: .. _reverse-proxy:
@ -43,7 +43,7 @@ It is recommended to put a reverse proxy such as
doing so is that it means that you can expose the default https port (443) to doing so is that it means that you can expose the default https port (443) to
Matrix clients without needing to run Synapse with root privileges. Matrix clients without needing to run Synapse with root privileges.
For information on configuring one, see `the reverse proxy docs For information on configuring one, see `the reverse proxy docs
<https://matrix-org.github.io/synapse/latest/reverse_proxy.html>`_. <https://element-hq.github.io/synapse/latest/reverse_proxy.html>`_.
Upgrading an existing Synapse Upgrading an existing Synapse
----------------------------- -----------------------------
@ -52,7 +52,7 @@ The instructions for upgrading Synapse are in `the upgrade notes`_.
Please check these instructions as upgrading may require extra steps for some Please check these instructions as upgrading may require extra steps for some
versions of Synapse. versions of Synapse.
.. _the upgrade notes: https://matrix-org.github.io/synapse/develop/upgrade.html .. _the upgrade notes: https://element-hq.github.io/synapse/develop/upgrade.html
Platform dependencies Platform dependencies
@ -60,7 +60,7 @@ Platform dependencies
Synapse uses a number of platform dependencies such as Python and PostgreSQL, Synapse uses a number of platform dependencies such as Python and PostgreSQL,
and aims to follow supported upstream versions. See the and aims to follow supported upstream versions. See the
`deprecation policy <https://matrix-org.github.io/synapse/latest/deprecation_policy.html>`_ `deprecation policy <https://element-hq.github.io/synapse/latest/deprecation_policy.html>`_
for more details. for more details.
@ -114,7 +114,7 @@ from a web client.
Unless you are running a test instance of Synapse on your local machine, in Unless you are running a test instance of Synapse on your local machine, in
general, you will need to enable TLS support before you can successfully general, you will need to enable TLS support before you can successfully
connect from a client: see connect from a client: see
`TLS certificates <https://matrix-org.github.io/synapse/latest/setup/installation.html#tls-certificates>`_. `TLS certificates <https://element-hq.github.io/synapse/latest/setup/installation.html#tls-certificates>`_.
An easy way to get started is to login or register via Element at An easy way to get started is to login or register via Element at
https://app.element.io/#/login or https://app.element.io/#/register respectively. https://app.element.io/#/login or https://app.element.io/#/register respectively.
@ -136,11 +136,11 @@ By default, registration of new users via Matrix clients is disabled. To enable
it: it:
1. In the 1. In the
`registration config section <https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#registration>`_ `registration config section <https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#registration>`_
set ``enable_registration: true`` in ``homeserver.yaml``. set ``enable_registration: true`` in ``homeserver.yaml``.
2. Then **either**: 2. Then **either**:
a. set up a `CAPTCHA <https://matrix-org.github.io/synapse/latest/CAPTCHA_SETUP.html>`_, or a. set up a `CAPTCHA <https://element-hq.github.io/synapse/latest/CAPTCHA_SETUP.html>`_, or
b. set ``enable_registration_without_verification: true`` in ``homeserver.yaml``. b. set ``enable_registration_without_verification: true`` in ``homeserver.yaml``.
We **strongly** recommend using a CAPTCHA, particularly if your homeserver is exposed to We **strongly** recommend using a CAPTCHA, particularly if your homeserver is exposed to
@ -162,9 +162,9 @@ desired ``localpart`` in the 'User name' box.
Troubleshooting and support Troubleshooting and support
=========================== ===========================
The `Admin FAQ <https://matrix-org.github.io/synapse/latest/usage/administration/admin_faq.html>`_ The `Admin FAQ <https://element-hq.github.io/synapse/latest/usage/administration/admin_faq.html>`_
includes tips on dealing with some common problems. For more details, see includes tips on dealing with some common problems. For more details, see
`Synapse's wider documentation <https://matrix-org.github.io/synapse/latest/>`_. `Synapse's wider documentation <https://element-hq.github.io/synapse/latest/>`_.
For additional support installing or managing Synapse, please ask in the community For additional support installing or managing Synapse, please ask in the community
support room |room|_ (from a matrix.org account if necessary). We do not use GitHub support room |room|_ (from a matrix.org account if necessary). We do not use GitHub
@ -211,15 +211,15 @@ Development
We welcome contributions to Synapse from the community! We welcome contributions to Synapse from the community!
The best place to get started is our The best place to get started is our
`guide for contributors <https://matrix-org.github.io/synapse/latest/development/contributing_guide.html>`_. `guide for contributors <https://element-hq.github.io/synapse/latest/development/contributing_guide.html>`_.
This is part of our larger `documentation <https://matrix-org.github.io/synapse/latest>`_, which includes This is part of our larger `documentation <https://element-hq.github.io/synapse/latest>`_, which includes
information for Synapse developers as well as Synapse administrators. information for Synapse developers as well as Synapse administrators.
Developers might be particularly interested in: Developers might be particularly interested in:
* `Synapse's database schema <https://matrix-org.github.io/synapse/latest/development/database_schema.html>`_, * `Synapse's database schema <https://element-hq.github.io/synapse/latest/development/database_schema.html>`_,
* `notes on Synapse's implementation details <https://matrix-org.github.io/synapse/latest/development/internal_documentation/index.html>`_, and * `notes on Synapse's implementation details <https://element-hq.github.io/synapse/latest/development/internal_documentation/index.html>`_, and
* `how we use git <https://matrix-org.github.io/synapse/latest/development/git.html>`_. * `how we use git <https://element-hq.github.io/synapse/latest/development/git.html>`_.
Alongside all that, join our developer community on Matrix: Alongside all that, join our developer community on Matrix:
`#synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>`_, featuring real humans! `#synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>`_, featuring real humans!
@ -235,7 +235,7 @@ Alongside all that, join our developer community on Matrix:
.. |documentation| image:: https://img.shields.io/badge/documentation-%E2%9C%93-success .. |documentation| image:: https://img.shields.io/badge/documentation-%E2%9C%93-success
:alt: (Rendered documentation on GitHub Pages) :alt: (Rendered documentation on GitHub Pages)
:target: https://matrix-org.github.io/synapse/latest/ :target: https://element-hq.github.io/synapse/latest/
.. |license| image:: https://img.shields.io/github/license/element-hq/synapse .. |license| image:: https://img.shields.io/github/license/element-hq/synapse
:alt: (check license in LICENSE file) :alt: (check license in LICENSE file)

2
UPGRADE.rst
View file

@ -1,7 +1,7 @@
Upgrading Synapse Upgrading Synapse
================= =================
This document has moved to the `Synapse documentation website <https://matrix-org.github.io/synapse/latest/upgrade>`_. This document has moved to the `Synapse documentation website <https://element-hq.github.io/synapse/latest/upgrade>`_.
Please update your links. Please update your links.
The markdown source is available in `docs/upgrade.md <docs/upgrade.md>`_. The markdown source is available in `docs/upgrade.md <docs/upgrade.md>`_.

6
contrib/docker/docker-compose.yml
View file

@ -7,8 +7,8 @@ services:
synapse: synapse:
build: build:
context: ../.. context: ../..
dockerfile: docker/Dockerfile dockerfile: docker/Dockerfile
image: docker.io/matrixdotorg/synapse:latest image: docker.io/matrixdotorg/synapse:latest
# Since synapse does not retry to connect to the database, restart upon # Since synapse does not retry to connect to the database, restart upon
# failure # failure
@ -57,7 +57,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://matrix-org.github.io/synapse/latest/postgres.html#set-up-database # https://element-hq.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..

4
contrib/docker_compose_workers/README.md
View file

@ -69,7 +69,7 @@ redis:
host: redis host: redis
port: 6379 port: 6379
# dbid: <redis_logical_db_id> # dbid: <redis_logical_db_id>
# password: <secret_password> # password: <secret_password>
# use_tls: True # use_tls: True
# certificate_file: <path_to_certificate> # certificate_file: <path_to_certificate>
# private_key_file: <path_to_private_key> # private_key_file: <path_to_private_key>
@ -113,4 +113,4 @@ federation_sender_instances:
## Other Worker types ## Other Worker types
Using the concepts shown here it is possible to create other worker types in Docker Compose. See the [Workers](https://matrix-org.github.io/synapse/latest/workers.html#available-worker-applications) documentation for a list of available workers. Using the concepts shown here it is possible to create other worker types in Docker Compose. See the [Workers](https://element-hq.github.io/synapse/latest/workers.html#available-worker-applications) documentation for a list of available workers.

2
contrib/grafana/README.md
View file

@ -1,6 +1,6 @@
# 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://matrix-org.github.io/synapse/latest/metrics-howto.html 1. Have your Prometheus scrape your Synapse. https://element-hq.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. [contrib/prometheus](../prometheus) 3. Set up required recording rules. [contrib/prometheus](../prometheus)

4
contrib/grafana/synapse.json
View file

@ -4253,7 +4253,7 @@
"type": "prometheus", "type": "prometheus",
"uid": "${DS_PROMETHEUS}" "uid": "${DS_PROMETHEUS}"
}, },
"description": "Triangular growth may indicate a problem with federation sending from the remote host --- but it may also be the case that everyone is asleep and no messages are being sent.\n\nSee https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#federation_metrics_domains", "description": "Triangular growth may indicate a problem with federation sending from the remote host --- but it may also be the case that everyone is asleep and no messages are being sent.\n\nSee https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#federation_metrics_domains",
"fieldConfig": { "fieldConfig": {
"defaults": { "defaults": {
"color": { "color": {
@ -4375,7 +4375,7 @@
"type": "prometheus", "type": "prometheus",
"uid": "${DS_PROMETHEUS}" "uid": "${DS_PROMETHEUS}"
}, },
"description": "Triangular growth may indicate a problem with federation senders on the monitored instance---but it may also be the case that everyone is asleep and no messages are being sent.\n\nSee https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#federation_metrics_domains", "description": "Triangular growth may indicate a problem with federation senders on the monitored instance---but it may also be the case that everyone is asleep and no messages are being sent.\n\nSee https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#federation_metrics_domains",
"fieldConfig": { "fieldConfig": {
"defaults": { "defaults": {
"color": { "color": {

10
contrib/lnav/README.md
View file

@ -1,6 +1,6 @@
# `lnav` config for Synapse logs # `lnav` config for Synapse logs
[lnav](https://lnav.org/) is a log-viewing tool. It is particularly useful when [lnav](https://lnav.org/) is a log-viewing tool. It is particularly useful when
you need to interleave multiple log files, or for exploring a large log file you need to interleave multiple log files, or for exploring a large log file
with regex filters. The downside is that it is not as ubiquitous as tools like with regex filters. The downside is that it is not as ubiquitous as tools like
`less`, `grep`, etc. `less`, `grep`, etc.
@ -9,7 +9,7 @@ This directory contains an `lnav` [log format definition](
https://docs.lnav.org/en/v0.10.1/formats.html#defining-a-new-format https://docs.lnav.org/en/v0.10.1/formats.html#defining-a-new-format
) for Synapse logs as ) for Synapse logs as
emitted by Synapse with the default [logging configuration]( emitted by Synapse with the default [logging configuration](
https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#log_config https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#log_config
). It supports lnav 0.10.1 because that's what's packaged by my distribution. ). It supports lnav 0.10.1 because that's what's packaged by my distribution.
This should allow lnav: This should allow lnav:
@ -36,12 +36,12 @@ Within lnav itself:
- `?` for help within lnav itself. - `?` for help within lnav itself.
- `q` to quit. - `q` to quit.
- `/` to search a-la `less` and `vim`, then `n` and `N` to continue searching - `/` to search a-la `less` and `vim`, then `n` and `N` to continue searching
down and up. down and up.
- Use `o` and `O` to skip through logs based on the request ID (`POST-1234`, or - Use `o` and `O` to skip through logs based on the request ID (`POST-1234`, or
else the value of the [`request_id_header`]( else the value of the [`request_id_header`](
https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html?highlight=request_id_header#listeners https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html?highlight=request_id_header#listeners
) header). This may get confused if the same request ID is repeated among ) header). This may get confused if the same request ID is repeated among
multiple files or process restarts. multiple files or process restarts.
- ??? - ???
- Profit - Profit

2
contrib/prometheus/README.md
View 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://matrix-org.github.io/synapse/latest/metrics-howto.html). [metrics-howto.md](https://element-hq.github.io/synapse/latest/metrics-howto.html).
To use `synapse.rules` add To use `synapse.rules` add

6
contrib/purge_api/README.md
View file

@ -4,8 +4,8 @@ Purge history API examples
# `purge_history.sh` # `purge_history.sh`
A bash file, that uses the A bash file, that uses the
[purge history API](https://matrix-org.github.io/synapse/latest/admin_api/purge_history_api.html) [purge history API](https://element-hq.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 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
@ -14,5 +14,5 @@ the script.
# `purge_remote_media.sh` # `purge_remote_media.sh`
A bash file, that uses the A bash file, that uses the
[purge history API](https://matrix-org.github.io/synapse/latest/admin_api/purge_history_api.html) [purge history API](https://element-hq.github.io/synapse/latest/admin_api/purge_history_api.html)
to purge all old cached remote media. to purge all old cached remote media.

14
contrib/purge_api/purge_history.sh
View file

@ -1,8 +1,8 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# this script will use the api: # this script will use the api:
# https://matrix-org.github.io/synapse/latest/admin_api/purge_history_api.html # https://element-hq.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
################################################################################################### ###################################################################################################
@ -77,9 +77,9 @@ TOKEN=$(sql "SELECT token FROM access_tokens WHERE user_id='$ADMIN' ORDER BY id
AUTH="Authorization: Bearer $TOKEN" AUTH="Authorization: Bearer $TOKEN"
################################################################################################### ###################################################################################################
# check, if your TOKEN works. For example this works: # check, if your TOKEN works. For example this works:
################################################################################################### ###################################################################################################
# $ curl --header "$AUTH" "$API_URL/rooms/$ROOM/state/m.room.power_levels" # $ curl --header "$AUTH" "$API_URL/rooms/$ROOM/state/m.room.power_levels"
################################################################################################### ###################################################################################################
# finally start pruning the room: # finally start pruning the room:
@ -117,13 +117,13 @@ for ROOM in "${ROOMS_ARRAY[@]}"; do
sleep $SLEEP sleep $SLEEP
STATUS=$(curl --header "$AUTH" -s GET "$API_URL/admin/purge_history_status/$PURGE_ID" |grep status|cut -d'"' -f4) STATUS=$(curl --header "$AUTH" -s GET "$API_URL/admin/purge_history_status/$PURGE_ID" |grep status|cut -d'"' -f4)
: "$ROOM --> Status: $STATUS" : "$ROOM --> Status: $STATUS"
[[ "$STATUS" == "active" ]] || break [[ "$STATUS" == "active" ]] || break
SLEEP=$((SLEEP + 1)) SLEEP=$((SLEEP + 1))
done done
fi fi
set +x set +x
sleep 1 sleep 1
fi fi
done done

2
contrib/systemd-with-workers/README.md
View file

@ -1,3 +1,3 @@
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 the main synapse distribution. See
[docs/systemd-with-workers](https://matrix-org.github.io/synapse/latest/systemd-with-workers/index.html). [docs/systemd-with-workers](https://element-hq.github.io/synapse/latest/systemd-with-workers/index.html).

10
contrib/systemd/README.md
View file

@ -1,13 +1,13 @@
# Setup Synapse with Systemd # Setup Synapse with Systemd
This is a setup for managing synapse with a user contributed systemd unit This is a setup for managing synapse with a user contributed systemd unit
file. It provides a `matrix-synapse` systemd unit file that should be tailored file. It provides a `matrix-synapse` systemd unit file that should be tailored
to accommodate your installation in accordance with the installation to accommodate your installation in accordance with the installation
instructions provided in instructions provided in
[installation instructions](https://matrix-org.github.io/synapse/latest/setup/installation.html). [installation instructions](https://element-hq.github.io/synapse/latest/setup/installation.html).
## Setup ## Setup
1. Under the service section, ensure the `User` variable matches which user 1. Under the service section, ensure the `User` variable matches which user
you installed synapse under and wish to run it as. you installed synapse under and wish to run it as.
2. Under the service section, ensure the `WorkingDirectory` variable matches 2. Under the service section, ensure the `WorkingDirectory` variable matches
where you have installed synapse. where you have installed synapse.
3. Under the service section, ensure the `ExecStart` variable matches the 3. Under the service section, ensure the `ExecStart` variable matches the

2
docker/README-testing.md
View file

@ -15,7 +15,7 @@ and run Synapse against Complement.
Consult the [contributing guide][guideComplementSh] for instructions on how to use it. Consult the [contributing guide][guideComplementSh] for instructions on how to use it.
[guideComplementSh]: https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#run-the-integration-tests-complement [guideComplementSh]: https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-integration-tests-complement
## Building and running the images manually ## Building and running the images manually

6
docker/README.md
View file

@ -45,7 +45,7 @@ docker run -it --rm \
``` ```
For information on picking a suitable server name, see For information on picking a suitable server name, see
https://matrix-org.github.io/synapse/latest/setup/installation.html. https://element-hq.github.io/synapse/latest/setup/installation.html.
The above command will generate a `homeserver.yaml` in (typically) The above command will generate a `homeserver.yaml` in (typically)
`/var/lib/docker/volumes/synapse-data/_data`. You should check this file, and `/var/lib/docker/volumes/synapse-data/_data`. You should check this file, and
@ -154,7 +154,7 @@ For documentation on using a reverse proxy, see
https://github.com/element.-hq/synapse/blob/master/docs/reverse_proxy.md. https://github.com/element.-hq/synapse/blob/master/docs/reverse_proxy.md.
For more information on enabling TLS support in synapse itself, see For more information on enabling TLS support in synapse itself, see
https://matrix-org.github.io/synapse/latest/setup/installation.html#tls-certificates. Of https://element-hq.github.io/synapse/latest/setup/installation.html#tls-certificates. Of
course, you will need to expose the TLS port from the container with a `-p` course, you will need to expose the TLS port from the container with a `-p`
argument to `docker run`. argument to `docker run`.
@ -242,4 +242,4 @@ healthcheck:
Jemalloc is embedded in the image and will be used instead of the default allocator. Jemalloc is embedded in the image and will be used instead of the default allocator.
You can read about jemalloc by reading the Synapse You can read about jemalloc by reading the Synapse
[Admin FAQ](https://matrix-org.github.io/synapse/latest/usage/administration/admin_faq.html#help-synapse-is-slow-and-eats-all-my-ramcpu). [Admin FAQ](https://element-hq.github.io/synapse/latest/usage/administration/admin_faq.html#help-synapse-is-slow-and-eats-all-my-ramcpu).

5
docs/.sample_config_header.yaml
View file

@ -1,12 +1,11 @@
# This file is maintained as an up-to-date snapshot of the default # This file is maintained as an up-to-date snapshot of the default
# homeserver.yaml configuration generated by Synapse. You can find a # homeserver.yaml configuration generated by Synapse. You can find a
# complete accounting of possible configuration options at # complete accounting of possible configuration options at
# https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html # https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html
# #
# It is *not* intended to be copied and used as the basis for a real # It is *not* intended to be copied and used as the basis for a real
# homeserver.yaml. Instead, if you are starting from scratch, please generate # homeserver.yaml. Instead, if you are starting from scratch, please generate
# a fresh config using Synapse by following the instructions in # a fresh config using Synapse by following the instructions in
# https://matrix-org.github.io/synapse/latest/setup/installation.html. # https://element-hq.github.io/synapse/latest/setup/installation.html.
# #
################################################################################ ################################################################################

8
docs/README.md
View file

@ -1,13 +1,13 @@
# Synapse Documentation # Synapse Documentation
**The documentation is currently hosted [here](https://matrix-org.github.io/synapse).** **The documentation is currently hosted [here](https://element-hq.github.io/synapse).**
Please update any links to point to the new website instead. Please update any links to point to the new website instead.
## About ## About
This directory currently holds a series of markdown files documenting how to install, use This directory currently holds a series of markdown files documenting how to install, use
and develop Synapse. The documentation is readable directly from this repository, but it is and develop Synapse. The documentation is readable directly from this repository, but it is
recommended to instead browse through the [website](https://matrix-org.github.io/synapse) for recommended to instead browse through the [website](https://element-hq.github.io/synapse) for
easier discoverability. easier discoverability.
## Adding to the documentation ## Adding to the documentation
@ -50,7 +50,7 @@ build the documentation with:
mdbook build mdbook build
``` ```
The rendered contents will be outputted to a new `book/` directory at the root of the repository. Please note that The rendered contents will be outputted to a new `book/` directory at the root of the repository. Please note that
index.html is not built by default, it is created by copying over the file `welcome_and_overview.html` to `index.html` index.html is not built by default, it is created by copying over the file `welcome_and_overview.html` to `index.html`
during deployment. Thus, when running `mdbook serve` locally the book will initially show a 404 in place of the index during deployment. Thus, when running `mdbook serve` locally the book will initially show a 404 in place of the index
due to the above. Do not be alarmed! due to the above. Do not be alarmed!

3
docs/admin_api/README.rst
View file

@ -1,7 +1,7 @@
Admin APIs Admin APIs
========== ==========
**Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_. **Note**: The latest documentation can be viewed `here <https://element-hq.github.io/synapse>`_.
See `docs/README.md <../README.md>`_ for more information. See `docs/README.md <../README.md>`_ for more information.
**Please update links to point to the website instead.** Existing files in this directory **Please update links to point to the website instead.** Existing files in this directory
@ -11,4 +11,3 @@ This directory includes documentation for the various synapse specific admin
APIs available. Updates to the existing Admin API documentation should still APIs available. Updates to the existing Admin API documentation should still
be made to these files, but any new documentation files should instead be placed under be made to these files, but any new documentation files should instead be placed under
`docs/usage/administration/admin_api <../usage/administration/admin_api>`_. `docs/usage/administration/admin_api <../usage/administration/admin_api>`_.

2
docs/development/demo.md
View file

@ -2,7 +2,7 @@
**DO NOT USE THESE DEMO SERVERS IN PRODUCTION** **DO NOT USE THESE DEMO SERVERS IN PRODUCTION**
Requires you to have a [Synapse development environment setup](https://matrix-org.github.io/synapse/develop/development/contributing_guide.html#4-install-the-dependencies). Requires you to have a [Synapse development environment setup](https://element-hq.github.io/synapse/develop/development/contributing_guide.html#4-install-the-dependencies).
The demo setup allows running three federation Synapse servers, with server The demo setup allows running three federation Synapse servers, with server
names `localhost:8480`, `localhost:8481`, and `localhost:8482`. names `localhost:8480`, `localhost:8481`, and `localhost:8482`.

4
docs/federate.md
View file

@ -54,7 +54,7 @@ in the HTTP library used by Synapse, 308 redirects are currently not followed by
federating servers, which can cause `M_UNKNOWN` or `401 Unauthorized` errors. This federating servers, which can cause `M_UNKNOWN` or `401 Unauthorized` errors. This
may affect users who are redirecting apex-to-www (e.g. `example.com` -> `www.example.com`), may affect users who are redirecting apex-to-www (e.g. `example.com` -> `www.example.com`),
and especially users of the Kubernetes *Nginx Ingress* module, which uses 308 redirect and especially users of the Kubernetes *Nginx Ingress* module, which uses 308 redirect
codes by default. For those Kubernetes users, [this Stackoverflow post](https://stackoverflow.com/a/52617528/5096871) codes by default. For those Kubernetes users, [this Stackoverflow post](https://stackoverflow.com/a/52617528/5096871)
might be helpful. For other users, switching to a `301 Moved Permanently` code may be might be helpful. For other users, switching to a `301 Moved Permanently` code may be
an option. 308 redirect codes will be supported properly in a future an option. 308 redirect codes will be supported properly in a future
release of Synapse. release of Synapse.
@ -64,4 +64,4 @@ release of Synapse.
If you want to get up and running quickly with a trio of homeservers in a If you want to get up and running quickly with a trio of homeservers in a
private federation, there is a script in the `demo` directory. This is mainly private federation, there is a script in the `demo` directory. This is mainly
useful just for development purposes. See useful just for development purposes. See
[demo scripts](https://matrix-org.github.io/synapse/develop/development/demo.html). [demo scripts](https://element-hq.github.io/synapse/develop/development/demo.html).

4
docs/modules/third_party_rules_callbacks.md
View file

@ -224,7 +224,7 @@ wishing this callback to be called on every profile change are encouraged to dis
per-room profiles globally using the `allow_per_room_profiles` configuration setting in per-room profiles globally using the `allow_per_room_profiles` configuration setting in
Synapse's configuration file. Synapse's configuration file.
This callback is not called when registering a user, even when setting it through the This callback is not called when registering a user, even when setting it through the
[`get_displayname_for_registration`](https://matrix-org.github.io/synapse/latest/modules/password_auth_provider_callbacks.html#get_displayname_for_registration) [`get_displayname_for_registration`](https://element-hq.github.io/synapse/latest/modules/password_auth_provider_callbacks.html#get_displayname_for_registration)
module callback. module callback.
If multiple modules implement this callback, Synapse runs them all in order. If multiple modules implement this callback, Synapse runs them all in order.
@ -343,4 +343,4 @@ class EventCensorer:
) )
event_dict["content"] = new_event_content event_dict["content"] = new_event_content
return event_dict return event_dict
``` ```

2
docs/modules/writing_a_module.md
View file

@ -82,7 +82,7 @@ the callback name as the argument name and the function as its value. A
`register_[...]_callbacks` method exists for each category. `register_[...]_callbacks` method exists for each category.
Callbacks for each category can be found on their respective page of the Callbacks for each category can be found on their respective page of the
[Synapse documentation website](https://matrix-org.github.io/synapse). [Synapse documentation website](https://element-hq.github.io/synapse).
## Caching ## Caching

6
docs/sample_config.yaml
View file

@ -1,12 +1,12 @@
# This file is maintained as an up-to-date snapshot of the default # This file is maintained as an up-to-date snapshot of the default
# homeserver.yaml configuration generated by Synapse. You can find a # homeserver.yaml configuration generated by Synapse. You can find a
# complete accounting of possible configuration options at # complete accounting of possible configuration options at
# https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html # https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html
# #
# It is *not* intended to be copied and used as the basis for a real # It is *not* intended to be copied and used as the basis for a real
# homeserver.yaml. Instead, if you are starting from scratch, please generate # homeserver.yaml. Instead, if you are starting from scratch, please generate
# a fresh config using Synapse by following the instructions in # a fresh config using Synapse by following the instructions in
# https://matrix-org.github.io/synapse/latest/setup/installation.html. # https://element-hq.github.io/synapse/latest/setup/installation.html.
# #
################################################################################ ################################################################################
@ -20,7 +20,7 @@
# #
# For more information on how to configure Synapse, including a complete accounting of # For more information on how to configure Synapse, including a complete accounting of
# each option, go to docs/usage/configuration/config_documentation.md or # each option, go to docs/usage/configuration/config_documentation.md or
# https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html # https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html
server_name: "SERVERNAME" server_name: "SERVERNAME"
pid_file: DATADIR/homeserver.pid pid_file: DATADIR/homeserver.pid
listeners: listeners:

2
docs/sample_log_config.yaml
View file

@ -7,7 +7,7 @@
# be ingested by ELK stacks. See [2] for details. # be ingested by ELK stacks. See [2] for details.
# #
# [1]: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema # [1]: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema
# [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html # [2]: https://element-hq.github.io/synapse/latest/structured_logging.html
version: 1 version: 1

40
docs/upgrade.md
View file

@ -144,9 +144,9 @@ packages or Docker images, no action is required.
As mentioned previously in [Upgrading to v1.84.0](#upgrading-to-v1840), the following deprecated settings As mentioned previously in [Upgrading to v1.84.0](#upgrading-to-v1840), the following deprecated settings
are being removed in this release of Synapse: are being removed in this release of Synapse:
* [`worker_replication_host`](https://matrix-org.github.io/synapse/v1.86/usage/configuration/config_documentation.html#worker_replication_host) * [`worker_replication_host`](https://element-hq.github.io/synapse/v1.86/usage/configuration/config_documentation.html#worker_replication_host)
* [`worker_replication_http_port`](https://matrix-org.github.io/synapse/v1.86/usage/configuration/config_documentation.html#worker_replication_http_port) * [`worker_replication_http_port`](https://element-hq.github.io/synapse/v1.86/usage/configuration/config_documentation.html#worker_replication_http_port)
* [`worker_replication_http_tls`](https://matrix-org.github.io/synapse/v1.86/usage/configuration/config_documentation.html#worker_replication_http_tls) * [`worker_replication_http_tls`](https://element-hq.github.io/synapse/v1.86/usage/configuration/config_documentation.html#worker_replication_http_tls)
Please ensure that you have migrated to using `main` on your shared configuration's `instance_map` Please ensure that you have migrated to using `main` on your shared configuration's `instance_map`
(or create one if necessary). This is required if you have ***any*** workers at all; (or create one if necessary). This is required if you have ***any*** workers at all;
@ -499,7 +499,7 @@ the names of Prometheus metrics.
If you want to test your changes before legacy names are disabled by default, If you want to test your changes before legacy names are disabled by default,
you may specify `enable_legacy_metrics: false` in your homeserver configuration. you may specify `enable_legacy_metrics: false` in your homeserver configuration.
A list of affected metrics is available on the [Metrics How-to page](https://matrix-org.github.io/synapse/v1.69/metrics-howto.html?highlight=metrics%20deprecated#renaming-of-metrics--deprecation-of-old-names-in-12). A list of affected metrics is available on the [Metrics How-to page](https://element-hq.github.io/synapse/v1.69/metrics-howto.html?highlight=metrics%20deprecated#renaming-of-metrics--deprecation-of-old-names-in-12).
## Deprecation of the `generate_short_term_login_token` module API method ## Deprecation of the `generate_short_term_login_token` module API method
@ -556,7 +556,7 @@ are not affected.
Building from a source checkout of Synapse now requires a recent Rust compiler Building from a source checkout of Synapse now requires a recent Rust compiler
(currently Rust 1.58.1, but see also the (currently Rust 1.58.1, but see also the
[Platform Dependency Policy](https://matrix-org.github.io/synapse/latest/deprecation_policy.html)). [Platform Dependency Policy](https://element-hq.github.io/synapse/latest/deprecation_policy.html)).
Installations using Installations using
@ -626,7 +626,7 @@ homeserver administrators more notice of the change.
To continue to allow users to add email addresses to their homeserver accounts, To continue to allow users to add email addresses to their homeserver accounts,
and perform password resets, make sure that Synapse is configured with a working and perform password resets, make sure that Synapse is configured with a working
email server in the [`email` configuration email server in the [`email` configuration
section](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#email) section](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#email)
(including, at a minimum, a `notif_from` setting.) (including, at a minimum, a `notif_from` setting.)
Specifying an `email` setting under `account_threepid_delegates` will now cause Specifying an `email` setting under `account_threepid_delegates` will now cause
@ -639,7 +639,7 @@ an error at startup.
Synapse v1.66.0 will remove the ability to delegate the tasks of verifying email address ownership, and password reset confirmation, to an identity server. Synapse v1.66.0 will remove the ability to delegate the tasks of verifying email address ownership, and password reset confirmation, to an identity server.
If you require your homeserver to verify e-mail addresses or to support password resets via e-mail, please configure your homeserver with SMTP access so that it can send e-mails on its own behalf. If you require your homeserver to verify e-mail addresses or to support password resets via e-mail, please configure your homeserver with SMTP access so that it can send e-mails on its own behalf.
[Consult the configuration documentation for more information.](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#email) [Consult the configuration documentation for more information.](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#email)
The option that will be removed is `account_threepid_delegates.email`. The option that will be removed is `account_threepid_delegates.email`.
@ -849,7 +849,7 @@ The names of user devices are no longer visible to users on other homeservers by
Device IDs are unaffected, as these are necessary to facilitate end-to-end encryption. Device IDs are unaffected, as these are necessary to facilitate end-to-end encryption.
To re-enable this functionality, set the To re-enable this functionality, set the
[`allow_device_name_lookup_over_federation`](https://matrix-org.github.io/synapse/v1.59/usage/configuration/config_documentation.html#federation) [`allow_device_name_lookup_over_federation`](https://element-hq.github.io/synapse/v1.59/usage/configuration/config_documentation.html#federation)
homeserver config option to `true`. homeserver config option to `true`.
@ -968,7 +968,7 @@ experimental_features:
Synapse now refuses to start when using PostgreSQL with non-`C` values for `COLLATE` and Synapse now refuses to start when using PostgreSQL with non-`C` values for `COLLATE` and
`CTYPE` unless the config flag `allow_unsafe_locale`, found in the database section of `CTYPE` unless the config flag `allow_unsafe_locale`, found in the database section of
the configuration file, is set to `true`. See the [PostgreSQL documentation](https://matrix-org.github.io/synapse/latest/postgres.html#fixing-incorrect-collate-or-ctype) the configuration file, is set to `true`. See the [PostgreSQL documentation](https://element-hq.github.io/synapse/latest/postgres.html#fixing-incorrect-collate-or-ctype)
for more information and instructions on how to fix a database with incorrect values. for more information and instructions on how to fix a database with incorrect values.
# Upgrading to v1.55.0 # Upgrading to v1.55.0
@ -1007,7 +1007,7 @@ please upgrade Mjolnir to version 1.3.2 or later before upgrading Synapse.
This release removes support for the `structured: true` logging configuration This release removes support for the `structured: true` logging configuration
which was deprecated in Synapse v1.23.0. If your logging configuration contains which was deprecated in Synapse v1.23.0. If your logging configuration contains
`structured: true` then it should be modified based on the `structured: true` then it should be modified based on the
[structured logging documentation](https://matrix-org.github.io/synapse/v1.56/structured_logging.html#upgrading-from-legacy-structured-logging-configuration). [structured logging documentation](https://element-hq.github.io/synapse/v1.56/structured_logging.html#upgrading-from-legacy-structured-logging-configuration).
# Upgrading to v1.53.0 # Upgrading to v1.53.0
@ -1067,10 +1067,10 @@ are now active by default.
As announced with the release of [Synapse 1.47.0](#deprecation-of-the-user_may_create_room_with_invites-module-callback), As announced with the release of [Synapse 1.47.0](#deprecation-of-the-user_may_create_room_with_invites-module-callback),
the deprecated `user_may_create_room_with_invites` module callback has been removed. the deprecated `user_may_create_room_with_invites` module callback has been removed.
Modules relying on it can instead implement [`user_may_invite`](https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite) Modules relying on it can instead implement [`user_may_invite`](https://element-hq.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite)
and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876) and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
module API to infer whether the invite is happening while creating a room (see [this function](https://github.com/matrix-org/synapse-domain-rule-checker/blob/e7d092dd9f2a7f844928771dbfd9fd24c2332e48/synapse_domain_rule_checker/__init__.py#L56-L89) module API to infer whether the invite is happening while creating a room (see [this function](https://github.com/matrix-org/synapse-domain-rule-checker/blob/e7d092dd9f2a7f844928771dbfd9fd24c2332e48/synapse_domain_rule_checker/__init__.py#L56-L89)
as an example). Alternately, modules can also implement [`on_create_room`](https://matrix-org.github.io/synapse/latest/modules/third_party_rules_callbacks.html#on_create_room). as an example). Alternately, modules can also implement [`on_create_room`](https://element-hq.github.io/synapse/latest/modules/third_party_rules_callbacks.html#on_create_room).
# Upgrading to v1.52.0 # Upgrading to v1.52.0
@ -1117,13 +1117,13 @@ The following admin APIs were deprecated in [Synapse 1.34](https://github.com/ma
- `POST /_synapse/admin/v1/<room_id>/delete` - `POST /_synapse/admin/v1/<room_id>/delete`
Any scripts still using the above APIs should be converted to use the Any scripts still using the above APIs should be converted to use the
[Delete Room API](https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#delete-room-api). [Delete Room API](https://element-hq.github.io/synapse/latest/admin_api/rooms.html#delete-room-api).
## Deprecation of the `user_may_create_room_with_invites` module callback ## Deprecation of the `user_may_create_room_with_invites` module callback
The `user_may_create_room_with_invites` is deprecated and will be removed in a future The `user_may_create_room_with_invites` is deprecated and will be removed in a future
version of Synapse. Modules implementing this callback can instead implement version of Synapse. Modules implementing this callback can instead implement
[`user_may_invite`](https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite) [`user_may_invite`](https://element-hq.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite)
and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876) and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
module API method to infer whether the invite is happening in the context of creating a module API method to infer whether the invite is happening in the context of creating a
room. room.
@ -1150,7 +1150,7 @@ deleted from any configured storage providers to reclaim space.
## The spaces summary APIs can now be handled by workers ## The spaces summary APIs can now be handled by workers
The [available worker applications documentation](https://matrix-org.github.io/synapse/latest/workers.html#available-worker-applications) The [available worker applications documentation](https://element-hq.github.io/synapse/latest/workers.html#available-worker-applications)
has been updated to reflect that calls to the `/spaces`, `/hierarchy`, and has been updated to reflect that calls to the `/spaces`, `/hierarchy`, and
`/summary` endpoints can now be routed to workers for both client API and `/summary` endpoints can now be routed to workers for both client API and
federation requests. federation requests.
@ -1166,7 +1166,7 @@ The following admin APIs were deprecated in [Synapse 1.25](https://github.com/ma
- `POST /_synapse/admin/v1/shutdown_room/<room_id>` - `POST /_synapse/admin/v1/shutdown_room/<room_id>`
Any scripts still using the above APIs should be converted to use the Any scripts still using the above APIs should be converted to use the
[Delete Room API](https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#delete-room-api). [Delete Room API](https://element-hq.github.io/synapse/latest/admin_api/rooms.html#delete-room-api).
## User-interactive authentication fallback templates can now display errors ## User-interactive authentication fallback templates can now display errors
@ -1214,14 +1214,14 @@ The `template_dir` settings in the `sso`, `account_validity` and `email` section
configuration file are now deprecated. Server admins should use the new configuration file are now deprecated. Server admins should use the new
`templates.custom_template_directory` setting in the configuration file and use one single `templates.custom_template_directory` setting in the configuration file and use one single
custom template directory for all aforementioned features. Template file names remain custom template directory for all aforementioned features. Template file names remain
unchanged. See [the related documentation](https://matrix-org.github.io/synapse/latest/templates.html) unchanged. See [the related documentation](https://element-hq.github.io/synapse/latest/templates.html)
for more information and examples. for more information and examples.
We plan to remove support for these settings in October 2021. We plan to remove support for these settings in October 2021.
## `/_synapse/admin/v1/users/{userId}/media` must be handled by media workers ## `/_synapse/admin/v1/users/{userId}/media` must be handled by media workers
The [media repository worker documentation](https://matrix-org.github.io/synapse/latest/workers.html#synapseappmedia_repository) The [media repository worker documentation](https://element-hq.github.io/synapse/latest/workers.html#synapseappmedia_repository)
has been updated to reflect that calls to `/_synapse/admin/v1/users/{userId}/media` has been updated to reflect that calls to `/_synapse/admin/v1/users/{userId}/media`
must now be handled by media repository workers. This is due to the new `DELETE` method must now be handled by media repository workers. This is due to the new `DELETE` method
of this endpoint modifying the media store. of this endpoint modifying the media store.
@ -1624,7 +1624,7 @@ lock down external access to the Admin API endpoints.
This release deprecates use of the `structured: true` logging This release deprecates use of the `structured: true` logging
configuration for structured logging. If your logging configuration configuration for structured logging. If your logging configuration
contains `structured: true` then it should be modified based on the contains `structured: true` then it should be modified based on the
[structured logging documentation](https://matrix-org.github.io/synapse/v1.56/structured_logging.html#upgrading-from-legacy-structured-logging-configuration). [structured logging documentation](https://element-hq.github.io/synapse/v1.56/structured_logging.html#upgrading-from-legacy-structured-logging-configuration).
The `structured` and `drains` logging options are now deprecated and The `structured` and `drains` logging options are now deprecated and
should be replaced by standard logging configuration of `handlers` and should be replaced by standard logging configuration of `handlers` and
@ -1724,7 +1724,7 @@ updated.
When setting up worker processes, we now recommend the use of a Redis When setting up worker processes, we now recommend the use of a Redis
server for replication. **The old direct TCP connection method is server for replication. **The old direct TCP connection method is
deprecated and will be removed in a future release.** See deprecated and will be removed in a future release.** See
the [worker documentation](https://matrix-org.github.io/synapse/v1.66/workers.html) for more details. the [worker documentation](https://element-hq.github.io/synapse/v1.66/workers.html) for more details.
# Upgrading to v1.14.0 # Upgrading to v1.14.0

2
docs/usage/administration/request_log.md
View file

@ -19,7 +19,7 @@ See the following for how to decode the dense data available from the default lo
| EEEE | Request Identifier (This identifier is shared by related log lines)| | EEEE | Request Identifier (This identifier is shared by related log lines)|
| FFFF | Source IP (Or X-Forwarded-For if enabled) | | FFFF | Source IP (Or X-Forwarded-For if enabled) |
| GGGG | Server Port | | GGGG | Server Port |
| HHHH | Federated Server or Local User making request (blank if unauthenticated or not supplied).<br/>If this is of the form `@aaa:example.com|@bbb:example.com`, then that means that `@aaa:example.com` is authenticated but they are controlling `@bbb:example.com`, e.g. if `aaa` is controlling `bbb` [via the admin API](https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#login-as-a-user). | | HHHH | Federated Server or Local User making request (blank if unauthenticated or not supplied).<br/>If this is of the form `@aaa:example.com|@bbb:example.com`, then that means that `@aaa:example.com` is authenticated but they are controlling `@bbb:example.com`, e.g. if `aaa` is controlling `bbb` [via the admin API](https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#login-as-a-user). |
| IIII | Total Time to process the request | | IIII | Total Time to process the request |
| JJJJ | Time to send response over network once generated (this may be negative if the socket is closed before the response is generated)| | JJJJ | Time to send response over network once generated (this may be negative if the socket is closed before the response is generated)|
| KKKK | Userland CPU time | | KKKK | Userland CPU time |

4
docs/usage/configuration/config_documentation.md
View file

@ -549,7 +549,7 @@ listeners:
# that unwraps TLS. # that unwraps TLS.
# #
# If you plan to use a reverse proxy, please see # If you plan to use a reverse proxy, please see
# https://matrix-org.github.io/synapse/latest/reverse_proxy.html. # https://element-hq.github.io/synapse/latest/reverse_proxy.html.
# #
- port: 8008 - port: 8008
tls: false tls: false
@ -581,7 +581,7 @@ listeners:
# conflicts, and providing enhanced security through system file permissions. # conflicts, and providing enhanced security through system file permissions.
# #
# Note that x_forwarded will default to true, when using a UNIX socket. Please see # Note that x_forwarded will default to true, when using a UNIX socket. Please see
# https://matrix-org.github.io/synapse/latest/reverse_proxy.html. # https://element-hq.github.io/synapse/latest/reverse_proxy.html.
# #
- path: /run/synapse/main_public.sock - path: /run/synapse/main_public.sock
type: http type: http

4
scripts-dev/check-newsfragment.sh
View file

@ -19,7 +19,7 @@ if ! git diff --quiet FETCH_HEAD... -- debian; then
if git diff --quiet FETCH_HEAD... -- debian/changelog; then if git diff --quiet FETCH_HEAD... -- debian/changelog; then
echo "Updates to debian directory, but no update to the changelog." >&2 echo "Updates to debian directory, but no update to the changelog." >&2
echo "!! Please see the contributing guide for help writing your changelog entry:" >&2 echo "!! Please see the contributing guide for help writing your changelog entry:" >&2
echo "https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#debian-changelog" >&2 echo "https://element-hq.github.io/synapse/latest/development/contributing_guide.html#debian-changelog" >&2
exit 1 exit 1
fi fi
fi fi
@ -32,7 +32,7 @@ fi
# Print a link to the contributing guide if the user makes a mistake # Print a link to the contributing guide if the user makes a mistake
CONTRIBUTING_GUIDE_TEXT="!! Please see the contributing guide for help writing your changelog entry: CONTRIBUTING_GUIDE_TEXT="!! Please see the contributing guide for help writing your changelog entry:
https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#changelog" https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog"
# If check-newsfragment returns a non-zero exit code, print the contributing guide and exit # If check-newsfragment returns a non-zero exit code, print the contributing guide and exit
python -m towncrier.check --compare-with=origin/develop || (echo -e "$CONTRIBUTING_GUIDE_TEXT" >&2 && exit 1) python -m towncrier.check --compare-with=origin/develop || (echo -e "$CONTRIBUTING_GUIDE_TEXT" >&2 && exit 1)

2
synapse/config/_base.py
View file

@ -132,7 +132,7 @@ CONFIG_FILE_HEADER = """\
# #
# For more information on how to configure Synapse, including a complete accounting of # For more information on how to configure Synapse, including a complete accounting of
# each option, go to docs/usage/configuration/config_documentation.md or # each option, go to docs/usage/configuration/config_documentation.md or
# https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html # https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html
""" """

2
synapse/config/account_validity.py
View file

@ -30,7 +30,7 @@ This server's configuration file is using the deprecated 'template_dir' setting
'account_validity' section. Support for this setting has been deprecated and will be 'account_validity' section. Support for this setting has been deprecated and will be
removed in a future version of Synapse. Server admins should instead use the new removed in a future version of Synapse. Server admins should instead use the new
'custom_template_directory' setting documented here: 'custom_template_directory' setting documented here:
https://matrix-org.github.io/synapse/latest/templates.html https://element-hq.github.io/synapse/latest/templates.html
---------------------------------------------------------------------------------------""" ---------------------------------------------------------------------------------------"""

2
synapse/config/api.py
View file

@ -79,7 +79,7 @@ _ROOM_INVITE_STATE_TYPES_WARNING = """\
WARNING: The 'room_invite_state_types' configuration setting is now deprecated, WARNING: The 'room_invite_state_types' configuration setting is now deprecated,
and replaced with 'room_prejoin_state'. New features may not work correctly and replaced with 'room_prejoin_state'. New features may not work correctly
unless 'room_invite_state_types' is removed. See the config documentation at unless 'room_invite_state_types' is removed. See the config documentation at
https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#room_prejoin_state https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#room_prejoin_state
for details of 'room_prejoin_state'. for details of 'room_prejoin_state'.
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
""" """

2
synapse/config/emailconfig.py
View file

@ -57,7 +57,7 @@ This server's configuration file is using the deprecated 'template_dir' setting
'email' section. Support for this setting has been deprecated and will be removed in a 'email' section. Support for this setting has been deprecated and will be removed in a
future version of Synapse. Server admins should instead use the new future version of Synapse. Server admins should instead use the new
'custom_template_directory' setting documented here: 'custom_template_directory' setting documented here:
https://matrix-org.github.io/synapse/latest/templates.html https://element-hq.github.io/synapse/latest/templates.html
---------------------------------------------------------------------------------------""" ---------------------------------------------------------------------------------------"""

4
synapse/config/logger.py
View file

@ -60,7 +60,7 @@ DEFAULT_LOG_CONFIG = Template(
# be ingested by ELK stacks. See [2] for details. # be ingested by ELK stacks. See [2] for details.
# #
# [1]: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema # [1]: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema
# [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html # [2]: https://element-hq.github.io/synapse/latest/structured_logging.html
version: 1 version: 1
@ -138,7 +138,7 @@ removed in Synapse 1.3.0. You should instead set up a separate log configuration
STRUCTURED_ERROR = """\ STRUCTURED_ERROR = """\
Support for the structured configuration option was removed in Synapse 1.54.0. Support for the structured configuration option was removed in Synapse 1.54.0.
You should instead use the standard logging configuration. See You should instead use the standard logging configuration. See
https://matrix-org.github.io/synapse/v1.54/structured_logging.html https://element-hq.github.io/synapse/v1.54/structured_logging.html
""" """

4
synapse/config/server.py
View file

@ -45,7 +45,7 @@ logger = logging.Logger(__name__)
DIRECT_TCP_ERROR = """ DIRECT_TCP_ERROR = """
Using direct TCP replication for workers is no longer supported. Using direct TCP replication for workers is no longer supported.
Please see https://matrix-org.github.io/synapse/latest/upgrade.html#direct-tcp-replication-is-no-longer-supported-migrate-to-redis Please see https://element-hq.github.io/synapse/latest/upgrade.html#direct-tcp-replication-is-no-longer-supported-migrate-to-redis
""" """
# by default, we attempt to listen on both '::' *and* '0.0.0.0' because some OSes # by default, we attempt to listen on both '::' *and* '0.0.0.0' because some OSes
@ -168,7 +168,7 @@ ROOM_COMPLEXITY_TOO_GREAT = (
METRICS_PORT_WARNING = """\ METRICS_PORT_WARNING = """\
The metrics_port configuration option is deprecated in Synapse 0.31 in favour of The metrics_port configuration option is deprecated in Synapse 0.31 in favour of
a listener. Please see a listener. Please see
https://matrix-org.github.io/synapse/latest/metrics-howto.html https://element-hq.github.io/synapse/latest/metrics-howto.html
on how to configure the new listener. on how to configure the new listener.
--------------------------------------------------------------------------------""" --------------------------------------------------------------------------------"""

2
synapse/config/spam_checker.py
View file

@ -33,7 +33,7 @@ LEGACY_SPAM_CHECKER_WARNING = """
This server is using a spam checker module that is implementing the deprecated spam This server is using a spam checker module that is implementing the deprecated spam
checker interface. Please check with the module's maintainer to see if a new version checker interface. Please check with the module's maintainer to see if a new version
supporting Synapse's generic modules system is available. For more information, please supporting Synapse's generic modules system is available. For more information, please
see https://matrix-org.github.io/synapse/latest/modules/index.html see https://element-hq.github.io/synapse/latest/modules/index.html
---------------------------------------------------------------------------------------""" ---------------------------------------------------------------------------------------"""

2
synapse/config/sso.py
View file

@ -33,7 +33,7 @@ This server's configuration file is using the deprecated 'template_dir' setting
'sso' section. Support for this setting has been deprecated and will be removed in a 'sso' section. Support for this setting has been deprecated and will be removed in a
future version of Synapse. Server admins should instead use the new future version of Synapse. Server admins should instead use the new
'custom_template_directory' setting documented here: 'custom_template_directory' setting documented here:
https://matrix-org.github.io/synapse/latest/templates.html https://element-hq.github.io/synapse/latest/templates.html
---------------------------------------------------------------------------------------""" ---------------------------------------------------------------------------------------"""

4
synapse/config/workers.py
View file

@ -54,13 +54,13 @@ _MISSING_MAIN_PROCESS_INSTANCE_MAP_DATA = """
Missing data for a worker to connect to main process. Please include '%s' in the Missing data for a worker to connect to main process. Please include '%s' in the
`instance_map` declared in your shared yaml configuration as defined in configuration `instance_map` declared in your shared yaml configuration as defined in configuration
documentation here: documentation here:
`https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#instance_map` `https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#instance_map`
""" """
WORKER_REPLICATION_SETTING_DEPRECATED_MESSAGE = """ WORKER_REPLICATION_SETTING_DEPRECATED_MESSAGE = """
'%s' is no longer a supported worker setting, please place '%s' onto your shared '%s' is no longer a supported worker setting, please place '%s' onto your shared
configuration under `main` inside the `instance_map`. See workers documentation here: configuration under `main` inside the `instance_map`. See workers documentation here:
`https://matrix-org.github.io/synapse/latest/workers.html#worker-configuration` `https://element-hq.github.io/synapse/latest/workers.html#worker-configuration`
""" """
# This allows for a handy knob when it's time to change from 'master' to # This allows for a handy knob when it's time to change from 'master' to

2
synapse/events/__init__.py
View file

@ -235,7 +235,7 @@ class _EventInternalMetadata:
processed as if they're new regular events (e.g. updating membership state in processed as if they're new regular events (e.g. updating membership state in
the database, relaying to clients via /sync, etc) despite being outliers. the database, relaying to clients via /sync, etc) despite being outliers.
See also https://matrix-org.github.io/synapse/develop/development/room-dag-concepts.html#out-of-band-membership-events. See also https://element-hq.github.io/synapse/develop/development/room-dag-concepts.html#out-of-band-membership-events.
(Added in synapse 0.99.0, so may be unreliable for events received before that) (Added in synapse 0.99.0, so may be unreliable for events received before that)
""" """

4
synapse/module_api/__init__.py
View file

@ -1269,7 +1269,7 @@ class ModuleApi:
f: The function to call repeatedly. f can be either synchronous or f: The function to call repeatedly. f can be either synchronous or
asynchronous, and must follow Synapse's logcontext rules. asynchronous, and must follow Synapse's logcontext rules.
More info about logcontexts is available at More info about logcontexts is available at
https://matrix-org.github.io/synapse/latest/log_contexts.html https://element-hq.github.io/synapse/latest/log_contexts.html
msec: How long to wait between calls in milliseconds. msec: How long to wait between calls in milliseconds.
*args: Positional arguments to pass to function. *args: Positional arguments to pass to function.
desc: The background task's description. Default to the function's name. desc: The background task's description. Default to the function's name.
@ -1325,7 +1325,7 @@ class ModuleApi:
f: The function to call once. f can be either synchronous or f: The function to call once. f can be either synchronous or
asynchronous, and must follow Synapse's logcontext rules. asynchronous, and must follow Synapse's logcontext rules.
More info about logcontexts is available at More info about logcontexts is available at
https://matrix-org.github.io/synapse/latest/log_contexts.html https://element-hq.github.io/synapse/latest/log_contexts.html
*args: Positional arguments to pass to function. *args: Positional arguments to pass to function.
desc: The background task's description. Default to the function's name. desc: The background task's description. Default to the function's name.
**kwargs: Keyword arguments to pass to function. **kwargs: Keyword arguments to pass to function.

2
synapse/storage/schema/README.md
View file

@ -1,4 +1,4 @@
# Synapse Database Schemas # Synapse Database Schemas
This directory contains the schema files used to build Synapse databases. For more This directory contains the schema files used to build Synapse databases. For more
information, see https://matrix-org.github.io/synapse/develop/development/database_schema.html. information, see https://element-hq.github.io/synapse/develop/development/database_schema.html.

2
synapse/storage/schema/__init__.py
View file

@ -25,7 +25,7 @@ This should be incremented whenever the codebase changes its requirements on the
shape of the database schema (even if those requirements are backwards-compatible with shape of the database schema (even if those requirements are backwards-compatible with
older versions of Synapse). older versions of Synapse).
See https://matrix-org.github.io/synapse/develop/development/database_schema.html See https://element-hq.github.io/synapse/develop/development/database_schema.html
for more information on how this works. for more information on how this works.
Changes in SCHEMA_VERSION = 61: Changes in SCHEMA_VERSION = 61: