Skip to content

Commit

Permalink
Update docs for MacOS installs (#16854)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
kegsay authored Feb 6, 2024
1 parent 505cdd0 commit 93edd09
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/16854.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update MacOS installation instructions to mention that libicu is optional.
11 changes: 11 additions & 0 deletions docs/setup/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 93edd09

Please sign in to comment.