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

Commit

Permalink
platform specific prerequisites in source install (#9667)
Browse files Browse the repository at this point in the history
Make it clearer in the source install step that the platform specific
prerequisites must be installed first.

Signed-off-by: Serban Constantin <serban.constantin@gmail.com>
  • Loading branch information
fuzzmz authored Mar 25, 2021
1 parent fae81f2 commit e5801db
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
15 changes: 8 additions & 7 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions changelog.d/9667.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update source install documentation to mention platform prerequisites before the source install steps.

0 comments on commit e5801db

Please sign in to comment.