mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 09:10:52 +00:00
deploy: 43c54ba753
This commit is contained in:
parent
39861031ee
commit
5175bccbde
6 changed files with 44 additions and 14 deletions
|
@ -164,6 +164,7 @@ recommended for development. More information about WSL can be found at
|
||||||
on Windows is not officially supported.</p>
|
on Windows is not officially supported.</p>
|
||||||
<p>The code of Synapse is written in Python 3. To do pretty much anything, you'll need <a href="https://www.python.org/downloads/">a recent version of Python 3</a>. Your Python also needs support for <a href="https://docs.python.org/3/library/venv.html">virtual environments</a>. This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running <code>sudo apt install python3-venv</code> should be enough.</p>
|
<p>The code of Synapse is written in Python 3. To do pretty much anything, you'll need <a href="https://www.python.org/downloads/">a recent version of Python 3</a>. Your Python also needs support for <a href="https://docs.python.org/3/library/venv.html">virtual environments</a>. This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running <code>sudo apt install python3-venv</code> should be enough.</p>
|
||||||
<p>Synapse can connect to PostgreSQL via the <a href="https://pypi.org/project/psycopg2/">psycopg2</a> 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 <code>sudo apt install libpq-dev</code>.</p>
|
<p>Synapse can connect to PostgreSQL via the <a href="https://pypi.org/project/psycopg2/">psycopg2</a> 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 <code>sudo apt install libpq-dev</code>.</p>
|
||||||
|
<p>Synapse has an optional, improved user search with better Unicode support. For that you need the development package of <code>libicu</code>. On Debian or Ubuntu Linux, this can be installed with <code>sudo apt install libicu-dev</code>.</p>
|
||||||
<p>The source code of Synapse is hosted on GitHub. You will also need <a href="https://github.com/git-guides/install-git">a recent version of git</a>.</p>
|
<p>The source code of Synapse is hosted on GitHub. You will also need <a href="https://github.com/git-guides/install-git">a recent version of git</a>.</p>
|
||||||
<p>For some tests, you will need <a href="https://docs.docker.com/get-docker/">a recent version of Docker</a>.</p>
|
<p>For some tests, you will need <a href="https://docs.docker.com/get-docker/">a recent version of Docker</a>.</p>
|
||||||
<p>A recent version of the Rust compiler is needed to build the native modules. The
|
<p>A recent version of the Rust compiler is needed to build the native modules. The
|
||||||
|
|
|
@ -419,18 +419,19 @@ header files for Python C extensions.</p>
|
||||||
<p>Installing prerequisites on Ubuntu or Debian:</p>
|
<p>Installing prerequisites on Ubuntu or Debian:</p>
|
||||||
<pre><code class="language-sh">sudo apt install build-essential python3-dev libffi-dev \
|
<pre><code class="language-sh">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
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="archlinux-1"><a class="header" href="#archlinux-1">ArchLinux</a></h5>
|
<h5 id="archlinux-1"><a class="header" href="#archlinux-1">ArchLinux</a></h5>
|
||||||
<p>Installing prerequisites on ArchLinux:</p>
|
<p>Installing prerequisites on ArchLinux:</p>
|
||||||
<pre><code class="language-sh">sudo pacman -S base-devel python python-pip \
|
<pre><code class="language-sh">sudo pacman -S base-devel python python-pip \
|
||||||
python-setuptools python-virtualenv sqlite3
|
python-setuptools python-virtualenv sqlite3 icu
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="centosfedora"><a class="header" href="#centosfedora">CentOS/Fedora</a></h5>
|
<h5 id="centosfedora"><a class="header" href="#centosfedora">CentOS/Fedora</a></h5>
|
||||||
<p>Installing prerequisites on CentOS or Fedora Linux:</p>
|
<p>Installing prerequisites on CentOS or Fedora Linux:</p>
|
||||||
<pre><code class="language-sh">sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \
|
<pre><code class="language-sh">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"
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="macos"><a class="header" href="#macos">macOS</a></h5>
|
<h5 id="macos"><a class="header" href="#macos">macOS</a></h5>
|
||||||
|
@ -438,8 +439,10 @@ sudo dnf groupinstall "Development Tools"
|
||||||
<p>You may need to install the latest Xcode developer tools:</p>
|
<p>You may need to install the latest Xcode developer tools:</p>
|
||||||
<pre><code class="language-sh">xcode-select --install
|
<pre><code class="language-sh">xcode-select --install
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>On ARM-based Macs you may need to install libjpeg and libpq.
|
<p>Some extra dependencies may be needed. You can use Homebrew (https://brew.sh) for them.</p>
|
||||||
You can use Homebrew (https://brew.sh):</p>
|
<p>You may need to install icu, and make the icu binaries and libraries accessible.
|
||||||
|
Please follow <a href="https://pypi.org/project/PyICU/">the official instructions of PyICU</a> to do so.</p>
|
||||||
|
<p>On ARM-based Macs you may also need to install libjpeg and libpq:</p>
|
||||||
<pre><code class="language-sh"> brew install jpeg libpq
|
<pre><code class="language-sh"> brew install jpeg libpq
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>On macOS Catalina (10.15) you may need to explicitly install OpenSSL
|
<p>On macOS Catalina (10.15) you may need to explicitly install OpenSSL
|
||||||
|
@ -452,7 +455,8 @@ export CPPFLAGS="-I/usr/local/opt/openssl/include"
|
||||||
<p>Installing prerequisites on openSUSE:</p>
|
<p>Installing prerequisites on openSUSE:</p>
|
||||||
<pre><code class="language-sh">sudo zypper in -t pattern devel_basis
|
<pre><code class="language-sh">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
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="openbsd-1"><a class="header" href="#openbsd-1">OpenBSD</a></h5>
|
<h5 id="openbsd-1"><a class="header" href="#openbsd-1">OpenBSD</a></h5>
|
||||||
<p>A port of Synapse is available under <code>net/synapse</code>. The filesystem
|
<p>A port of Synapse is available under <code>net/synapse</code>. The filesystem
|
||||||
|
@ -1767,6 +1771,16 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
|
||||||
</code></pre>
|
</code></pre>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h1 id="upgrading-to-v1740"><a class="header" href="#upgrading-to-v1740">Upgrading to v1.74.0</a></h1>
|
||||||
|
<h2 id="unicode-support-in-user-search"><a class="header" href="#unicode-support-in-user-search">Unicode support in user search</a></h2>
|
||||||
|
<p>This version introduces optional support for an <a href="https://github.com/matrix-org/synapse/pull/14464">improved user search dealing with Unicode characters</a>.</p>
|
||||||
|
<p>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.</p>
|
||||||
|
<p>You can follow <a href="https://pypi.org/project/PyICU/">the PyICU documentation</a> to do so,
|
||||||
|
and then do <code>pip install matrix-synapse[icu]</code> for a PyPI install.</p>
|
||||||
|
<p>Docker images and Debian packages need nothing specific as they already
|
||||||
|
include or specify ICU as an explicit dependency.</p>
|
||||||
<h1 id="upgrading-to-v1730"><a class="header" href="#upgrading-to-v1730">Upgrading to v1.73.0</a></h1>
|
<h1 id="upgrading-to-v1730"><a class="header" href="#upgrading-to-v1730">Upgrading to v1.73.0</a></h1>
|
||||||
<h2 id="legacy-prometheus-metric-names-have-now-been-removed"><a class="header" href="#legacy-prometheus-metric-names-have-now-been-removed">Legacy Prometheus metric names have now been removed</a></h2>
|
<h2 id="legacy-prometheus-metric-names-have-now-been-removed"><a class="header" href="#legacy-prometheus-metric-names-have-now-been-removed">Legacy Prometheus metric names have now been removed</a></h2>
|
||||||
<p>Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
|
<p>Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
|
||||||
|
@ -15037,6 +15051,7 @@ recommended for development. More information about WSL can be found at
|
||||||
on Windows is not officially supported.</p>
|
on Windows is not officially supported.</p>
|
||||||
<p>The code of Synapse is written in Python 3. To do pretty much anything, you'll need <a href="https://www.python.org/downloads/">a recent version of Python 3</a>. Your Python also needs support for <a href="https://docs.python.org/3/library/venv.html">virtual environments</a>. This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running <code>sudo apt install python3-venv</code> should be enough.</p>
|
<p>The code of Synapse is written in Python 3. To do pretty much anything, you'll need <a href="https://www.python.org/downloads/">a recent version of Python 3</a>. Your Python also needs support for <a href="https://docs.python.org/3/library/venv.html">virtual environments</a>. This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running <code>sudo apt install python3-venv</code> should be enough.</p>
|
||||||
<p>Synapse can connect to PostgreSQL via the <a href="https://pypi.org/project/psycopg2/">psycopg2</a> 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 <code>sudo apt install libpq-dev</code>.</p>
|
<p>Synapse can connect to PostgreSQL via the <a href="https://pypi.org/project/psycopg2/">psycopg2</a> 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 <code>sudo apt install libpq-dev</code>.</p>
|
||||||
|
<p>Synapse has an optional, improved user search with better Unicode support. For that you need the development package of <code>libicu</code>. On Debian or Ubuntu Linux, this can be installed with <code>sudo apt install libicu-dev</code>.</p>
|
||||||
<p>The source code of Synapse is hosted on GitHub. You will also need <a href="https://github.com/git-guides/install-git">a recent version of git</a>.</p>
|
<p>The source code of Synapse is hosted on GitHub. You will also need <a href="https://github.com/git-guides/install-git">a recent version of git</a>.</p>
|
||||||
<p>For some tests, you will need <a href="https://docs.docker.com/get-docker/">a recent version of Docker</a>.</p>
|
<p>For some tests, you will need <a href="https://docs.docker.com/get-docker/">a recent version of Docker</a>.</p>
|
||||||
<p>A recent version of the Rust compiler is needed to build the native modules. The
|
<p>A recent version of the Rust compiler is needed to build the native modules. The
|
||||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
@ -336,18 +336,19 @@ header files for Python C extensions.</p>
|
||||||
<p>Installing prerequisites on Ubuntu or Debian:</p>
|
<p>Installing prerequisites on Ubuntu or Debian:</p>
|
||||||
<pre><code class="language-sh">sudo apt install build-essential python3-dev libffi-dev \
|
<pre><code class="language-sh">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
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="archlinux-1"><a class="header" href="#archlinux-1">ArchLinux</a></h5>
|
<h5 id="archlinux-1"><a class="header" href="#archlinux-1">ArchLinux</a></h5>
|
||||||
<p>Installing prerequisites on ArchLinux:</p>
|
<p>Installing prerequisites on ArchLinux:</p>
|
||||||
<pre><code class="language-sh">sudo pacman -S base-devel python python-pip \
|
<pre><code class="language-sh">sudo pacman -S base-devel python python-pip \
|
||||||
python-setuptools python-virtualenv sqlite3
|
python-setuptools python-virtualenv sqlite3 icu
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="centosfedora"><a class="header" href="#centosfedora">CentOS/Fedora</a></h5>
|
<h5 id="centosfedora"><a class="header" href="#centosfedora">CentOS/Fedora</a></h5>
|
||||||
<p>Installing prerequisites on CentOS or Fedora Linux:</p>
|
<p>Installing prerequisites on CentOS or Fedora Linux:</p>
|
||||||
<pre><code class="language-sh">sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \
|
<pre><code class="language-sh">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"
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="macos"><a class="header" href="#macos">macOS</a></h5>
|
<h5 id="macos"><a class="header" href="#macos">macOS</a></h5>
|
||||||
|
@ -355,8 +356,10 @@ sudo dnf groupinstall "Development Tools"
|
||||||
<p>You may need to install the latest Xcode developer tools:</p>
|
<p>You may need to install the latest Xcode developer tools:</p>
|
||||||
<pre><code class="language-sh">xcode-select --install
|
<pre><code class="language-sh">xcode-select --install
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>On ARM-based Macs you may need to install libjpeg and libpq.
|
<p>Some extra dependencies may be needed. You can use Homebrew (https://brew.sh) for them.</p>
|
||||||
You can use Homebrew (https://brew.sh):</p>
|
<p>You may need to install icu, and make the icu binaries and libraries accessible.
|
||||||
|
Please follow <a href="https://pypi.org/project/PyICU/">the official instructions of PyICU</a> to do so.</p>
|
||||||
|
<p>On ARM-based Macs you may also need to install libjpeg and libpq:</p>
|
||||||
<pre><code class="language-sh"> brew install jpeg libpq
|
<pre><code class="language-sh"> brew install jpeg libpq
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>On macOS Catalina (10.15) you may need to explicitly install OpenSSL
|
<p>On macOS Catalina (10.15) you may need to explicitly install OpenSSL
|
||||||
|
@ -369,7 +372,8 @@ export CPPFLAGS="-I/usr/local/opt/openssl/include"
|
||||||
<p>Installing prerequisites on openSUSE:</p>
|
<p>Installing prerequisites on openSUSE:</p>
|
||||||
<pre><code class="language-sh">sudo zypper in -t pattern devel_basis
|
<pre><code class="language-sh">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
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h5 id="openbsd-1"><a class="header" href="#openbsd-1">OpenBSD</a></h5>
|
<h5 id="openbsd-1"><a class="header" href="#openbsd-1">OpenBSD</a></h5>
|
||||||
<p>A port of Synapse is available under <code>net/synapse</code>. The filesystem
|
<p>A port of Synapse is available under <code>net/synapse</code>. The filesystem
|
||||||
|
|
|
@ -231,6 +231,16 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
|
||||||
</code></pre>
|
</code></pre>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h1 id="upgrading-to-v1740"><a class="header" href="#upgrading-to-v1740">Upgrading to v1.74.0</a></h1>
|
||||||
|
<h2 id="unicode-support-in-user-search"><a class="header" href="#unicode-support-in-user-search">Unicode support in user search</a></h2>
|
||||||
|
<p>This version introduces optional support for an <a href="https://github.com/matrix-org/synapse/pull/14464">improved user search dealing with Unicode characters</a>.</p>
|
||||||
|
<p>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.</p>
|
||||||
|
<p>You can follow <a href="https://pypi.org/project/PyICU/">the PyICU documentation</a> to do so,
|
||||||
|
and then do <code>pip install matrix-synapse[icu]</code> for a PyPI install.</p>
|
||||||
|
<p>Docker images and Debian packages need nothing specific as they already
|
||||||
|
include or specify ICU as an explicit dependency.</p>
|
||||||
<h1 id="upgrading-to-v1730"><a class="header" href="#upgrading-to-v1730">Upgrading to v1.73.0</a></h1>
|
<h1 id="upgrading-to-v1730"><a class="header" href="#upgrading-to-v1730">Upgrading to v1.73.0</a></h1>
|
||||||
<h2 id="legacy-prometheus-metric-names-have-now-been-removed"><a class="header" href="#legacy-prometheus-metric-names-have-now-been-removed">Legacy Prometheus metric names have now been removed</a></h2>
|
<h2 id="legacy-prometheus-metric-names-have-now-been-removed"><a class="header" href="#legacy-prometheus-metric-names-have-now-been-removed">Legacy Prometheus metric names have now been removed</a></h2>
|
||||||
<p>Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
|
<p>Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
|
||||||
|
|
Loading…
Reference in a new issue