mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-18 08:54:54 +03:00
Code Issues Projects Releases Packages Wiki Activity

Add release note and update doc regarding ICU (#14712)

Browse source 
Fixes #14704.

Signed-off-by: Mathieu Velten <mathieuv@matrix.org>
This commit is contained in:
Mathieu Velten 2022-12-20 17:06:26 +01:00 committed by GitHub
parent e70f398f4a
commit eb2defc2f7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 32 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/14712.misc Normal file
View file

@ -0,0 +1 @@
Add release note and update documentation regarding optional ICU support in user search.

1
docker/Dockerfile
View file

@ -167,6 +167,7 @@ RUN \
libwebp6 \ libwebp6 \
xmlsec1 \ xmlsec1 \
libjemalloc2 \ libjemalloc2 \
libicu67 \
libssl-dev \ libssl-dev \
openssl \ openssl \
&& rm -rf /var/lib/apt/lists/* && rm -rf /var/lib/apt/lists/*

2
docs/development/contributing_guide.md
View file

@ -24,6 +24,8 @@ The code of Synapse is written in Python 3. To do pretty much anything, you'll n
Synapse can connect to PostgreSQL via the [psycopg2](https://pypi.org/project/psycopg2/) Python library. Building this library from source requires access to PostgreSQL's C header files. On Debian or Ubuntu Linux, these can be installed with `sudo apt install libpq-dev`. Synapse can connect to PostgreSQL via the [psycopg2](https://pypi.org/project/psycopg2/) Python library. Building this library from source requires access to PostgreSQL's C header files. On Debian or Ubuntu Linux, these can be installed with `sudo apt install libpq-dev`.
Synapse has an optional, improved user search with better Unicode support. For that you need the development package of `libicu`. On Debian or Ubuntu Linux, this can be installed with `sudo apt install libicu-dev`.
The source code of Synapse is hosted on GitHub. You will also need [a recent version of git](https://github.com/git-guides/install-git). The source code of Synapse is hosted on GitHub. You will also need [a recent version of git](https://github.com/git-guides/install-git).
For some tests, you will need [a recent version of Docker](https://docs.docker.com/get-docker/). For some tests, you will need [a recent version of Docker](https://docs.docker.com/get-docker/).

18
docs/setup/installation.md
View file

@ -278,7 +278,7 @@ Installing prerequisites on Ubuntu or Debian:
```sh ```sh
sudo apt install build-essential python3-dev libffi-dev \ sudo apt install build-essential python3-dev libffi-dev \
python3-pip python3-setuptools sqlite3 \ python3-pip python3-setuptools sqlite3 \
libssl-dev virtualenv libjpeg-dev libxslt1-dev libssl-dev virtualenv libjpeg-dev libxslt1-dev libicu-dev
``` ```
##### ArchLinux ##### ArchLinux
@ -287,7 +287,7 @@ Installing prerequisites on ArchLinux:
```sh ```sh
sudo pacman -S base-devel python python-pip \ sudo pacman -S base-devel python python-pip \
python-setuptools python-virtualenv sqlite3 python-setuptools python-virtualenv sqlite3 icu
``` ```
##### CentOS/Fedora ##### CentOS/Fedora
@ -297,7 +297,8 @@ Installing prerequisites on CentOS or Fedora Linux:
```sh ```sh
sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \ sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \
libwebp-devel libxml2-devel libxslt-devel libpq-devel \ libwebp-devel libxml2-devel libxslt-devel libpq-devel \
python3-virtualenv libffi-devel openssl-devel python3-devel python3-virtualenv libffi-devel openssl-devel python3-devel \
libicu-devel
sudo dnf groupinstall "Development Tools" sudo dnf groupinstall "Development Tools"
``` ```
@ -310,8 +311,12 @@ You may need to install the latest Xcode developer tools:
xcode-select --install xcode-select --install
``` ```
On ARM-based Macs you may need to install libjpeg and libpq. Some extra dependencies may be needed. You can use Homebrew (https://brew.sh) for them.
You can use Homebrew (https://brew.sh):
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.
On ARM-based Macs you may also need to install libjpeg and libpq:
```sh ```sh
brew install jpeg libpq brew install jpeg libpq
``` ```
@ -332,7 +337,8 @@ Installing prerequisites on openSUSE:
```sh ```sh
sudo zypper in -t pattern devel_basis sudo zypper in -t pattern devel_basis
sudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \ sudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \
python-devel libffi-devel libopenssl-devel libjpeg62-devel python-devel libffi-devel libopenssl-devel libjpeg62-devel \
libicu-devel
``` ```
##### OpenBSD ##### OpenBSD

16
docs/upgrade.md
View file

@ -88,6 +88,22 @@ process, for example:
dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
``` ```
# Upgrading to v1.74.0
## Unicode support in user search
This version introduces optional support for an [improved user search dealing with Unicode characters](https://github.com/matrix-org/synapse/pull/14464).
If you want to take advantage of this feature you need to install PyICU,
the ICU native dependency and its development headers
so that PyICU can build since no prebuilt wheels are available.
You can follow [the PyICU documentation](https://pypi.org/project/PyICU/) to do so,
and then do `pip install matrix-synapse[icu]` for a PyPI install.
Docker images and Debian packages need nothing specific as they already
include or specify ICU as an explicit dependency.
# Upgrading to v1.73.0 # Upgrading to v1.73.0
## Legacy Prometheus metric names have now been removed ## Legacy Prometheus metric names have now been removed