@@ -18,19 +18,179 @@ that your email address is probably `user@example.com` rather than
18
18
19
19
## Installing Synapse
20
20
21
- ### Installing from source
21
+ ### Prebuilt packages
22
+
23
+ Prebuilt packages are available for a number of platforms. These are recommended
24
+ for most users.
25
+
26
+ #### Docker images and Ansible playbooks
27
+
28
+ There is an official synapse image available at
29
+ < https://hub.docker.com/r/matrixdotorg/synapse > which can be used with
30
+ the docker-compose file available at
31
+ [ contrib/docker] ( https://github.com/matrix-org/synapse/tree/develop/contrib/docker ) .
32
+ Further information on this including configuration options is available in the README
33
+ on hub.docker.com.
34
+
35
+ Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a
36
+ Dockerfile to automate a synapse server in a single Docker image, at
37
+ < https://hub.docker.com/r/avhost/docker-matrix/tags/ >
38
+
39
+ Slavi Pantaleev has created an Ansible playbook,
40
+ which installs the offical Docker image of Matrix Synapse
41
+ along with many other Matrix-related services (Postgres database, Element, coturn,
42
+ ma1sd, SSL support, etc.).
43
+ For more details, see
44
+ < https://github.com/spantaleev/matrix-docker-ansible-deploy >
45
+
46
+ #### Debian/Ubuntu
47
+
48
+ ##### Matrix.org packages
49
+
50
+ Matrix.org provides Debian/Ubuntu packages of Synapse, for the amd64
51
+ architecture via < https://packages.matrix.org/debian/ > .
52
+
53
+ To install the latest release:
54
+
55
+ ``` sh
56
+ sudo apt install -y lsb-release wget apt-transport-https
57
+ sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
58
+ echo " deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $( lsb_release -cs) main" |
59
+ sudo tee /etc/apt/sources.list.d/matrix-org.list
60
+ sudo apt update
61
+ sudo apt install matrix-synapse-py3
62
+ ```
63
+
64
+ Packages are also published for release candidates. To enable the prerelease
65
+ channel, add ` prerelease ` to the ` sources.list ` line. For example:
66
+
67
+ ``` sh
68
+ sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
69
+ echo " deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $( lsb_release -cs) main prerelease" |
70
+ sudo tee /etc/apt/sources.list.d/matrix-org.list
71
+ sudo apt update
72
+ sudo apt install matrix-synapse-py3
73
+ ```
74
+
75
+ The fingerprint of the repository signing key (as shown by `gpg
76
+ /usr/share/keyrings/matrix-org-archive-keyring.gpg`) is
77
+ ` AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058 ` .
78
+
79
+ ##### Downstream Debian packages
80
+
81
+ We do not recommend using the packages from the default Debian ` buster `
82
+ repository at this time, as they are old and suffer from known security
83
+ vulnerabilities. You can install the latest version of Synapse from
84
+ [ our repository] ( #matrixorg-packages ) or from ` buster-backports ` . Please
85
+ see the [ Debian documentation] ( https://backports.debian.org/Instructions/ )
86
+ for information on how to use backports.
87
+
88
+ If you are using Debian ` sid ` or testing, Synapse is available in the default
89
+ repositories and it should be possible to install it simply with:
90
+
91
+ ``` sh
92
+ sudo apt install matrix-synapse
93
+ ```
94
+
95
+ ##### Downstream Ubuntu packages
96
+
97
+ We do not recommend using the packages in the default Ubuntu repository
98
+ at this time, as they are old and suffer from known security vulnerabilities.
99
+ The latest version of Synapse can be installed from [ our repository] ( #matrixorg-packages ) .
100
+
101
+ #### Fedora
102
+
103
+ Synapse is in the Fedora repositories as ` matrix-synapse ` :
104
+
105
+ ``` sh
106
+ sudo dnf install matrix-synapse
107
+ ```
108
+
109
+ Oleg Girko provides Fedora RPMs at
110
+ < https://obs.infoserver.lv/project/monitor/matrix-synapse >
111
+
112
+ #### OpenSUSE
113
+
114
+ Synapse is in the OpenSUSE repositories as ` matrix-synapse ` :
115
+
116
+ ``` sh
117
+ sudo zypper install matrix-synapse
118
+ ```
119
+
120
+ #### SUSE Linux Enterprise Server
121
+
122
+ Unofficial package are built for SLES 15 in the openSUSE:Backports: SLE-15 repository at
123
+ < https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/ >
124
+
125
+ #### ArchLinux
126
+
127
+ The quickest way to get up and running with ArchLinux is probably with the community package
128
+ < https://www.archlinux.org/packages/community/any/matrix-synapse/ > , which should pull in most of
129
+ the necessary dependencies.
130
+
131
+ pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 ):
132
+
133
+ ``` sh
134
+ sudo pip install --upgrade pip
135
+ ```
136
+
137
+ If you encounter an error with lib bcrypt causing an Wrong ELF Class:
138
+ ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly
139
+ compile it under the right architecture. (This should not be needed if
140
+ installing under virtualenv):
141
+
142
+ ``` sh
143
+ sudo pip uninstall py-bcrypt
144
+ sudo pip install py-bcrypt
145
+ ```
146
+
147
+ #### Void Linux
148
+
149
+ Synapse can be found in the void repositories as 'synapse':
150
+
151
+ ``` sh
152
+ xbps-install -Su
153
+ xbps-install -S synapse
154
+ ```
155
+
156
+ #### FreeBSD
157
+
158
+ Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Molloy from:
159
+
160
+ - Ports: ` cd /usr/ports/net-im/py-matrix-synapse && make install clean `
161
+ - Packages: ` pkg install py37-matrix-synapse `
162
+
163
+ #### OpenBSD
164
+
165
+ As of OpenBSD 6.7 Synapse is available as a pre-compiled binary. The filesystem
166
+ underlying the homeserver directory (defaults to ` /var/synapse ` ) has to be
167
+ mounted with ` wxallowed ` (cf. ` mount(8) ` ), so creating a separate filesystem
168
+ and mounting it to ` /var/synapse ` should be taken into consideration.
169
+
170
+ Installing Synapse:
171
+
172
+ ``` sh
173
+ doas pkg_add synapse
174
+ ```
175
+
176
+ #### NixOS
177
+
178
+ Robin Lambertz has packaged Synapse for NixOS at:
179
+ < https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/matrix-synapse.nix >
180
+
181
+
182
+ ### Installing as a Python module from PyPI
22
183
23
- (Prebuilt packages are available for some platforms - see [ Prebuilt packages ] ( #prebuilt-packages ) .)
184
+ It's also possible to install Synapse as a Python module from PyPI.
24
185
25
- When installing from source please make sure that the [ Platform-specific prerequisites] ( #platform-specific-prerequisites ) are already installed.
186
+ When following this route please make sure that the [ Platform-specific prerequisites] ( #platform-specific-prerequisites ) are already installed.
26
187
27
188
System requirements:
28
189
29
190
- POSIX-compliant system (tested on Linux & OS X)
30
- - Python 3.5.2 or later, up to Python 3.9.
191
+ - Python 3.6 or later, up to Python 3.9.
31
192
- At least 1GB of free RAM if you want to join large public rooms like #matrix: matrix .org
32
193
33
-
34
194
To install the Synapse homeserver run:
35
195
36
196
``` sh
@@ -203,164 +363,6 @@ be found at <https://docs.microsoft.com/en-us/windows/wsl/install-win10> for
203
363
Windows 10 and < https://docs.microsoft.com/en-us/windows/wsl/install-on-server >
204
364
for Windows Server.
205
365
206
- ### Prebuilt packages
207
-
208
- As an alternative to installing from source, prebuilt packages are available
209
- for a number of platforms.
210
-
211
- #### Docker images and Ansible playbooks
212
-
213
- There is an official synapse image available at
214
- < https://hub.docker.com/r/matrixdotorg/synapse > which can be used with
215
- the docker-compose file available at
216
- [ contrib/docker] ( https://github.com/matrix-org/synapse/tree/develop/contrib/docker ) .
217
- Further information on this including configuration options is available in the README
218
- on hub.docker.com.
219
-
220
- Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a
221
- Dockerfile to automate a synapse server in a single Docker image, at
222
- < https://hub.docker.com/r/avhost/docker-matrix/tags/ >
223
-
224
- Slavi Pantaleev has created an Ansible playbook,
225
- which installs the offical Docker image of Matrix Synapse
226
- along with many other Matrix-related services (Postgres database, Element, coturn,
227
- ma1sd, SSL support, etc.).
228
- For more details, see
229
- < https://github.com/spantaleev/matrix-docker-ansible-deploy >
230
-
231
- #### Debian/Ubuntu
232
-
233
- ##### Matrix.org packages
234
-
235
- Matrix.org provides Debian/Ubuntu packages of Synapse via
236
- < https://packages.matrix.org/debian/ > . To install the latest release:
237
-
238
- ``` sh
239
- sudo apt install -y lsb-release wget apt-transport-https
240
- sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
241
- echo " deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $( lsb_release -cs) main" |
242
- sudo tee /etc/apt/sources.list.d/matrix-org.list
243
- sudo apt update
244
- sudo apt install matrix-synapse-py3
245
- ```
246
-
247
- Packages are also published for release candidates. To enable the prerelease
248
- channel, add ` prerelease ` to the ` sources.list ` line. For example:
249
-
250
- ``` sh
251
- sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
252
- echo " deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $( lsb_release -cs) main prerelease" |
253
- sudo tee /etc/apt/sources.list.d/matrix-org.list
254
- sudo apt update
255
- sudo apt install matrix-synapse-py3
256
- ```
257
-
258
- The fingerprint of the repository signing key (as shown by `gpg
259
- /usr/share/keyrings/matrix-org-archive-keyring.gpg`) is
260
- ` AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058 ` .
261
-
262
- ##### Downstream Debian packages
263
-
264
- We do not recommend using the packages from the default Debian ` buster `
265
- repository at this time, as they are old and suffer from known security
266
- vulnerabilities. You can install the latest version of Synapse from
267
- [ our repository] ( #matrixorg-packages ) or from ` buster-backports ` . Please
268
- see the [ Debian documentation] ( https://backports.debian.org/Instructions/ )
269
- for information on how to use backports.
270
-
271
- If you are using Debian ` sid ` or testing, Synapse is available in the default
272
- repositories and it should be possible to install it simply with:
273
-
274
- ``` sh
275
- sudo apt install matrix-synapse
276
- ```
277
-
278
- ##### Downstream Ubuntu packages
279
-
280
- We do not recommend using the packages in the default Ubuntu repository
281
- at this time, as they are old and suffer from known security vulnerabilities.
282
- The latest version of Synapse can be installed from [ our repository] ( #matrixorg-packages ) .
283
-
284
- #### Fedora
285
-
286
- Synapse is in the Fedora repositories as ` matrix-synapse ` :
287
-
288
- ``` sh
289
- sudo dnf install matrix-synapse
290
- ```
291
-
292
- Oleg Girko provides Fedora RPMs at
293
- < https://obs.infoserver.lv/project/monitor/matrix-synapse >
294
-
295
- #### OpenSUSE
296
-
297
- Synapse is in the OpenSUSE repositories as ` matrix-synapse ` :
298
-
299
- ``` sh
300
- sudo zypper install matrix-synapse
301
- ```
302
-
303
- #### SUSE Linux Enterprise Server
304
-
305
- Unofficial package are built for SLES 15 in the openSUSE:Backports: SLE-15 repository at
306
- < https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/ >
307
-
308
- #### ArchLinux
309
-
310
- The quickest way to get up and running with ArchLinux is probably with the community package
311
- < https://www.archlinux.org/packages/community/any/matrix-synapse/ > , which should pull in most of
312
- the necessary dependencies.
313
-
314
- pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 ):
315
-
316
- ``` sh
317
- sudo pip install --upgrade pip
318
- ```
319
-
320
- If you encounter an error with lib bcrypt causing an Wrong ELF Class:
321
- ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly
322
- compile it under the right architecture. (This should not be needed if
323
- installing under virtualenv):
324
-
325
- ``` sh
326
- sudo pip uninstall py-bcrypt
327
- sudo pip install py-bcrypt
328
- ```
329
-
330
- #### Void Linux
331
-
332
- Synapse can be found in the void repositories as 'synapse':
333
-
334
- ``` sh
335
- xbps-install -Su
336
- xbps-install -S synapse
337
- ```
338
-
339
- #### FreeBSD
340
-
341
- Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Molloy from:
342
-
343
- - Ports: ` cd /usr/ports/net-im/py-matrix-synapse && make install clean `
344
- - Packages: ` pkg install py37-matrix-synapse `
345
-
346
- #### OpenBSD
347
-
348
- As of OpenBSD 6.7 Synapse is available as a pre-compiled binary. The filesystem
349
- underlying the homeserver directory (defaults to ` /var/synapse ` ) has to be
350
- mounted with ` wxallowed ` (cf. ` mount(8) ` ), so creating a separate filesystem
351
- and mounting it to ` /var/synapse ` should be taken into consideration.
352
-
353
- Installing Synapse:
354
-
355
- ``` sh
356
- doas pkg_add synapse
357
- ```
358
-
359
- #### NixOS
360
-
361
- Robin Lambertz has packaged Synapse for NixOS at:
362
- < https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/matrix-synapse.nix >
363
-
364
366
## Setting up Synapse
365
367
366
368
Once you have installed synapse as above, you will need to configure it.
0 commit comments