summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/development/contributing_guide.md2
-rw-r--r--docs/other/running_synapse_on_single_board_computers.md2
-rw-r--r--docs/setup/installation.md11
-rw-r--r--docs/setup/turn/coturn.md4
-rw-r--r--docs/setup/turn/eturnal.md4
-rw-r--r--docs/website_files/version-picker.js4
-rw-r--r--docs/workers.md2
7 files changed, 20 insertions, 9 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md

index 19be6858cd..df6451273a 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md
@@ -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 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)). diff --git a/docs/other/running_synapse_on_single_board_computers.md b/docs/other/running_synapse_on_single_board_computers.md
index dcf96f0056..f06563bee3 100644 --- a/docs/other/running_synapse_on_single_board_computers.md +++ b/docs/other/running_synapse_on_single_board_computers.md
@@ -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. -[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 diff --git a/docs/setup/installation.md b/docs/setup/installation.md
index fb64c9ba4d..324cdc67b2 100644 --- a/docs/setup/installation.md +++ b/docs/setup/installation.md
@@ -326,6 +326,17 @@ Some extra dependencies may be needed. You can use Homebrew (https://brew.sh) fo You may need to install icu, and make the icu binaries and libraries accessible. Please follow [the official instructions of PyICU](https://pypi.org/project/PyICU/) to do so. +If you're struggling to get icu discovered, and see: +``` + RuntimeError: + Please install pkg-config on your system or set the ICU_VERSION environment + variable to the version of ICU you have installed. +``` +despite it being installed and having your `PATH` updated, you can omit this dependency by +not specifying `--extras all` to `poetry`. If using postgres, you can install Synapse via +`poetry install --extras saml2 --extras oidc --extras postgres --extras opentracing --extras redis --extras sentry`. +ICU is not a hard dependency on getting a working installation. + On ARM-based Macs you may also need to install libjpeg and libpq: ```sh brew install jpeg libpq diff --git a/docs/setup/turn/coturn.md b/docs/setup/turn/coturn.md
index a1bb1e934c..e5fbfa53f2 100644 --- a/docs/setup/turn/coturn.md +++ b/docs/setup/turn/coturn.md
@@ -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 not work with any Matrix client that uses Chromium's WebRTC library. This currently includes Element Android & iOS; for more details, see their - [respective](https://github.com/vector-im/element-android/issues/1533) - [issues](https://github.com/vector-im/element-ios/issues/2712) as well as the underlying + [respective](https://github.com/element-hq/element-android/issues/1533) + [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). Consider using a ZeroSSL certificate for your TURN server as a working alternative. diff --git a/docs/setup/turn/eturnal.md b/docs/setup/turn/eturnal.md
index 2e5a45673e..0db63f7aa1 100644 --- a/docs/setup/turn/eturnal.md +++ b/docs/setup/turn/eturnal.md
@@ -137,8 +137,8 @@ must be edited: 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 currently includes Element Android & iOS; for more details, see their - [respective](https://github.com/vector-im/element-android/issues/1533) - [issues](https://github.com/vector-im/element-ios/issues/2712) as well as the underlying + [respective](https://github.com/element-hq/element-android/issues/1533) + [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). Consider using a ZeroSSL certificate for your TURN server as a working alternative. diff --git a/docs/website_files/version-picker.js b/docs/website_files/version-picker.js
index bb35a7d896..b6f35f29c7 100644 --- a/docs/website_files/version-picker.js +++ b/docs/website_files/version-picker.js
@@ -54,7 +54,7 @@ function fetchVersions(dropdown, dropdownMenu) { return new Promise((resolve, reject) => { window.addEventListener("load", () => { - fetch("https://api.github.com/repos/matrix-org/synapse/git/trees/gh-pages", { + fetch("https://api.github.com/repos/element-hq/synapse/git/trees/gh-pages", { cache: "force-cache", }).then(res => res.json() @@ -124,4 +124,4 @@ function changeVersion(url, newVersion) { parsedURL.pathname = pathSegments.join('/'); return parsedURL.href; -} \ No newline at end of file +} diff --git a/docs/workers.md b/docs/workers.md
index ab6b8d47af..d19f1a9dea 100644 --- a/docs/workers.md +++ b/docs/workers.md
@@ -629,7 +629,7 @@ worker application type. You can designate generic worker to sending push notifications to 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.