Skip to content

Commit 8613f76

Browse files
erikjohnstonerikjohnston
committedDec 13, 2023
More renaming
·
v1.126.0v1.99.0rc1
1 parent 32447b0 commit 8613f76

24 files changed

+125
-126
lines changed
 

‎.github/CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# Automatically request reviews from the synapse-core team when a pull request comes in.
2-
* @matrix-org/synapse-core
2+
* @element-hq/synapse-core

‎.github/workflows/docker.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
with:
5959
images: |
6060
docker.io/matrixdotorg/synapse
61-
ghcr.io/matrix-org/synapse
61+
ghcr.io/element-hq/synapse
6262
flavor: |
6363
latest=false
6464
tags: |

‎README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Alongside all that, join our developer community on Matrix:
237237
:alt: (Rendered documentation on GitHub Pages)
238238
:target: https://matrix-org.github.io/synapse/latest/
239239

240-
.. |license| image:: https://img.shields.io/github/license/matrix-org/synapse
240+
.. |license| image:: https://img.shields.io/github/license/element-hq/synapse
241241
:alt: (check license in LICENSE file)
242242
:target: LICENSE
243243

‎book.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ create-missing = false
1616

1717
[output.html]
1818
# The URL visitors will be directed to when they try to edit a page
19-
edit-url-template = "https://github.com/matrix-org/synapse/edit/develop/{path}"
19+
edit-url-template = "https://github.com/element-hq/synapse/edit/develop/{path}"
2020

2121
# Remove the numbers that appear before each item in the sidebar, as they can
2222
# get quite messy as we nest deeper
2323
no-section-label = true
2424

2525
# The source code URL of the repository
26-
git-repository-url = "https://github.com/matrix-org/synapse"
26+
git-repository-url = "https://github.com/element-hq/synapse"
2727

2828
# The path that the docs are hosted on
2929
site-url = "/synapse/"

‎contrib/workers-bash-scripts/create-multiple-stream-writers.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Creating multiple stream writers with a bash script
22

3-
This script creates multiple [stream writer](https://github.com/matrix-org/synapse/blob/develop/docs/workers.md#stream-writers) workers.
3+
This script creates multiple [stream writer](https://github.com/element-hq/synapse/blob/develop/docs/workers.md#stream-writers) workers.
44

55
Stream writers require both replication and HTTP listeners.
66

77
It also prints out the example lines for Synapse main configuration file.
88

99
Remember to route necessary endpoints directly to a worker associated with it.
1010

11-
If you run the script as-is, it will create workers with the replication listener starting from port 8034 and another, regular http listener starting from 8044. If you don't need all of the stream writers listed in the script, just remove them from the ```STREAM_WRITERS``` array.
11+
If you run the script as-is, it will create workers with the replication listener starting from port 8034 and another, regular http listener starting from 8044. If you don't need all of the stream writers listed in the script, just remove them from the ```STREAM_WRITERS``` array.
1212

1313
Hint: Note that `worker_pid_file` is required if `worker_daemonize` is `true`. Uncomment and/or modify the line if needed.
1414

@@ -71,7 +71,7 @@ cat << EXAMPLECONFIG
7171
# Don't forget to configure your reverse proxy and
7272
# necessary endpoints to their respective worker.
7373
74-
# See https://github.com/matrix-org/synapse/blob/develop/docs/workers.md
74+
# See https://github.com/element-hq/synapse/blob/develop/docs/workers.md
7575
# for more information.
7676
7777
# Remember: Under NO circumstances should the replication
@@ -102,7 +102,7 @@ You should receive an output similar to the following:
102102
# Don't forget to configure your reverse proxy and
103103
# necessary endpoints to their respective worker.
104104

105-
# See https://github.com/matrix-org/synapse/blob/develop/docs/workers.md
105+
# See https://github.com/element-hq/synapse/blob/develop/docs/workers.md
106106
# for more information
107107

108108
# Remember: Under NO circumstances should the replication
@@ -138,14 +138,14 @@ Simply copy-and-paste the output to an appropriate place in your Synapse main co
138138

139139
## Write directly to Synapse configuration file
140140

141-
You could also write the output directly to homeserver main configuration file. **This, however, is not recommended** as even a small typo (such as replacing >> with >) can erase the entire ```homeserver.yaml```.
141+
You could also write the output directly to homeserver main configuration file. **This, however, is not recommended** as even a small typo (such as replacing >> with >) can erase the entire ```homeserver.yaml```.
142142

143143
If you do this, back up your original configuration file first:
144144

145145
```console
146146
# Back up homeserver.yaml first
147-
cp /etc/matrix-synapse/homeserver.yaml /etc/matrix-synapse/homeserver.yaml.bak
147+
cp /etc/matrix-synapse/homeserver.yaml /etc/matrix-synapse/homeserver.yaml.bak
148148

149149
# Create workers and write output to your homeserver.yaml
150-
./create_stream_writers.sh >> /etc/matrix-synapse/homeserver.yaml
150+
./create_stream_writers.sh >> /etc/matrix-synapse/homeserver.yaml
151151
```

‎debian/control

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Build-Depends:
1818
python3-venv,
1919
tar,
2020
Standards-Version: 3.9.8
21-
Homepage: https://github.com/matrix-org/synapse
21+
Homepage: https://github.com/element-hq/synapse
2222

2323
Package: matrix-synapse-py3
2424
Architecture: any

‎debian/templates

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ _Description: Name of the server:
55
servers via federation. This is normally the public hostname of the
66
server running synapse, but can be different if you set up delegation.
77
Please refer to the delegation documentation in this case:
8-
https://github.com/matrix-org/synapse/blob/master/docs/delegate.md.
8+
https://github.com/element-hq/synapse/blob/master/docs/delegate.md.
99

1010
Template: matrix-synapse/report-stats
1111
Type: boolean

‎docker/Dockerfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,8 @@ RUN --mount=type=cache,target=/synapse/target,sharing=locked \
161161
FROM docker.io/library/python:${PYTHON_VERSION}-slim-bookworm
162162

163163
LABEL org.opencontainers.image.url='https://matrix.org/docs/projects/server/synapse'
164-
LABEL org.opencontainers.image.documentation='https://github.com/matrix-org/synapse/blob/master/docker/README.md'
165-
LABEL org.opencontainers.image.source='https://github.com/matrix-org/synapse.git'
164+
LABEL org.opencontainers.image.documentation='https://github.com/element-hq/synapse/blob/master/docker/README.md'
165+
LABEL org.opencontainers.image.source='https://github.com/element-hq/synapse.git'
166166
LABEL org.opencontainers.image.licenses='Apache-2.0'
167167

168168
RUN \

‎docker/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The following environment variables are supported in `generate` mode:
7878

7979
## Postgres
8080

81-
By default the config will use SQLite. See the [docs on using Postgres](https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md) for more info on how to use Postgres. Until this section is improved [this issue](https://github.com/matrix-org/synapse/issues/8304) may provide useful information.
81+
By default the config will use SQLite. See the [docs on using Postgres](https://github.com/element-hq/synapse/blob/develop/docs/postgres.md) for more info on how to use Postgres. Until this section is improved [this issue](https://github.com/element-hq/synapse/issues/8304) may provide useful information.
8282

8383
## Running synapse
8484

@@ -151,7 +151,7 @@ is suitable for local testing, but for any practical use, you will either need
151151
to use a reverse proxy, or configure Synapse to expose an HTTPS port.
152152

153153
For documentation on using a reverse proxy, see
154-
https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md.
154+
https://github.com/element.-hq/synapse/blob/master/docs/reverse_proxy.md.
155155

156156
For more information on enabling TLS support in synapse itself, see
157157
https://matrix-org.github.io/synapse/latest/setup/installation.html#tls-certificates. Of

‎docker/complement/Dockerfile

+47-47
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,58 @@
11
# syntax=docker/dockerfile:1
2-
# This dockerfile builds on top of 'docker/Dockerfile-workers' in matrix-org/synapse
2+
# This dockerfile builds on top of 'docker/Dockerfile-workers' in element.-hq/synapse
33
# by including a built-in postgres instance, as well as setting up the homeserver so
44
# that it is ready for testing via Complement.
55
#
66
# Instructions for building this image from those it depends on is detailed in this guide:
7-
# https://github.com/matrix-org/synapse/blob/develop/docker/README-testing.md#testing-with-postgresql-and-single-or-multi-process-synapse
7+
# https://github.com/element.-hq/synapse/blob/develop/docker/README-testing.md#testing-with-postgresql-and-single-or-multi-process-synapse
88

99
ARG SYNAPSE_VERSION=latest
1010
# This is an intermediate image, to be built locally (not pulled from a registry).
1111
ARG FROM=matrixdotorg/synapse-workers:$SYNAPSE_VERSION
1212

1313
FROM $FROM
14-
# First of all, we copy postgres server from the official postgres image,
15-
# since for repeated rebuilds, this is much faster than apt installing
16-
# postgres each time.
17-
18-
# This trick only works because (a) the Synapse image happens to have all the
19-
# shared libraries that postgres wants, (b) we use a postgres image based on
20-
# the same debian version as Synapse's docker image (so the versions of the
21-
# shared libraries match).
22-
RUN adduser --system --uid 999 postgres --home /var/lib/postgresql
23-
COPY --from=docker.io/library/postgres:13-bookworm /usr/lib/postgresql /usr/lib/postgresql
24-
COPY --from=docker.io/library/postgres:13-bookworm /usr/share/postgresql /usr/share/postgresql
25-
RUN mkdir /var/run/postgresql && chown postgres /var/run/postgresql
26-
ENV PATH="${PATH}:/usr/lib/postgresql/13/bin"
27-
ENV PGDATA=/var/lib/postgresql/data
28-
29-
# We also initialize the database at build time, rather than runtime, so that it's faster to spin up the image.
30-
RUN gosu postgres initdb --locale=C --encoding=UTF-8 --auth-host password
31-
32-
# Configure a password and create a database for Synapse
33-
RUN echo "ALTER USER postgres PASSWORD 'somesecret'" | gosu postgres postgres --single
34-
RUN echo "CREATE DATABASE synapse" | gosu postgres postgres --single
35-
36-
# Extend the shared homeserver config to disable rate-limiting,
37-
# set Complement's static shared secret, enable registration, amongst other
38-
# tweaks to get Synapse ready for testing.
39-
# To do this, we copy the old template out of the way and then include it
40-
# with Jinja2.
41-
RUN mv /conf/shared.yaml.j2 /conf/shared-orig.yaml.j2
42-
COPY conf/workers-shared-extra.yaml.j2 /conf/shared.yaml.j2
43-
44-
WORKDIR /data
45-
46-
COPY conf/postgres.supervisord.conf /etc/supervisor/conf.d/postgres.conf
47-
48-
# Copy the entrypoint
49-
COPY conf/start_for_complement.sh /
50-
51-
# Expose nginx's listener ports
52-
EXPOSE 8008 8448
53-
54-
ENTRYPOINT ["/start_for_complement.sh"]
55-
56-
# Update the healthcheck to have a shorter check interval
57-
HEALTHCHECK --start-period=5s --interval=1s --timeout=1s \
58-
CMD /bin/sh /healthcheck.sh
14+
# First of all, we copy postgres server from the official postgres image,
15+
# since for repeated rebuilds, this is much faster than apt installing
16+
# postgres each time.
17+
18+
# This trick only works because (a) the Synapse image happens to have all the
19+
# shared libraries that postgres wants, (b) we use a postgres image based on
20+
# the same debian version as Synapse's docker image (so the versions of the
21+
# shared libraries match).
22+
RUN adduser --system --uid 999 postgres --home /var/lib/postgresql
23+
COPY --from=docker.io/library/postgres:13-bookworm /usr/lib/postgresql /usr/lib/postgresql
24+
COPY --from=docker.io/library/postgres:13-bookworm /usr/share/postgresql /usr/share/postgresql
25+
RUN mkdir /var/run/postgresql && chown postgres /var/run/postgresql
26+
ENV PATH="${PATH}:/usr/lib/postgresql/13/bin"
27+
ENV PGDATA=/var/lib/postgresql/data
28+
29+
# We also initialize the database at build time, rather than runtime, so that it's faster to spin up the image.
30+
RUN gosu postgres initdb --locale=C --encoding=UTF-8 --auth-host password
31+
32+
# Configure a password and create a database for Synapse
33+
RUN echo "ALTER USER postgres PASSWORD 'somesecret'" | gosu postgres postgres --single
34+
RUN echo "CREATE DATABASE synapse" | gosu postgres postgres --single
35+
36+
# Extend the shared homeserver config to disable rate-limiting,
37+
# set Complement's static shared secret, enable registration, amongst other
38+
# tweaks to get Synapse ready for testing.
39+
# To do this, we copy the old template out of the way and then include it
40+
# with Jinja2.
41+
RUN mv /conf/shared.yaml.j2 /conf/shared-orig.yaml.j2
42+
COPY conf/workers-shared-extra.yaml.j2 /conf/shared.yaml.j2
43+
44+
WORKDIR /data
45+
46+
COPY conf/postgres.supervisord.conf /etc/supervisor/conf.d/postgres.conf
47+
48+
# Copy the entrypoint
49+
COPY conf/start_for_complement.sh /
50+
51+
# Expose nginx's listener ports
52+
EXPOSE 8008 8448
53+
54+
ENTRYPOINT ["/start_for_complement.sh"]
55+
56+
# Update the healthcheck to have a shorter check interval
57+
HEALTHCHECK --start-period=5s --interval=1s --timeout=1s \
58+
CMD /bin/sh /healthcheck.sh

‎docs/consent_tracking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To enable this, first create templates for the policy and success pages.
2424
These should be stored on the local filesystem.
2525

2626
These templates use the [Jinja2](http://jinja.pocoo.org) templating language,
27-
and [docs/privacy_policy_templates](https://github.com/matrix-org/synapse/tree/develop/docs/privacy_policy_templates/)
27+
and [docs/privacy_policy_templates](https://github.com/element.-hq/synapse/tree/develop/docs/privacy_policy_templates/)
2828
gives examples of the sort of thing that can be done.
2929

3030
Note that the templates must be stored under a name giving the language of the

‎docs/development/git.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ b2dba0607`:
1414
Note how the commit comment explains clearly what is changing and why. Also
1515
note the *absence* of merge commits, as well as the absence of commits called
1616
things like (to pick a few culprits):
17-
[“pep8”](https://github.com/matrix-org/synapse/commit/84691da6c), [“fix broken
18-
test”](https://github.com/matrix-org/synapse/commit/474810d9d),
19-
[“oops”](https://github.com/matrix-org/synapse/commit/c9d72e457),
20-
[“typo”](https://github.com/matrix-org/synapse/commit/836358823), or [“Who's
21-
the president?”](https://github.com/matrix-org/synapse/commit/707374d5d).
17+
[“pep8”](https://github.com/element.-hq/synapse/commit/84691da6c), [“fix broken
18+
test”](https://github.com/element.-hq/synapse/commit/474810d9d),
19+
[“oops”](https://github.com/element.-hq/synapse/commit/c9d72e457),
20+
[“typo”](https://github.com/element.-hq/synapse/commit/836358823), or [“Who's
21+
the president?”](https://github.com/element.-hq/synapse/commit/707374d5d).
2222

2323
There are a number of reasons why keeping a clean commit history is a good
2424
thing:

‎docs/development/synapse_architecture/streams.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Streams
22

33
Synapse has a concept of "streams", which are roughly described in [`id_generators.py`](
4-
https://github.com/matrix-org/synapse/blob/develop/synapse/storage/util/id_generators.py
4+
https://github.com/element.-hq/synapse/blob/develop/synapse/storage/util/id_generators.py
55
).
66
Generally speaking, streams are a series of notifications that something in Synapse's database has changed that the application might need to respond to.
77
For example:
@@ -11,12 +11,12 @@ For example:
1111
- The to-device stream reports when a device has a new [to-device message](https://spec.matrix.org/v1.7/client-server-api/#send-to-device-messaging).
1212

1313
See [`synapse.replication.tcp.streams`](
14-
https://github.com/matrix-org/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py
14+
https://github.com/element.-hq/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py
1515
) for the full list of streams.
1616

1717
It is very helpful to understand the streams mechanism when working on any part of Synapse that needs to respond to changes—especially if those changes are made by different workers.
1818
To that end, let's describe streams formally, paraphrasing from the docstring of [`AbstractStreamIdGenerator`](
19-
https://github.com/matrix-org/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96
19+
https://github.com/element.-hq/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96
2020
).
2121

2222
### Definition

‎docs/metrics-howto.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@
8787

8888
1. Restart Prometheus.
8989

90-
1. Consider using the [grafana dashboard](https://github.com/matrix-org/synapse/tree/master/contrib/grafana/)
91-
and required [recording rules](https://github.com/matrix-org/synapse/tree/master/contrib/prometheus/)
90+
1. Consider using the [grafana dashboard](https://github.com/element.-hq/synapse/tree/master/contrib/grafana/)
91+
and required [recording rules](https://github.com/element.-hq/synapse/tree/master/contrib/prometheus/)
9292

9393
## Monitoring workers
9494

‎docs/modules/writing_a_module.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ either the output of the module's `parse_config` static method (see below), or t
1010
configuration associated with the module in Synapse's configuration file.
1111

1212
See the documentation for the `ModuleApi` class
13-
[here](https://github.com/matrix-org/synapse/blob/master/synapse/module_api/__init__.py).
13+
[here](https://github.com/element.-hq/synapse/blob/master/synapse/module_api/__init__.py).
1414

1515
## When Synapse runs with several modules configured
1616

@@ -109,7 +109,7 @@ from synapse.module_api import cached, ModuleApi
109109
class MyModule:
110110
def __init__(self, config: Any, api: ModuleApi):
111111
self.api = api
112-
112+
113113
# Register the cached function so Synapse knows how to correctly invalidate
114114
# entries for it.
115115
self.api.register_cached_function(self.get_user_from_id)
@@ -124,15 +124,15 @@ class MyModule:
124124

125125
async def do_something_with_users(self) -> None:
126126
"""Calls the cached function and then invalidates an entry in its cache."""
127-
127+
128128
user_id = "@alice:example.com"
129-
129+
130130
# Get the user. Since get_department_for_user is wrapped with a cache,
131131
# the return value for this user_id will be cached.
132132
department = await self.get_department_for_user(user_id)
133-
133+
134134
# Do something with `department`...
135-
135+
136136
# Let's say something has changed with our user, and the entry we have for
137137
# them in the cache is out of date, so we want to invalidate it.
138138
await self.api.invalidate_cache(self.get_department_for_user, (user_id,))

‎docs/sso_mapping_providers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ A custom mapping provider must specify the following methods:
115115

116116
Synapse has a built-in OpenID mapping provider if a custom provider isn't
117117
specified in the config. It is located at
118-
[`synapse.handlers.oidc.JinjaOidcMappingProvider`](https://github.com/matrix-org/synapse/blob/develop/synapse/handlers/oidc.py).
118+
[`synapse.handlers.oidc.JinjaOidcMappingProvider`](https://github.com/element.-hq/synapse/blob/develop/synapse/handlers/oidc.py).
119119

120120
## SAML Mapping Providers
121121

@@ -202,4 +202,4 @@ A custom mapping provider must specify the following methods:
202202

203203
Synapse has a built-in SAML mapping provider if a custom provider isn't
204204
specified in the config. It is located at
205-
[`synapse.handlers.saml.DefaultSamlMappingProvider`](https://github.com/matrix-org/synapse/blob/develop/synapse/handlers/saml.py).
205+
[`synapse.handlers.saml.DefaultSamlMappingProvider`](https://github.com/element.-hq/synapse/blob/develop/synapse/handlers/saml.py).

‎docs/systemd-with-workers/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ well as a `matrix-synapse-worker@` service template for any workers you
66
require. Additionally, to group the required services, it sets up a
77
`matrix-synapse.target`.
88

9-
See the folder [system](https://github.com/matrix-org/synapse/tree/develop/docs/systemd-with-workers/system/)
9+
See the folder [system](https://github.com/element.-hq/synapse/tree/develop/docs/systemd-with-workers/system/)
1010
for the systemd unit files.
1111

12-
The folder [workers](https://github.com/matrix-org/synapse/tree/develop/docs/systemd-with-workers/workers/)
12+
The folder [workers](https://github.com/element.-hq/synapse/tree/develop/docs/systemd-with-workers/workers/)
1313
contains an example configuration for the `generic_worker` worker.
1414

1515
## Synapse configuration files
@@ -33,7 +33,7 @@ There is no need for a separate configuration file for the master process.
3333
## Set up
3434

3535
1. Adjust synapse configuration files as above.
36-
1. Copy the `*.service` and `*.target` files in [system](https://github.com/matrix-org/synapse/tree/develop/docs/systemd-with-workers/system/)
36+
1. Copy the `*.service` and `*.target` files in [system](https://github.com/element.-hq/synapse/tree/develop/docs/systemd-with-workers/system/)
3737
to `/etc/systemd/system`.
3838
1. Run `systemctl daemon-reload` to tell systemd to load the new unit files.
3939
1. Run `systemctl enable matrix-synapse.service`. This will configure the
@@ -74,7 +74,7 @@ systemctl restart matrix-synapse.target
7474

7575
**Optional:** If further hardening is desired, the file
7676
`override-hardened.conf` may be copied from
77-
[contrib/systemd/override-hardened.conf](https://github.com/matrix-org/synapse/tree/develop/contrib/systemd/)
77+
[contrib/systemd/override-hardened.conf](https://github.com/element.-hq/synapse/tree/develop/contrib/systemd/)
7878
in this repository to the location
7979
`/etc/systemd/system/matrix-synapse.service.d/override-hardened.conf` (the
8080
directory may have to be created). It enables certain sandboxing features in

‎docs/templates.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Synapse uses parametrised templates to generate the content of emails it sends and
44
webpages it shows to users.
55

6-
By default, Synapse will use the templates listed [here](https://github.com/matrix-org/synapse/tree/master/synapse/res/templates).
6+
By default, Synapse will use the templates listed [here](https://github.com/element.-hq/synapse/tree/master/synapse/res/templates).
77
Server admins can configure an additional directory for Synapse to look for templates
88
in, allowing them to specify custom templates:
99

@@ -128,7 +128,7 @@ registration and password reset:
128128
page above.
129129
When rendering, `password_reset_success.html` is given no variable, and
130130
`password_reset_failure.html` is given a `failure_reason`, which contains the reason
131-
for the password reset failure.
131+
for the password reset failure.
132132
* `registration_success.html` and `registration_failure.html`: HTML pages for success and
133133
failure that a user will see when they follow the link in an address verification email
134134
sent during registration.

‎docs/upgrade.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -110,13 +110,13 @@ date.
110110
## App service query parameter authorization is now a configuration option
111111
112112
Synapse v1.81.0 deprecated application service authorization via query parameters as this is
113-
considered insecure - and from Synapse v1.71.0 forwards the application service token has also been sent via
113+
considered insecure - and from Synapse v1.71.0 forwards the application service token has also been sent via
114114
[the `Authorization` header](https://spec.matrix.org/v1.6/application-service-api/#authorization)], making the insecure
115-
query parameter authorization redundant. Since removing the ability to continue to use query parameters could break
116-
backwards compatibility it has now been put behind a configuration option, `use_appservice_legacy_authorization`.
117-
This option defaults to false, but can be activated by adding
115+
query parameter authorization redundant. Since removing the ability to continue to use query parameters could break
116+
backwards compatibility it has now been put behind a configuration option, `use_appservice_legacy_authorization`.
117+
This option defaults to false, but can be activated by adding
118118
```yaml
119-
use_appservice_legacy_authorization: true
119+
use_appservice_legacy_authorization: true
120120
```
121121
to your configuration.
122122
@@ -184,7 +184,7 @@ When using workers,
184184
* `worker_replication_host`
185185
* `worker_replication_http_port`
186186
* `worker_replication_http_tls`
187-
187+
188188
should now be removed from individual worker YAML configurations and the main process should instead be added to the `instance_map`
189189
in the shared YAML configuration, using the name `main`.
190190
@@ -260,7 +260,7 @@ worker_listeners:
260260
worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml
261261
262262
```
263-
Notes:
263+
Notes:
264264
* `tls` is optional but mirrors the functionality of `worker_replication_http_tls`
265265
266266
@@ -352,8 +352,8 @@ and device replication will resume as normal.
352352

353353
## Minimum version of Poetry is now 1.3.2
354354

355-
The minimum supported version of Poetry is now 1.3.2 (previously 1.2.0, [since
356-
Synapse 1.67](#upgrading-to-v1670)). If you have used `poetry install` to
355+
The minimum supported version of Poetry is now 1.3.2 (previously 1.2.0, [since
356+
Synapse 1.67](#upgrading-to-v1670)). If you have used `poetry install` to
357357
install Synapse from a source checkout, you should upgrade poetry: see its
358358
[installation instructions](https://python-poetry.org/docs/#installation).
359359
For all other installation methods, no acction is required.
@@ -1068,7 +1068,7 @@ As announced with the release of [Synapse 1.47.0](#deprecation-of-the-user_may_c
10681068
the deprecated `user_may_create_room_with_invites` module callback has been removed.
10691069
10701070
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)
1071-
and use the [`get_room_state`](https://github.com/matrix-org/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
1071+
and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
10721072
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)
10731073
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).
10741074
@@ -1124,7 +1124,7 @@ Any scripts still using the above APIs should be converted to use the
11241124
The `user_may_create_room_with_invites` is deprecated and will be removed in a future
11251125
version of Synapse. Modules implementing this callback can instead implement
11261126
[`user_may_invite`](https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite)
1127-
and use the [`get_room_state`](https://github.com/matrix-org/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
1127+
and use the [`get_room_state`](https://github.com/element.-hq/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
11281128
module API method to infer whether the invite is happening in the context of creating a
11291129
room.
11301130
@@ -1171,8 +1171,8 @@ Any scripts still using the above APIs should be converted to use the
11711171
## User-interactive authentication fallback templates can now display errors
11721172
11731173
This may affect you if you make use of custom HTML templates for the
1174-
[reCAPTCHA (`synapse/res/templates/recaptcha.html`)](https://github.com/matrix-org/synapse/tree/develop/synapse/res/templates/recaptcha.html) or
1175-
[terms (`synapse/res/templates/terms.html`)](https://github.com/matrix-org/synapse/tree/develop/synapse/res/templates/terms.html) fallback pages.
1174+
[reCAPTCHA (`synapse/res/templates/recaptcha.html`)](https://github.com/element.-hq/synapse/tree/develop/synapse/res/templates/recaptcha.html) or
1175+
[terms (`synapse/res/templates/terms.html`)](https://github.com/element.-hq/synapse/tree/develop/synapse/res/templates/terms.html) fallback pages.
11761176
11771177
The template is now provided an `error` variable if the authentication
11781178
process failed. See the default templates linked above for an example.
@@ -1671,7 +1671,7 @@ update your reverse proxy configuration to reflect this change.
16711671
## New HTML templates
16721672
16731673
A new HTML template,
1674-
[password_reset_confirmation.html](https://github.com/matrix-org/synapse/blob/develop/synapse/res/templates/password_reset_confirmation.html),
1674+
[password_reset_confirmation.html](https://github.com/element.-hq/synapse/blob/develop/synapse/res/templates/password_reset_confirmation.html),
16751675
has been added to the `synapse/res/templates` directory. If you are
16761676
using a custom template directory, you may want to copy the template
16771677
over and modify it.
@@ -1770,7 +1770,7 @@ New templates (`sso_auth_confirm.html`, `sso_auth_success.html`, and
17701770
is configured to use SSO and a custom
17711771
`sso_redirect_confirm_template_dir` configuration then these templates
17721772
will need to be copied from
1773-
[`synapse/res/templates`](https://github.com/matrix-org/synapse/tree/develop/synapse/res/templates) into that directory.
1773+
[`synapse/res/templates`](https://github.com/element.-hq/synapse/tree/develop/synapse/res/templates) into that directory.
17741774
17751775
## Synapse SSO Plugins Method Deprecation
17761776
@@ -1923,7 +1923,7 @@ included.
19231923
Synapse will expect these files to exist inside the configured template
19241924
directory, and **will fail to start** if they are absent. To view the
19251925
default templates, see
1926-
[synapse/res/templates](https://github.com/matrix-org/synapse/tree/master/synapse/res/templates).
1926+
[synapse/res/templates](https://github.com/element.-hq/synapse/tree/master/synapse/res/templates).
19271927
19281928
## 3pid verification changes
19291929

‎docs/usage/administration/request_log.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Request log format
22

3-
HTTP request logs are written by synapse (see [`synapse/http/site.py`](https://github.com/matrix-org/synapse/tree/develop/synapse/http/site.py) for details).
3+
HTTP request logs are written by synapse (see [`synapse/http/site.py`](https://github.com/element.-hq/synapse/tree/develop/synapse/http/site.py) for details).
44

55
See the following for how to decode the dense data available from the default logging configuration.
66

‎docs/usage/administration/understanding_synapse_through_grafana_graphs.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## Understanding Synapse through Grafana graphs
22

3-
It is possible to monitor much of the internal state of Synapse using [Prometheus](https://prometheus.io)
4-
metrics and [Grafana](https://grafana.com/).
5-
A guide for configuring Synapse to provide metrics is available [here](../../metrics-howto.md)
6-
and information on setting up Grafana is [here](https://github.com/matrix-org/synapse/tree/master/contrib/grafana).
3+
It is possible to monitor much of the internal state of Synapse using [Prometheus](https://prometheus.io)
4+
metrics and [Grafana](https://grafana.com/).
5+
A guide for configuring Synapse to provide metrics is available [here](../../metrics-howto.md)
6+
and information on setting up Grafana is [here](https://github.com/element.-hq/synapse/tree/master/contrib/grafana).
77
In this setup, Prometheus will periodically scrape the information Synapse provides and
88
store a record of it over time. Grafana is then used as an interface to query and
99
present this information through a series of pretty graphs.
1010

11-
Once you have grafana set up, and assuming you're using [our grafana dashboard template](https://github.com/matrix-org/synapse/blob/master/contrib/grafana/synapse.json), look for the following graphs when debugging a slow/overloaded Synapse:
11+
Once you have grafana set up, and assuming you're using [our grafana dashboard template](https://github.com/element.-hq/synapse/blob/master/contrib/grafana/synapse.json), look for the following graphs when debugging a slow/overloaded Synapse:
1212

1313
## Message Event Send Time
1414

@@ -57,7 +57,7 @@ Cross-referencing this with the Eviction Rate graph, which shows that entries ar
5757

5858
![image](https://user-images.githubusercontent.com/1342360/82240766-de95df80-9932-11ea-8c15-5acfc57c48da.png)
5959

60-
we should probably consider raising the size of that cache by raising its cache factor (a multiplier value for the size of an individual cache). Information on doing so is available [here](https://github.com/matrix-org/synapse/blob/ee421e524478c1ad8d43741c27379499c2f6135c/docs/sample_config.yaml#L608-L642) (note that the configuration of individual cache factors through the configuration file is available in Synapse v1.14.0+, whereas doing so through environment variables has been supported for a very long time). Note that this will increase Synapse's overall memory usage.
60+
we should probably consider raising the size of that cache by raising its cache factor (a multiplier value for the size of an individual cache). Information on doing so is available [here](https://github.com/element.-hq/synapse/blob/ee421e524478c1ad8d43741c27379499c2f6135c/docs/sample_config.yaml#L608-L642) (note that the configuration of individual cache factors through the configuration file is available in Synapse v1.14.0+, whereas doing so through environment variables has been supported for a very long time). Note that this will increase Synapse's overall memory usage.
6161

6262
## Forward Extremities
6363

@@ -71,14 +71,13 @@ If a room has >10 forward extremities, it's worth checking which room is the cul
7171

7272
![image](https://user-images.githubusercontent.com/1342360/82241911-da6ac180-9934-11ea-9a0d-a311fe22acd0.png)
7373

74-
Large spikes in garbage collection times (bigger than shown here, I'm talking in the
75-
multiple seconds range), can cause lots of problems in Synapse performance. It's more an
74+
Large spikes in garbage collection times (bigger than shown here, I'm talking in the
75+
multiple seconds range), can cause lots of problems in Synapse performance. It's more an
7676
indicator of problems, and a symptom of other problems though, so check other graphs for what might be causing it.
7777

7878
## Final Thoughts
7979

80-
If you're still having performance problems with your Synapse instance and you've
80+
If you're still having performance problems with your Synapse instance and you've
8181
tried everything you can, it may just be a lack of system resources. Consider adding
82-
more CPU and RAM, and make use of [worker mode](../../workers.md)
82+
more CPU and RAM, and make use of [worker mode](../../workers.md)
8383
to make use of multiple CPU cores / multiple machines for your homeserver.
84-

‎docs/usage/configuration/config_documentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1416,7 +1416,7 @@ kill -HUP [PID_OF_SYNAPSE_PROCESS]
14161416
If you are running multiple workers, you must individually update the worker
14171417
config file and send this signal to each worker process.
14181418

1419-
If you're using the [example systemd service](https://github.com/matrix-org/synapse/blob/develop/contrib/systemd/matrix-synapse.service)
1419+
If you're using the [example systemd service](https://github.com/element.-hq/synapse/blob/develop/contrib/systemd/matrix-synapse.service)
14201420
file in Synapse's `contrib` directory, you can send a `SIGHUP` signal by using
14211421
`systemctl reload matrix-synapse`.
14221422

@@ -2777,7 +2777,7 @@ enable_metrics: true
27772777
### `sentry`
27782778

27792779
Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
2780-
with the `dsn` setting.
2780+
with the `dsn` setting.
27812781

27822782
An optional `environment` field can be used to specify an environment. This allows
27832783
for log maintenance based on different environments, ensuring better organization

‎docs/welcome_and_overview.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
Welcome to the documentation repository for Synapse, a
3+
Welcome to the documentation repository for Synapse, a
44
[Matrix](https://matrix.org) homeserver implementation developed by Element.
55

66
## Installing and using Synapse
@@ -36,17 +36,17 @@ following documentation:
3636
* Read the [Contributing Guide](development/contributing_guide.md). It is meant
3737
to walk new contributors through the process of developing and submitting a
3838
change to the Synapse codebase (which is [hosted on
39-
GitHub](https://github.com/matrix-org/synapse)).
39+
GitHub](https://github.com/element.-hq/synapse)).
4040

4141
* Set up your [development
4242
environment](development/contributing_guide.md#2-what-do-i-need), then learn
4343
how to [lint](development/contributing_guide.md#run-the-linters) and
4444
[test](development/contributing_guide.md#8-test-test-test) your code.
4545

46-
* Look at [the issue tracker](https://github.com/matrix-org/synapse/issues) for
46+
* Look at [the issue tracker](https://github.com/element.-hq/synapse/issues) for
4747
bugs to fix or features to add. If you're new, it may be best to start with
4848
those labeled [good first
49-
issue](https://github.com/matrix-org/synapse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
49+
issue](https://github.com/element.-hq/synapse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
5050

5151
* Understand [how Synapse is
5252
built](development/internal_documentation/index.html), how to [migrate
@@ -58,7 +58,7 @@ following documentation:
5858
do so!
5959

6060
* And finally, contribute to this documentation! The source for which is
61-
[located here](https://github.com/matrix-org/synapse/tree/develop/docs).
61+
[located here](https://github.com/element.-hq/synapse/tree/develop/docs).
6262

6363
## Reporting a security vulnerability
6464

‎scripts-dev/next_github_number.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ set -e
44

55
# Fetch the current GitHub issue number, add one to it -- presto! The likely
66
# next PR number.
7-
CURRENT_NUMBER=$(curl -s "https://api.github.com/repos/matrix-org/synapse/issues?state=all&per_page=1" | jq -r ".[0].number")
7+
CURRENT_NUMBER=$(curl -s "https://api.github.com/repos/element.-hq/synapse/issues?state=all&per_page=1" | jq -r ".[0].number")
88
CURRENT_NUMBER=$((CURRENT_NUMBER+1))
99
echo $CURRENT_NUMBER

0 commit comments

Comments
 (0)
Please sign in to comment.