From 505cdd044bd7086996b2ec476b488837f5b89ad3 Mon Sep 17 00:00:00 2001 From: kegsay <7190048+kegsay@users.noreply.github.com> Date: Tue, 6 Feb 2024 09:26:55 +0000 Subject: 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/*). --- docs/setup/turn/coturn.md | 4 ++-- docs/setup/turn/eturnal.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/setup') 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. -- cgit 1.5.1 From 93edd0932e636252528ca4b95802f35b1a513b6e Mon Sep 17 00:00:00 2001 From: kegsay <7190048+kegsay@users.noreply.github.com> Date: Tue, 6 Feb 2024 09:27:38 +0000 Subject: Update docs for MacOS installs (#16854) ICU is an optional dependency and also a pain to install. Mention that you can just not install it and still get a working installation. --- changelog.d/16854.doc | 1 + docs/setup/installation.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 changelog.d/16854.doc (limited to 'docs/setup') diff --git a/changelog.d/16854.doc b/changelog.d/16854.doc new file mode 100644 index 0000000000..f08a5f4be2 --- /dev/null +++ b/changelog.d/16854.doc @@ -0,0 +1 @@ +Update MacOS installation instructions to mention that libicu is optional. 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 -- cgit 1.5.1