sharpetronics/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2025-11-27 00:01:53 -05:00
Code Issues Projects Releases Wiki Activity

Update docs for MacOS installs (#16854)

Browse Source 
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.
This commit is contained in:
kegsay 2024-02-06 09:27:38 +00:00 committed by GitHub
parent 505cdd044b
commit 93edd0932e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/16854.doc Normal file
View File

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

11
docs/setup/installation.md
View File

@ -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. 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. 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: On ARM-based Macs you may also need to install libjpeg and libpq:
```sh ```sh
brew install jpeg libpq brew install jpeg libpq