Skip to content

Commit

Permalink
Update docs for mac installs
Browse files Browse the repository at this point in the history
  • Loading branch information
kegsay committed Jan 25, 2024
1 parent 232adfb commit b7c9015
Showing 1 changed file with 11 additions and 0 deletions.
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 postgres`. 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 b7c9015

Please sign in to comment.