From d225cfe2cabb01eb6982d26cd6d410b90934d1c2 Mon Sep 17 00:00:00 2001 From: babolivier Date: Tue, 5 Oct 2021 13:13:48 +0000 Subject: deploy: b2c5e79291b9f93cdb39c9a6f7de50e62f45e64e --- latest/setup/installation.html | 225 +++++++++++++++++++++-------------------- 1 file changed, 113 insertions(+), 112 deletions(-) (limited to 'latest/setup/installation.html') diff --git a/latest/setup/installation.html b/latest/setup/installation.html index 49bfbdd767..374ed72ca1 100644 --- a/latest/setup/installation.html +++ b/latest/setup/installation.html @@ -99,7 +99,7 @@ @@ -196,13 +196,118 @@ that your email address is probably user@example.com rather than user@email.example.com) - but doing so may require more advanced setup: see Setting up Federation.

Installing Synapse

-

Installing from source

-

(Prebuilt packages are available for some platforms - see Prebuilt packages.)

-

When installing from source please make sure that the Platform-specific prerequisites are already installed.

+

Prebuilt packages

+

Prebuilt packages are available for a number of platforms. These are recommended +for most users.

+

Docker images and Ansible playbooks

+

There is an official synapse image available at +https://hub.docker.com/r/matrixdotorg/synapse which can be used with +the docker-compose file available at +contrib/docker. +Further information on this including configuration options is available in the README +on hub.docker.com.

+

Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a +Dockerfile to automate a synapse server in a single Docker image, at +https://hub.docker.com/r/avhost/docker-matrix/tags/

+

Slavi Pantaleev has created an Ansible playbook, +which installs the offical Docker image of Matrix Synapse +along with many other Matrix-related services (Postgres database, Element, coturn, +ma1sd, SSL support, etc.). +For more details, see +https://github.com/spantaleev/matrix-docker-ansible-deploy

+

Debian/Ubuntu

+
Matrix.org packages
+

Matrix.org provides Debian/Ubuntu packages of Synapse, for the amd64 +architecture via https://packages.matrix.org/debian/.

+

To install the latest release:

+
sudo apt install -y lsb-release wget apt-transport-https
+sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
+echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" |
+    sudo tee /etc/apt/sources.list.d/matrix-org.list
+sudo apt update
+sudo apt install matrix-synapse-py3
+
+

Packages are also published for release candidates. To enable the prerelease +channel, add prerelease to the sources.list line. For example:

+
sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
+echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main prerelease" |
+    sudo tee /etc/apt/sources.list.d/matrix-org.list
+sudo apt update
+sudo apt install matrix-synapse-py3
+
+

The fingerprint of the repository signing key (as shown by gpg /usr/share/keyrings/matrix-org-archive-keyring.gpg) is +AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058.

+
Downstream Debian packages
+

We do not recommend using the packages from the default Debian buster +repository at this time, as they are old and suffer from known security +vulnerabilities. You can install the latest version of Synapse from +our repository or from buster-backports. Please +see the Debian documentation +for information on how to use backports.

+

If you are using Debian sid or testing, Synapse is available in the default +repositories and it should be possible to install it simply with:

+
sudo apt install matrix-synapse
+
+
Downstream Ubuntu packages
+

We do not recommend using the packages in the default Ubuntu repository +at this time, as they are old and suffer from known security vulnerabilities. +The latest version of Synapse can be installed from our repository.

+

Fedora

+

Synapse is in the Fedora repositories as matrix-synapse:

+
sudo dnf install matrix-synapse
+
+

Oleg Girko provides Fedora RPMs at +https://obs.infoserver.lv/project/monitor/matrix-synapse

+

OpenSUSE

+

Synapse is in the OpenSUSE repositories as matrix-synapse:

+
sudo zypper install matrix-synapse
+
+

SUSE Linux Enterprise Server

+

Unofficial package are built for SLES 15 in the openSUSE:Backports:SLE-15 repository at +https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/

+

ArchLinux

+

The quickest way to get up and running with ArchLinux is probably with the community package +https://www.archlinux.org/packages/community/any/matrix-synapse/, which should pull in most of +the necessary dependencies.

+

pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 ):

+
sudo pip install --upgrade pip
+
+

If you encounter an error with lib bcrypt causing an Wrong ELF Class: +ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly +compile it under the right architecture. (This should not be needed if +installing under virtualenv):

+
sudo pip uninstall py-bcrypt
+sudo pip install py-bcrypt
+
+

Void Linux

+

Synapse can be found in the void repositories as 'synapse':

+
xbps-install -Su
+xbps-install -S synapse
+
+

FreeBSD

+

Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Molloy from:

+ +

OpenBSD

+

As of OpenBSD 6.7 Synapse is available as a pre-compiled binary. The filesystem +underlying the homeserver directory (defaults to /var/synapse) has to be +mounted with wxallowed (cf. mount(8)), so creating a separate filesystem +and mounting it to /var/synapse should be taken into consideration.

+

Installing Synapse:

+
doas pkg_add synapse
+
+

NixOS

+

Robin Lambertz has packaged Synapse for NixOS at: +https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/matrix-synapse.nix

+

Installing as a Python module from PyPI

+

It's also possible to install Synapse as a Python module from PyPI.

+

When following this route please make sure that the Platform-specific prerequisites are already installed.

System requirements:

To install the Synapse homeserver run:

@@ -256,7 +361,7 @@ header files for Python C extensions.

python3-pip python3-setuptools sqlite3 \ libssl-dev virtualenv libjpeg-dev libxslt1-dev -
ArchLinux
+
ArchLinux

Installing prerequisites on ArchLinux:

sudo pacman -S base-devel python python-pip \
                python-setuptools python-virtualenv sqlite3
@@ -282,13 +387,13 @@ via brew and inform pip about it so that psycopg2 buil
 export LDFLAGS="-L/usr/local/opt/openssl/lib"
 export CPPFLAGS="-I/usr/local/opt/openssl/include"
-
OpenSUSE
+
OpenSUSE

Installing prerequisites on openSUSE:

sudo zypper in -t pattern devel_basis
 sudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \
                python-devel libffi-devel libopenssl-devel libjpeg62-devel
-
OpenBSD
+
OpenBSD

A port of Synapse is available under net/synapse. The filesystem underlying the homeserver directory (defaults to /var/synapse) has to be mounted with wxallowed (cf. mount(8)), so creating a separate filesystem @@ -318,110 +423,6 @@ Debian, Fedora, or source installation methods. More information about WSL can be found at https://docs.microsoft.com/en-us/windows/wsl/install-win10 for Windows 10 and https://docs.microsoft.com/en-us/windows/wsl/install-on-server for Windows Server.

-

Prebuilt packages

-

As an alternative to installing from source, prebuilt packages are available -for a number of platforms.

-

Docker images and Ansible playbooks

-

There is an official synapse image available at -https://hub.docker.com/r/matrixdotorg/synapse which can be used with -the docker-compose file available at -contrib/docker. -Further information on this including configuration options is available in the README -on hub.docker.com.

-

Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a -Dockerfile to automate a synapse server in a single Docker image, at -https://hub.docker.com/r/avhost/docker-matrix/tags/

-

Slavi Pantaleev has created an Ansible playbook, -which installs the offical Docker image of Matrix Synapse -along with many other Matrix-related services (Postgres database, Element, coturn, -ma1sd, SSL support, etc.). -For more details, see -https://github.com/spantaleev/matrix-docker-ansible-deploy

-

Debian/Ubuntu

-
Matrix.org packages
-

Matrix.org provides Debian/Ubuntu packages of Synapse via -https://packages.matrix.org/debian/. To install the latest release:

-
sudo apt install -y lsb-release wget apt-transport-https
-sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
-echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" |
-    sudo tee /etc/apt/sources.list.d/matrix-org.list
-sudo apt update
-sudo apt install matrix-synapse-py3
-
-

Packages are also published for release candidates. To enable the prerelease -channel, add prerelease to the sources.list line. For example:

-
sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
-echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main prerelease" |
-    sudo tee /etc/apt/sources.list.d/matrix-org.list
-sudo apt update
-sudo apt install matrix-synapse-py3
-
-

The fingerprint of the repository signing key (as shown by gpg /usr/share/keyrings/matrix-org-archive-keyring.gpg) is -AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058.

-
Downstream Debian packages
-

We do not recommend using the packages from the default Debian buster -repository at this time, as they are old and suffer from known security -vulnerabilities. You can install the latest version of Synapse from -our repository or from buster-backports. Please -see the Debian documentation -for information on how to use backports.

-

If you are using Debian sid or testing, Synapse is available in the default -repositories and it should be possible to install it simply with:

-
sudo apt install matrix-synapse
-
-
Downstream Ubuntu packages
-

We do not recommend using the packages in the default Ubuntu repository -at this time, as they are old and suffer from known security vulnerabilities. -The latest version of Synapse can be installed from our repository.

-

Fedora

-

Synapse is in the Fedora repositories as matrix-synapse:

-
sudo dnf install matrix-synapse
-
-

Oleg Girko provides Fedora RPMs at -https://obs.infoserver.lv/project/monitor/matrix-synapse

-

OpenSUSE

-

Synapse is in the OpenSUSE repositories as matrix-synapse:

-
sudo zypper install matrix-synapse
-
-

SUSE Linux Enterprise Server

-

Unofficial package are built for SLES 15 in the openSUSE:Backports:SLE-15 repository at -https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/

-

ArchLinux

-

The quickest way to get up and running with ArchLinux is probably with the community package -https://www.archlinux.org/packages/community/any/matrix-synapse/, which should pull in most of -the necessary dependencies.

-

pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 ):

-
sudo pip install --upgrade pip
-
-

If you encounter an error with lib bcrypt causing an Wrong ELF Class: -ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly -compile it under the right architecture. (This should not be needed if -installing under virtualenv):

-
sudo pip uninstall py-bcrypt
-sudo pip install py-bcrypt
-
-

Void Linux

-

Synapse can be found in the void repositories as 'synapse':

-
xbps-install -Su
-xbps-install -S synapse
-
-

FreeBSD

-

Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Molloy from:

- -

OpenBSD

-

As of OpenBSD 6.7 Synapse is available as a pre-compiled binary. The filesystem -underlying the homeserver directory (defaults to /var/synapse) has to be -mounted with wxallowed (cf. mount(8)), so creating a separate filesystem -and mounting it to /var/synapse should be taken into consideration.

-

Installing Synapse:

-
doas pkg_add synapse
-
-

NixOS

-

Robin Lambertz has packaged Synapse for NixOS at: -https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/matrix-synapse.nix

Setting up Synapse

Once you have installed synapse as above, you will need to configure it.

Using PostgreSQL

-- cgit 1.4.1