mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-21 17:15:38 +03:00
Fix broken links on docs (#16853)
Some links seemed to be incorrect (vector-im/sygnal and vector-im/sytest have never been A Thing iirc) so pointed them back to matrix-org/*).
This commit is contained in:
parent
d2674bacdb
commit
505cdd044b
6 changed files with 8 additions and 7 deletions
1
changelog.d/16853.doc
Normal file
1
changelog.d/16853.doc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Fix broken links in the documentation.
|
|
@ -329,7 +329,7 @@ This configuration should generally cover your needs.
|
||||||
- To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags.
|
- To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags.
|
||||||
- To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags).
|
- To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags).
|
||||||
|
|
||||||
For more details about other configurations, see the [Docker-specific documentation in the SyTest repo](https://github.com/vector-im/sytest/blob/develop/docker/README.md).
|
For more details about other configurations, see the [Docker-specific documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md).
|
||||||
|
|
||||||
|
|
||||||
## Run the integration tests ([Complement](https://github.com/matrix-org/complement)).
|
## Run the integration tests ([Complement](https://github.com/matrix-org/complement)).
|
||||||
|
|
|
@ -12,7 +12,7 @@ This is the main reason people have a poor matrix experience on resource constra
|
||||||
|
|
||||||
While synapse does have some performance issues with presence [#3971](https://github.com/matrix-org/synapse/issues/3971), the fundamental problem is that this is an easy feature to implement for a centralised service at nearly no overhead, but federation makes it combinatorial [#8055](https://github.com/matrix-org/synapse/issues/8055). There is also a client-side config option which disables the UI and idle tracking [enable_presence_by_hs_url] to blacklist the largest instances but I didn't notice much difference, so I recommend disabling the feature entirely at the server level as well.
|
While synapse does have some performance issues with presence [#3971](https://github.com/matrix-org/synapse/issues/3971), the fundamental problem is that this is an easy feature to implement for a centralised service at nearly no overhead, but federation makes it combinatorial [#8055](https://github.com/matrix-org/synapse/issues/8055). There is also a client-side config option which disables the UI and idle tracking [enable_presence_by_hs_url] to blacklist the largest instances but I didn't notice much difference, so I recommend disabling the feature entirely at the server level as well.
|
||||||
|
|
||||||
[enable_presence_by_hs_url]: https://github.com/vector-im/element-web/blob/v1.7.8/config.sample.json#L45
|
[enable_presence_by_hs_url]: https://github.com/element-hq/element-web/blob/v1.7.8/config.sample.json#L45
|
||||||
|
|
||||||
### Joining
|
### Joining
|
||||||
|
|
||||||
|
|
|
@ -136,8 +136,8 @@ This will install and start a systemd service called `coturn`.
|
||||||
NB: If your TLS certificate was provided by Let's Encrypt, TLS/DTLS will
|
NB: If your TLS certificate was provided by Let's Encrypt, TLS/DTLS will
|
||||||
not work with any Matrix client that uses Chromium's WebRTC library. This
|
not work with any Matrix client that uses Chromium's WebRTC library. This
|
||||||
currently includes Element Android & iOS; for more details, see their
|
currently includes Element Android & iOS; for more details, see their
|
||||||
[respective](https://github.com/vector-im/element-android/issues/1533)
|
[respective](https://github.com/element-hq/element-android/issues/1533)
|
||||||
[issues](https://github.com/vector-im/element-ios/issues/2712) as well as the underlying
|
[issues](https://github.com/element-hq/element-ios/issues/2712) as well as the underlying
|
||||||
[WebRTC issue](https://bugs.chromium.org/p/webrtc/issues/detail?id=11710).
|
[WebRTC issue](https://bugs.chromium.org/p/webrtc/issues/detail?id=11710).
|
||||||
Consider using a ZeroSSL certificate for your TURN server as a working alternative.
|
Consider using a ZeroSSL certificate for your TURN server as a working alternative.
|
||||||
|
|
||||||
|
|
|
@ -137,8 +137,8 @@ must be edited:
|
||||||
NB: If your TLS certificate was provided by Let's Encrypt, TLS/DTLS will
|
NB: If your TLS certificate was provided by Let's Encrypt, TLS/DTLS will
|
||||||
not work with any Matrix client that uses Chromium's WebRTC library. This
|
not work with any Matrix client that uses Chromium's WebRTC library. This
|
||||||
currently includes Element Android & iOS; for more details, see their
|
currently includes Element Android & iOS; for more details, see their
|
||||||
[respective](https://github.com/vector-im/element-android/issues/1533)
|
[respective](https://github.com/element-hq/element-android/issues/1533)
|
||||||
[issues](https://github.com/vector-im/element-ios/issues/2712) as well as the underlying
|
[issues](https://github.com/element-hq/element-ios/issues/2712) as well as the underlying
|
||||||
[WebRTC issue](https://bugs.chromium.org/p/webrtc/issues/detail?id=11710).
|
[WebRTC issue](https://bugs.chromium.org/p/webrtc/issues/detail?id=11710).
|
||||||
Consider using a ZeroSSL certificate for your TURN server as a working alternative.
|
Consider using a ZeroSSL certificate for your TURN server as a working alternative.
|
||||||
|
|
||||||
|
|
|
@ -629,7 +629,7 @@ worker application type.
|
||||||
|
|
||||||
You can designate generic worker to sending push notifications to
|
You can designate generic worker to sending push notifications to
|
||||||
a [push gateway](https://spec.matrix.org/v1.5/push-gateway-api/) such as
|
a [push gateway](https://spec.matrix.org/v1.5/push-gateway-api/) such as
|
||||||
[sygnal](https://github.com/vector-im/sygnal) and email.
|
[sygnal](https://github.com/matrix-org/sygnal) and email.
|
||||||
|
|
||||||
This will stop the main process sending push notifications.
|
This will stop the main process sending push notifications.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue