summary refs log tree commit diff
path: root/docs/setup/installation.md
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2024-02-06 15:27:17 +0000
committerErik Johnston <erik@matrix.org>2024-02-06 15:27:17 +0000
commitf7a8fafbc1c13c930686f9d8feaaa03a56a67553 (patch)
tree12132265317205cca849c95283c3284cb016b8e3 /docs/setup/installation.md
parentMerge branch 'release-v1.100' into matrix-org-hotfixes (diff)
parentAccept unprefixed form of MSC3981 recurse parameter (#16842) (diff)
downloadsynapse-f7a8fafbc1c13c930686f9d8feaaa03a56a67553.tar.xz
Merge remote-tracking branch 'origin/develop' into matrix-org-hotfixes
Diffstat (limited to 'docs/setup/installation.md')
-rw-r--r--docs/setup/installation.md11
1 files changed, 11 insertions, 0 deletions
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