meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
digital:server:matrixsynapse [2020/11/13 11:19]
natrius rss-test #4 - a minor change
digital:server:matrixsynapse [2022/01/14 00:15] (current)
natrius riot -> element; minor rewrite of Step 9
Line 1: Line 1:
 # Matrix Synapse # Matrix Synapse
  
-[[https://matrix.org/|Matrix]] is an open standard for interoperable, decentralised, real-time communication over IP. It can be used to power Instant Messaging, VoIP and Internet of Things communication - or anywhere you need a standard HTTP API for publishing and subscribing to data whilst tracking the conversation history.+[[https://matrix.org/|Matrix]] is an open standard for interoperable, decentralised, real-time communication over IP. It can be used to power Instant Messaging, VoIP and Internet of Things communication - or anywhere you need a standard HTTP API for publishing and subscribing to data whilst tracking the conversation history. 
  
 Synapse is a reference homeserver implementation from the core development team at matrix.org, written in Python/Twisted. Synapse is a reference homeserver implementation from the core development team at matrix.org, written in Python/Twisted.
Line 9: Line 9:
 This guide explains one way to setup a Synapse server. There are many other correct ways to setup a Matrix server and that is the reason why there are so many guides. Feel free to choose the guide that suits your setup the best. This guide explains one way to setup a Synapse server. There are many other correct ways to setup a Matrix server and that is the reason why there are so many guides. Feel free to choose the guide that suits your setup the best.
  
-## How to install Synapse on Ubuntu 18.04 LTS+## How to install Synapse on Ubuntu Server 18.04 LTS (and Ubuntu Server 20.04.1 LTS)
  
 ### Prerequisites ### Prerequisites
Line 63: Line 63:
     sudo systemctl enable matrix-synapse.service     sudo systemctl enable matrix-synapse.service
  
-Synapse is now up and running using the default configuration on port '8008' and '8448'. Check the open ports using ss (former netstat) command.+Synapse is now up and running using the default configuration on port '8008'. Check the open ports using ss (former netstat) command.
  
     ss -plntu     ss -plntu
Line 218: Line 218:
 } }
 </code> </code>
- 
-FIXME ''location ~ ^/.well-known/matrix/client$ {'' might need to escape the . Check it! 
- 
-FIXME Same for ''location ~ ^/.well-known/matrix/server$ {''? 
  
 Save and exit. Save and exit.
Line 306: Line 302:
 ### Step 7 - Setup UFW Firewall ### Step 7 - Setup UFW Firewall
  
-Open the needed ports for our services. We will only allow SSH, HTTP, HTTPS and 8448 (for federation) connection on the UFW firewall configuration. To add them to the UFW firewall configuration, run the following commands.+Open the needed ports for our services. We will only allow SSH, HTTP, and HTTPS connection on the UFW firewall configuration. To add them to the UFW firewall configuration, run the following commands.
  
     sudo ufw allow ssh     sudo ufw allow ssh
     sudo ufw allow http     sudo ufw allow http
     sudo ufw allow https     sudo ufw allow https
-    sudo ufw allow 8448 
  
 Now enable the UFW firewall service and then check the status. Now enable the UFW firewall service and then check the status.
Line 328: Line 323:
 ### Step 9 - Testing ### Step 9 - Testing
  
-If you have used Riot with the desktop application before you may not want to log out, so it is better to go to [[https://riot.im/app/]] and press "Launch now". If you have used the web client before, download the Riot desktop application, install it and open the Riot software. With both you will get the Matrix login page now. Type the matrix username and password, then choose the 'Custom server' option and type the domain name from your server ''homeserver.example'' in. Click the ''Sign In'' button and you will get to the Riot Dashboard.+If you have used Element with the desktop application before you may not want to log out, so it is better to go to [[https://element.io/get-started]] and press "Launch Element Web". If you have used the web client before, download the Element desktop application, install it and open Element. With both you will get login page. Type the matrix username and password that were created before, then choose the 'Custom server' option and type the domain name from your server ''homeserver.example'' in. Click the ''Sign In'' button and you will get to the Element Dashboard.
  
-The Synapse homeserver is up and running under the Nginx reverse proxy HTTPS connection, and the user is now logged in to the Synapse homeserver using the Riot application.+The Synapse homeserver is up and running under the Nginx reverse proxy HTTPS connection, and the user is now logged in to the Synapse homeserver using the Element application.
  
-If you need two instances of riot instead, you can start it with argument, refer to [[digital:software:riotim|Riot.im]].+If you need two instances of Element instead, you can start it with argument, refer to [[digital:software:riotim|Riot.im]].
  
 For another way to test it, go to ''https://homeserver.example/_matrix/static/'' and you will be presented with a ''**It works! Synapse is running**'' screen or go to ''https://homeserver.example/_matrix/client/versions'' and the output should look like the following: For another way to test it, go to ''https://homeserver.example/_matrix/static/'' and you will be presented with a ''**It works! Synapse is running**'' screen or go to ''https://homeserver.example/_matrix/client/versions'' and the output should look like the following:
Line 356: Line 351:
 ### Presence ### Presence
  
-Unfortunately presence is right now broken and generates a high load. It is possible to deactivate it, but the user avatars will be grey afterwards on the homeserver. To deactivate, open ''homeserver.yaml'' and add+Unfortunately presence is right now broken and generates a high load. Until this issue https://github.com/matrix-org/synapse/issues/3971 is resolved, i suggest in deactivating presence, but the user avatars will be grey afterwards on the homeserver. To deactivate, open
  
 <code>sudoedit /etc/matrix-synapse/homeserver.yaml</code> <code>sudoedit /etc/matrix-synapse/homeserver.yaml</code>
 +
 + and add
  
 ''%%use_presence%%: False'' ''%%use_presence%%: False''
Line 364: Line 361:
 ### Do i need a TURN-Server (ex. COTURN) ### Do i need a TURN-Server (ex. COTURN)
  
-It's only necessary when both parties are behind NAT. Otherwise 1-on-1 communication should work fine. Group-Calls via Riot will be handled with jitsi.riot.im and are not handled by the homeserver.+It's only necessary when both parties are behind NAT. Otherwise 1-on-1 communication should work fine. Group-Calls via Element will be handled with jitsi.element.io and are not handled by the homeserver.
  
 ### Port 8008 and 8448 ### Port 8008 and 8448
Line 410: Line 407:
  
 If your need help, get as much information as possible ([[#whats_my_version|Installed version]], ...) and join https://matrix.to/#/#synapse:matrix.org. If it worked before, try to remember what was changed. If your need help, get as much information as possible ([[#whats_my_version|Installed version]], ...) and join https://matrix.to/#/#synapse:matrix.org. If it worked before, try to remember what was changed.
 +
 +### Problems with sending pictures
 +
 +Open the ''%%nano nginx.conf%%'' file and find change ''%%client_max_body_size 1M;%%'' to 
 +
 +
 +<code>
 + http{
 +    ...
 +    client_max_body_size 50M;
 +    ...
 + }
 +</code>
 +
  
 ### Whats my version ### Whats my version