Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit e5801db

Browse files
authored
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 <[email protected]>
1 parent fae81f2 commit e5801db

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

INSTALL.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ There are 3 steps to follow under **Installation Instructions**.
66
- [Choosing your server name](#choosing-your-server-name)
77
- [Installing Synapse](#installing-synapse)
88
- [Installing from source](#installing-from-source)
9-
- [Platform-Specific Instructions](#platform-specific-instructions)
9+
- [Platform-specific prerequisites](#platform-specific-prerequisites)
1010
- [Debian/Ubuntu/Raspbian](#debianubunturaspbian)
1111
- [ArchLinux](#archlinux)
1212
- [CentOS/Fedora](#centosfedora)
@@ -60,17 +60,14 @@ that your email address is probably `[email protected]` rather than
6060

6161
(Prebuilt packages are available for some platforms - see [Prebuilt packages](#prebuilt-packages).)
6262

63+
When installing from source please make sure that the [Platform-specific prerequisites](#platform-specific-prerequisites) are already installed.
64+
6365
System requirements:
6466

6567
- POSIX-compliant system (tested on Linux & OS X)
6668
- Python 3.5.2 or later, up to Python 3.9.
6769
- At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org
6870

69-
Synapse is written in Python but some of the libraries it uses are written in
70-
C. So before we can install Synapse itself we need a working C compiler and the
71-
header files for Python C extensions. See [Platform-Specific
72-
Instructions](#platform-specific-instructions) for information on installing
73-
these on various platforms.
7471

7572
To install the Synapse homeserver run:
7673

@@ -128,7 +125,11 @@ source env/bin/activate
128125
synctl start
129126
```
130127

131-
#### Platform-Specific Instructions
128+
#### Platform-specific prerequisites
129+
130+
Synapse is written in Python but some of the libraries it uses are written in
131+
C. So before we can install Synapse itself we need a working C compiler and the
132+
header files for Python C extensions.
132133

133134
##### Debian/Ubuntu/Raspbian
134135

changelog.d/9667.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update source install documentation to mention platform prerequisites before the source install steps.

0 commit comments

Comments
 (0)