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.
1.103.0-whithout-watcha
kegsay 10 months ago committed by GitHub
parent 505cdd044b
commit 93edd0932e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 1
      changelog.d/16854.doc
  2. 11
      docs/setup/installation.md

@ -0,0 +1 @@
Update MacOS installation instructions to mention that libicu is optional.

@ -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

Loading…
Cancel
Save