| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| computing:synapse [2024/01/30 03:15] – oemb1905 | computing:synapse [2025/04/17 20:38] (current) – oemb1905 |
|---|
| ------------------------------------------- | ------------------------------------------- |
| |
| This tutorial is for users of Debian GNU/Linux who want to create their own synapse/matrix instance. The [[https://matrix-org.github.io/synapse/latest/setup/installation.html|official documentation]] was solid and the [[https://docs.hackliberty.org/books/self-hosted-services/page/how-to-install-matrix-synapse-on-debian-11|Hack Liberty]] tutorial had many great insights. I have everything up and running now with nginx except for the MTA/email functionality. Although I originally intended to use apache, I could not get the ProxyPass for .well-known to work and it could not federate, although everything else worked fine. I will solve that issue later and post an addenda here when I do. For now, let me step you through what I did. First, the prerequisites are to set up A records for your domains, and adjust to your needs. I established gnulinux.club, matrix.gnulinux.club, element.gnulinux.club, and jitsi.gnulinux.club. After those cached, I then shelled into my VM and established ufw rules for ssh, http, https, matrix, and jitsi: | This tutorial is for users of Debian GNU/Linux who want to create their own synapse/matrix instance. The [[https://matrix-org.github.io/synapse/latest/setup/installation.html|official documentation]] was solid and the Hack Liberty tutorial at https://docs.hackliberty.org/books/self-hosted-services/page/how-to-install-matrix-synapse-on-debian-11 (now taken down) tutorial had many great insights. Let me step you through what I did. First, the prerequisites are to set up A records for your domains, and adjust to your needs. I established gnulinux.club (tld of host), matrix.gnulinux.club (home server), element.gnulinux.club (element website), and jitsi.gnulinux.club (used for video rooms). After those cached, I then shelled into my VM and established ufw rules for ssh, http, https, matrix, and jitsi: |
| |
| sudo ufw allow 22 | sudo ufw allow 22 |
| cp default element.gnulinux.club | cp default element.gnulinux.club |
| | |
| You will notice that I did not create a server block for jitsi becuase it's installer script will take care of this automatically later on. Once these are created, delete everything in the block file except the [[https://repo.haacksnetworking.org/oemb1905/haackingclub/-/blob/master/nginx/http-block.com|basic http block]] and make some small edits: | You will notice that I did not create a server block for jitsi becuase it's installer script will take care of this automatically later on. Once these are created, delete everything in the block file except the [[https://repo.haacksnetworking.org/haacknet/haackingclub/-/blob/main/configs/webservers/nginx/http-block?ref_type=heads|basic http block]] and make some small edits: |
| |
| nano /etc/nginx/sites-enabled/gnulinux.club | nano /etc/nginx/sites-enabled/gnulinux.club |
| nano /etc/nginx/sites-enabled/matrix.gnulinux.club | nano /etc/nginx/sites-enabled/matrix.gnulinux.club |
| |
| [[https://repo.haacksnetworking.org/oemb1905/haackingclub/-/blob/master/nginx/matrix-block.domain.com|matrix.gnulinux.club]] | [[https://repo.haacksnetworking.org/haacknet/haackingclub/-/blob/main/configs/webservers/nginx/nginx-matrix.gnulinux.club?ref_type=heads|matrix.gnulinux.club]] |
| | |
| As for the element.gnulinux.club block (adjusted for your domain, of course), make sure to add a directory to the end of the block directory itself. This will help later when upgrades to Element come out, because you can just re-symlink the new update. We will do the symlink later when installing the package, for now: | As for the element.gnulinux.club block (adjusted for your domain, of course), make sure to add a directory to the end of the block directory itself. This will help later when upgrades to Element come out, because you can just re-symlink the new update. We will do the symlink later when installing the package, for now: |
| register_new_matrix_user -c /etc/matrix-synapse/homeserver.yaml http://localhost:8008 | register_new_matrix_user -c /etc/matrix-synapse/homeserver.yaml http://localhost:8008 |
| | |
| Record the password you chose in a safe location, and then uncomment the user registration on ''/etc/matrix-synapse/homeserver.yaml'' again and once again restart the service ''systemctl restart matrix-synapse''. This is required because you cannot manually create users while the ''enable_registration: true'' parameter is active. Likely, you will now want to also create a non-admin user for yourself, and the webgui is very convenient for this so just visit element.gnulinux.club and then register. Once you log in, make sure that you can access federated instances, spaces, and rooms. The last thing we need to do is add the ability for the server to send emails so users can recover accounts when needed via email. To do that, first make sure you have a working [[https://wiki.haacksnetworking.org/doku.php?id=computing:exim4|https://wiki.haacksnetworking.org/doku.php?id=computing:exim4]]email server. Please note that an incoming (IMAP) server is not needed, only outgoing (smtp/MTA). Once that is setup, add the following lines to your ''/etc/matrix-synapse/homeserver.yaml'' configuration: | Record the password you chose in a safe location, and then uncomment the user registration on ''/etc/matrix-synapse/homeserver.yaml'' again and once again restart the service ''systemctl restart matrix-synapse''. This is required because you cannot manually create users while the ''enable_registration: true'' parameter is active. Likely, you will now want to also create a non-admin user for yourself, and the webgui is very convenient for this so just visit element.gnulinux.club and then register. Once you log in, make sure that you can access federated instances, spaces, and rooms. The last thing we need to do is add the ability for the server to send emails so users can recover accounts when needed via email. To do that, first make sure you have a working email server. Please note that an incoming (IMAP) server is not needed, only outgoing (smtp/MTA). Once that is setup, add the following lines to your ''/etc/matrix-synapse/homeserver.yaml'' configuration: |
| |
| sudo nano /etc/matrix-synapse/homeserver.yaml | sudo nano /etc/matrix-synapse/homeserver.yaml |
| <remote_media_lifetime: 14d> | <remote_media_lifetime: 14d> |
| | |
| Also, make sure to add the following line of code within each nginx http server block: | After this, your config should look something like this [[https://repo.haacksnetworking.org/haacknet/haackingclub/-/blob/main/configs/synapse/homeserver.yaml?ref_type=heads|example homeserver.yaml]]. Also, make sure to add the following line of code within each nginx http server block: |
| | |
| <client_max_body_size 1000M;> | <client_max_body_size 1000M;> |
| ln -s element-v1.10.12/ element | ln -s element-v1.10.12/ element |
| | |
| Make sure to have .well-knowns established for proper federating. Start with identifying the server: | Make sure to have .well-knowns established for client and support as well: |
| | |
| sudo touch /var/www/gnulinux.club/.well-known/matrix/server | |
| | |
| With the following: | |
| | |
| { "m.server": "matrix.gnulinux.club:443" } | |
| | |
| Also identify the client: | |
| | |
| sudo touch /var/www/gnulinux.club/.well-known/matrix/client | sudo touch /var/www/gnulinux.club/.well-known/matrix/client |
| More updates below when they come. | More updates below when they come. |
| |
| --- //[[jonathan@haacksnetworking.org|oemb1905]] 2024/01/30 03:09// | --- //[[alerts@haacksnetworking.org|oemb1905]] 2025/04/17 20:38// |
