From e5801db8305d548be2f2210366d185aef4e53127 Mon Sep 17 00:00:00 2001 From: Serban Constantin Date: Thu, 25 Mar 2021 17:31:26 +0200 Subject: [PATCH] platform specific prerequisites in source install (#9667) Make it clearer in the source install step that the platform specific prerequisites must be installed first. Signed-off-by: Serban Constantin --- INSTALL.md | 15 ++++++++------- changelog.d/9667.doc | 1 + 2 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 changelog.d/9667.doc diff --git a/INSTALL.md b/INSTALL.md index b9e3f613d..59318cb08 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -6,7 +6,7 @@ There are 3 steps to follow under **Installation Instructions**. - [Choosing your server name](#choosing-your-server-name) - [Installing Synapse](#installing-synapse) - [Installing from source](#installing-from-source) - - [Platform-Specific Instructions](#platform-specific-instructions) + - [Platform-specific prerequisites](#platform-specific-prerequisites) - [Debian/Ubuntu/Raspbian](#debianubunturaspbian) - [ArchLinux](#archlinux) - [CentOS/Fedora](#centosfedora) @@ -60,17 +60,14 @@ that your email address is probably `user@example.com` rather than (Prebuilt packages are available for some platforms - see [Prebuilt packages](#prebuilt-packages).) +When installing from source please make sure that the [Platform-specific prerequisites](#platform-specific-prerequisites) are already installed. + System requirements: - POSIX-compliant system (tested on Linux & OS X) - Python 3.5.2 or later, up to Python 3.9. - At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org -Synapse is written in Python but some of the libraries it uses are written in -C. So before we can install Synapse itself we need a working C compiler and the -header files for Python C extensions. See [Platform-Specific -Instructions](#platform-specific-instructions) for information on installing -these on various platforms. To install the Synapse homeserver run: @@ -128,7 +125,11 @@ source env/bin/activate synctl start ``` -#### Platform-Specific Instructions +#### Platform-specific prerequisites + +Synapse is written in Python but some of the libraries it uses are written in +C. So before we can install Synapse itself we need a working C compiler and the +header files for Python C extensions. ##### Debian/Ubuntu/Raspbian diff --git a/changelog.d/9667.doc b/changelog.d/9667.doc new file mode 100644 index 000000000..dec4816b4 --- /dev/null +++ b/changelog.d/9667.doc @@ -0,0 +1 @@ +Update source install documentation to mention platform prerequisites before the source install steps. \ No newline at end of file