Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 4578531

Browse files
authored
fix broken links in upgrade.md (#10543)
Signed-off-by: Dirk Klimpel [email protected]
1 parent 05111f8 commit 4578531

File tree

2 files changed

+24
-28
lines changed

2 files changed

+24
-28
lines changed

changelog.d/10543.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix broken links in `upgrade.md`. Contributed by @dklimpel.

docs/upgrade.md

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,9 @@ SQLite databases are unaffected by this change.
142142

143143
The current spam checker interface is deprecated in favour of a new generic modules system.
144144
Authors of spam checker modules can refer to [this
145-
documentation](https://matrix-org.github.io/synapse/develop/modules.html#porting-an-existing-module-that-uses-the-old-interface)
145+
documentation](modules.md#porting-an-existing-module-that-uses-the-old-interface)
146146
to update their modules. Synapse administrators can refer to [this
147-
documentation](https://matrix-org.github.io/synapse/develop/modules.html#using-modules)
147+
documentation](modules.md#using-modules)
148148
to update their configuration once the modules they are using have been updated.
149149

150150
We plan to remove support for the current spam checker interface in August 2021.
@@ -217,8 +217,7 @@ Instructions for doing so are provided
217217

218218
## Dropping support for old Python, Postgres and SQLite versions
219219

220-
In line with our [deprecation
221-
policy](https://github.com/matrix-org/synapse/blob/release-v1.32.0/docs/deprecation_policy.md),
220+
In line with our [deprecation policy](deprecation_policy.md),
222221
we've dropped support for Python 3.5 and PostgreSQL 9.5, as they are no
223222
longer supported upstream.
224223
@@ -231,8 +230,7 @@ The deprecated v1 "list accounts" admin API
231230
(`GET /_synapse/admin/v1/users/<user_id>`) has been removed in this
232231
version.
233232
234-
The [v2 list accounts
235-
API](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#list-accounts)
233+
The [v2 list accounts API](admin_api/user_admin_api.md#list-accounts)
236234
has been available since Synapse 1.7.0 (2019-12-13), and is accessible
237235
under `GET /_synapse/admin/v2/users`.
238236
@@ -267,7 +265,7 @@ by the client.
267265
268266
Synapse also requires the [Host]{.title-ref} header to be preserved.
269267
270-
See the [reverse proxy documentation](../reverse_proxy.md), where the
268+
See the [reverse proxy documentation](reverse_proxy.md), where the
271269
example configurations have been updated to show how to set these
272270
headers.
273271
@@ -286,7 +284,7 @@ identity providers:
286284
`[synapse public baseurl]/_synapse/client/oidc/callback` to the list
287285
of permitted "redirect URIs" at the identity provider.
288286
289-
See the [OpenID docs](../openid.md) for more information on setting
287+
See the [OpenID docs](openid.md) for more information on setting
290288
up OpenID Connect.
291289
292290
- If your server is configured for single sign-on via a SAML2 identity
@@ -486,8 +484,7 @@ lock down external access to the Admin API endpoints.
486484
This release deprecates use of the `structured: true` logging
487485
configuration for structured logging. If your logging configuration
488486
contains `structured: true` then it should be modified based on the
489-
[structured logging
490-
documentation](../structured_logging.md).
487+
[structured logging documentation](structured_logging.md).
491488

492489
The `structured` and `drains` logging options are now deprecated and
493490
should be replaced by standard logging configuration of `handlers` and
@@ -517,14 +514,13 @@ acts the same as the `http_client` argument previously passed to
517514

518515
## Forwarding `/_synapse/client` through your reverse proxy
519516

520-
The [reverse proxy
521-
documentation](https://github.com/matrix-org/synapse/blob/develop/docs/reverse_proxy.md)
517+
The [reverse proxy documentation](reverse_proxy.md)
522518
has been updated to include reverse proxy directives for
523519
`/_synapse/client/*` endpoints. As the user password reset flow now uses
524520
endpoints under this prefix, **you must update your reverse proxy
525521
configurations for user password reset to work**.
526522

527-
Additionally, note that the [Synapse worker documentation](https://github.com/matrix-org/synapse/blob/develop/docs/workers.md) has been updated to
523+
Additionally, note that the [Synapse worker documentation](workers.md) has been updated to
528524

529525
: state that the `/_synapse/client/password_reset/email/submit_token`
530526
endpoint can be handled
@@ -588,7 +584,7 @@ updated.
588584
When setting up worker processes, we now recommend the use of a Redis
589585
server for replication. **The old direct TCP connection method is
590586
deprecated and will be removed in a future release.** See
591-
[workers](../workers.md) for more details.
587+
[workers](workers.md) for more details.
592588
593589
# Upgrading to v1.14.0
594590
@@ -720,8 +716,7 @@ participating in many rooms.
720716
omitting the `CONCURRENTLY` keyword. Note however that this
721717
operation may in itself cause Synapse to stop running for some time.
722718
Synapse admins are reminded that [SQLite is not recommended for use
723-
outside a test
724-
environment](https://github.com/matrix-org/synapse/blob/master/README.rst#using-postgresql).
719+
outside a test environment](postgres.md).
725720
726721
3. Once the index has been created, the `SELECT` query in step 1 above
727722
should complete quickly. It is therefore safe to upgrade to Synapse
@@ -739,7 +734,7 @@ participating in many rooms.
739734
Synapse will now log a warning on start up if used with a PostgreSQL
740735
database that has a non-recommended locale set.
741736
742-
See [Postgres](../postgres.md) for details.
737+
See [Postgres](postgres.md) for details.
743738
744739
# Upgrading to v1.8.0
745740
@@ -856,8 +851,8 @@ section headed `email`, and be sure to have at least the
856851
You may also need to set `smtp_user`, `smtp_pass`, and
857852
`require_transport_security`.
858853

859-
See the [sample configuration file](docs/sample_config.yaml) for more
860-
details on these settings.
854+
See the [sample configuration file](usage/configuration/homeserver_sample_config.md)
855+
for more details on these settings.
861856

862857
#### Delegate email to an identity server
863858

@@ -959,7 +954,7 @@ back to v1.3.1, subject to the following:
959954
960955
Some counter metrics have been renamed, with the old names deprecated.
961956
See [the metrics
962-
documentation](../metrics-howto.md#renaming-of-metrics--deprecation-of-old-names-in-12)
957+
documentation](metrics-howto.md#renaming-of-metrics--deprecation-of-old-names-in-12)
963958
for details.
964959
965960
# Upgrading to v1.1.0
@@ -995,7 +990,7 @@ more details on upgrading your database.
995990
Synapse v1.0 is the first release to enforce validation of TLS
996991
certificates for the federation API. It is therefore essential that your
997992
certificates are correctly configured. See the
998-
[FAQ](../MSC1711_certificates_FAQ.md) for more information.
993+
[FAQ](MSC1711_certificates_FAQ.md) for more information.
999994
1000995
Note, v1.0 installations will also no longer be able to federate with
1001996
servers that have not correctly configured their certificates.
@@ -1010,8 +1005,8 @@ ways:-
10101005
- Configure a whitelist of server domains to trust via
10111006
`federation_certificate_verification_whitelist`.
10121007
1013-
See the [sample configuration file](docs/sample_config.yaml) for more
1014-
details on these settings.
1008+
See the [sample configuration file](usage/configuration/homeserver_sample_config.md)
1009+
for more details on these settings.
10151010
10161011
## Email
10171012
@@ -1036,8 +1031,8 @@ If you are absolutely certain that you wish to continue using an
10361031
identity server for password resets, set
10371032
`trust_identity_server_for_password_resets` to `true`.
10381033
1039-
See the [sample configuration file](docs/sample_config.yaml) for more
1040-
details on these settings.
1034+
See the [sample configuration file](usage/configuration/homeserver_sample_config.md)
1035+
for more details on these settings.
10411036
10421037
## New email templates
10431038
@@ -1057,11 +1052,11 @@ sent to them.
10571052
10581053
Please be aware that, before Synapse v1.0 is released around March 2019,
10591054
you will need to replace any self-signed certificates with those
1060-
verified by a root CA. Information on how to do so can be found at [the
1061-
ACME docs](../ACME.md).
1055+
verified by a root CA. Information on how to do so can be found at the
1056+
ACME docs.
10621057
10631058
For more information on configuring TLS certificates see the
1064-
[FAQ](../MSC1711_certificates_FAQ.md).
1059+
[FAQ](MSC1711_certificates_FAQ.md).
10651060
10661061
# Upgrading to v0.34.0
10671062

0 commit comments

Comments
 (0)