Ustvarite klepetalni strežnik z uporabo Matrix Synapse in Riot na CentOS 7

Matrix je odprt standardni komunikacijski protokol za decentralizirano komunikacijo v realnem času. Matrix je implementiran kot domači strežniki, ki so razporejeni po internetu; zato ni enotne točke nadzora ali neuspeha. Matrix ponuja API RESTful HTTP za ustvarjanje in upravljanje porazdeljenih strežnikov za klepet, ki vključuje pošiljanje in prejemanje sporočil, vabilo in upravljanje članov klepetalnice, vzdrževanje uporabniških računov in zagotavljanje naprednih funkcij klepeta, kot so VoIP in video klici itd. Matrix vzpostavi tudi varna sinhronizacija med domačimi strežniki, ki so razporejeni po vsem svetu.

Synapse je izvedba domačega strežnika Matrix, ki jo je napisala ekipa Matrix. Ekosistem Matrix je sestavljen iz omrežja številnih združenih domačih strežnikov, razporejenih po vsem svetu. Uporabnik Matrixa uporablja odjemalca za klepet za povezavo z domačim strežnikom, ki se nato poveže z omrežjem Matrix. Homeserver shrani zgodovino klepeta in podatke za prijavo tega določenega uporabnika.

Predpogoji

• Primerek strežnika Vultr CentOS 7.
• Uporabnik sudo .

V tej vadnici bomo matrix.example.comkot ime domene uporabili za Matrix Synapse. Zamenjajte vse pojavitve matrix.example.comz vašim dejanskim imenom domene, ki ga želite uporabiti za domači strežnik Synapse.

Posodobite svoj osnovni sistem z uporabo priročnika Kako posodobiti CentOS 7 . Ko je vaš sistem posodobljen, nadaljujte z namestitvijo Pythona.

Namestite razvojna orodja

Matrix Synapse za delovanje potrebuje Python 2.7. Python 2.7 je vnaprej nameščen v vseh primerih strežnika CentOS. Lahko preverite nameščeno različico Pythona.

python -V

Morali bi dobiti podoben rezultat.

[user@vultr ~]$ python -V
Python 2.7.5

Če spremenite privzeto različico Pythona, lahko pokvarite upravitelja skladišča YUM. Če pa želite najnovejšo različico Pythona, lahko izvedete alternativno namestitev, ne da bi zamenjali privzeti Python.

Namestite pakete v Development toolsskupini, ki so potrebni za prevajanje namestitvenih datotek.

sudo yum groupinstall -y "Development tools"

Namestite še nekaj potrebnih odvisnosti.

sudo yum -y install libtiff-devel libjpeg-devel libzip-devel freetype-devel lcms2-devel libwebp-devel tcl-devel tk-devel redhat-rpm-config python-virtualenv libffi-devel openssl-devel 

Namestite Python pip. Pip je upravitelj odvisnosti za pakete Python.

wget https://bootstrap.pypa.io/get-pip.py
sudo python get-pip.py

Namestite Synapse

Ustvarite virtualno okolje za vašo aplikacijo Synapse. Navidezno okolje Python se uporablja za ustvarjanje izoliranega virtualnega okolja za projekt Python. Navidezno okolje vsebuje lastne namestitvene imenike in ne deli knjižnic z globalnimi in drugimi navideznimi okolji.

sudo virtualenv -p python2.7 /opt/synapse

Zagotovite lastništvo imenika trenutnemu uporabniku.

sudo chown -R $USER:$USER /opt/synapse/

Zdaj aktivirajte virtualno okolje.

source /opt/synapse/bin/activate

Prepričajte se, da imate najnovejšo različico pipin setuptools.

pip install --upgrade pip 
pip install --upgrade setuptools

Namestite najnovejšo različico Synapse z uporabo pip.

pip install https://github.com/matrix-org/synapse/tarball/master

Zgornji ukaz bo trajal nekaj časa, da se izvede, ko potegne in namesti najnovejšo različico Synapse in vse odvisnosti iz skladišča Github.

Namestitev in konfiguracija PostgreSQL

Synapse uporablja SQLite kot privzeto bazo podatkov. SQLite shrani podatke v bazo podatkov, ki se hrani kot ravna datoteka na disku. Uporaba SQLite je zelo preprosta, vendar ni priporočljiva za produkcijo, saj je v primerjavi s PostgreSQL zelo počasna.

PostgreSQL je sistem objektne relacijske baze podatkov. V svoj sistem boste morali dodati repozitorij PostgreSQL, saj aplikacija ni na voljo v privzetem skladišču YUM.

sudo rpm -Uvh https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-3.noarch.rpm

Namestite strežnik baze podatkov PostgreSQL.

sudo yum -y install postgresql96-server postgresql96-contrib

Inicializirajte bazo podatkov.

sudo /usr/pgsql-9.6/bin/postgresql96-setup initdb

Uredite, /var/lib/pgsql/9.6/data/pg_hba.confda omogočite preverjanje pristnosti na podlagi MD5.

sudo nano /var/lib/pgsql/9.6/data/pg_hba.conf

Poiščite naslednje vrstice in spremenite peerv trustin idnetv md5.

# TYPE  DATABASE        USER            ADDRESS                 METHOD

# "local" is for Unix domain socket connections only
local   all             all                                     peer
# IPv4 local connections:
host    all             all             127.0.0.1/32            idnet
# IPv6 local connections:
host    all             all             ::1/128                 idnet

Ko je konfiguracija posodobljena, bi morala izgledati takole.

# TYPE  DATABASE        USER            ADDRESS                 METHOD

# "local" is for Unix domain socket connections only
local   all             all                                     trust
# IPv4 local connections:
host    all             all             127.0.0.1/32            md5
# IPv6 local connections:
host    all             all             ::1/128                 md5

Zaženite strežnik PostgreSQL in omogočite, da se samodejno zažene ob zagonu.

sudo systemctl start postgresql-9.6
sudo systemctl enable postgresql-9.6

Spremenite geslo za privzetega uporabnika PostgreSQL.

sudo passwd postgres

Vpiši se.

sudo su - postgres

Ustvarite novega uporabnika PostgreSQL za Synapse.

createuser synapse

PostgreSQL ponuja psqllupino za izvajanje poizvedb v bazi podatkov. Preklopite na lupino PostgreSQL tako, da zaženete.

psql

Nastavite geslo za novo ustvarjenega uporabnika za zbirko podatkov Synapse.

ALTER USER synapse WITH ENCRYPTED password 'DBPassword';

Zamenjajte DBPasswordz močnim geslom in si ga zapišite, saj bomo geslo uporabili pozneje. Ustvarite novo bazo podatkov za bazo podatkov PostgreSQL.

CREATE DATABASE synapse ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER synapse;

Izstopite iz psqllupine.

\q

Preklopite na sudouporabnika s trenutnega postgresuporabnika.

exit

Prav tako boste morali namestiti pakete, ki so potrebni za komunikacijo Synapse s strežnikom baze podatkov PostgreSQL.

sudo yum -y install postgresql-devel libpqxx-devel.x86_64
source /opt/synapse/bin/activate
pip install psycopg2

Konfiguriranje Synapse

Synapse zahteva konfiguracijsko datoteko, preden se lahko zažene. Konfiguracijska datoteka shranjuje nastavitve strežnika. Preklopite na virtualno okolje in ustvarite konfiguracijo za Synapse.

source /opt/synapse/bin/activate
cd /opt/synapse
python -m synapse.app.homeserver --server-name matrix.example.com --config-path homeserver.yaml --generate-config --report-stats=yes

Zamenjajte matrix.example.coms svojim dejanskim imenom domene in se prepričajte, da je ime strežnika razločljivo na naslov IP vašega primerka Vultr. Navedite --report-stats=yes, če želite strežniki za ustvarjanje poročil, zagotavljajo --report-stats=no, da onemogočite ustvarjanje poročil in statistik.

Morali bi videti podoben rezultat.

(synapse)[user@vultr synapse]$ python -m synapse.app.homeserver --server-name matrix.example.com --config-path homeserver.yaml --generate-config --report-stats=yes
A config file has been generated in 'homeserver.yaml' for server name 'matrix.example.com' with corresponding SSL keys and self-signed certificates. Please review this file and customise it to your needs.
If this server name is incorrect, you will need to regenerate the SSL certificates

Privzeto homeserver.yamlje konfiguriran za uporabo baze podatkov SQLite. Spremeniti ga moramo za uporabo baze podatkov PostgreSQL, ki smo jo ustvarili prej.

Uredite novo ustvarjeno homeserver.yaml.

nano homeserver.yaml

Poiščite obstoječo konfiguracijo baze podatkov, ki uporablja SQLite3. Komentirajte vrstice, kot je prikazano spodaj. Dodajte tudi novo konfiguracijo baze podatkov za PostgreSQL. Prepričajte se, da uporabljate pravilne poverilnice baze podatkov.

# Database configuration
#database:
  # The database engine name
  #name: "sqlite3"
  # Arguments to pass to the engine
  #args:
    # Path to the database
    #database: "/opt/synapse/homeserver.db"


database:
    name: psycopg2
    args:
        user: synapse
        password: DBPassword
        database: synapse
        host: localhost
        cp_min: 5
        cp_max: 10

Registracija novega uporabnika iz spletnega vmesnika je privzeto onemogočena. Če želite omogočiti registracijo, lahko nastavite enable_registrationna True. Nastavite lahko tudi skrivni registracijski ključ, ki omogoča registracijo vsakomur, ki ima skrivni ključ, tudi če je registracija onemogočena.

enable_registration: False

registration_shared_secret: "YPPqCPYqCQ-Rj,ws~FfeLS@maRV9vz5MnnV^r8~pP.Q6yNBDG;"

Shranite datoteko in zapustite urejevalnik. Zdaj boste morali registrirati svojega prvega uporabnika. Preden lahko registrirate novega uporabnika, morate najprej zagnati aplikacijo.

source /opt/synapse/bin/activate && cd /opt/synapse
synctl start

Videti bi morali naslednje vrstice.

2017-09-05 11:10:41,921 - twisted - 131 - INFO - - SynapseSite starting on 8008
2017-09-05 11:10:41,921 - twisted - 131 - INFO - - Starting factory <synapse.http.site.SynapseSite instance at 0x44bbc68>
2017-09-05 11:10:41,921 - synapse.app.homeserver - 201 - INFO - - Synapse now listening on port 8008
2017-09-05 11:10:41,922 - synapse.app.homeserver - 442 - INFO - - Scheduling stats reporting for 3 hour intervals
started synapse.app.homeserver('homeserver.yaml')

Registrirajte novega uporabnika Matrixa.

register_new_matrix_user -c homeserver.yaml https://localhost:8448

Videti bi morali naslednje.

(synapse)[user@vultr synapse]$ register_new_matrix_user -c homeserver.yaml https://localhost:8448
New user localpart [user]: admin
Password:
Confirm password:
Make admin [no]: yes
Sending registration request...
Success.

Nazadnje, preden lahko uporabite domači strežnik, boste morali dovoliti vrata 8448 skozi požarni zid. Pristanišče 8448se uporablja kot zaščitena zvezna vrata. Domači strežniki uporabljajo ta vrata za varno komunikacijo med seboj. Preko teh vrat lahko uporabite tudi vgrajeni odjemalec spletnega klepeta Matrix.

sudo firewall-cmd --permanent --zone=public --add-port=8448/tcp
sudo firewall-cmd --reload

You can now log in to the Matrix web chat client by going to https://matrix.example.com:8448 through your favorite browser. You will see a warning about the SSL certificate as the certificates used are self-signed. We will not use this web chat client as it is outdated and not maintained anymore. Just try to check if you can log in using the user account you just created.

Setting up Let's Encrypt Certificates

Instead of using a self-signed certificate for securing federation port, we can use Let's Encrypt free SSL. Let's Encrypt free SSL can be obtained through the official Let's Encrypt client called Certbot.

Install Certbot.

sudo yum -y install certbot

Adjust your firewall setting to allow the standard HTTP and HTTPS ports through the firewall. Certbot needs to make an HTTP connection to verify the domain authority.

sudo firewall-cmd --permanent --zone=public --add-service=http
sudo firewall-cmd --permanent --zone=public --add-service=https
sudo firewall-cmd --reload

To obtain certificates from Let's Encrypt CA, you must ensure that the domain for which you wish to generate the certificates is pointed towards the server. If it is not, then make the necessary changes to the DNS records of your domain and wait for the DNS to propagate before making the certificate request again. Certbot checks the domain authority before providing the certificates.

Now use the built-in web server in Certbot to generate the certificates for your domain.

sudo certbot certonly --standalone -d matrix.example.com

The generated certificates are likely to be stored in /etc/letsencrypt/live/matrix.example.com/. The SSL certificate will be stored as fullchain.pem and the private key will be stored as privkey.pem.

Copy the certificates.

sudo cp /etc/letsencrypt/live/matrix.example.com/fullchain.pem /opt/synapse/letsencrypt-fullchain.pem

sudo cp /etc/letsencrypt/live/matrix.example.com/privkey.pem /opt/synapse/letsencrypt-privkey.pem

You will need to change the path to the certificates and keys from the homeserver.yaml file. Edit the configuration.

nano /opt/synapse/homeserver.yaml

Find the following lines and modify the path.

tls_certificate_path: "/opt/synapse/letsencrypt-fullchain.pem"

# PEM encoded private key for TLS
tls_private_key_path: "/opt/synapse/letsencrypt-privkey.pem"

Save the file and exit from the editor. Restart the Synapse server so that the changes can take effect.

source /opt/synapse/bin/activate && cd /opt/synapse
synctl restart

Let's Encrypt certificates are due to expire in 90 days, so it is recommended that you setup auto renewal for the certificates using cron jobs. Cron is a system service which is used to run periodic tasks.

Ustvarite nov skript za obnovitev potrdil in kopirajte obnovljena potrdila v imenik Synapse.

sudo nano /opt/renew-letsencypt.sh  

Izpolnite datoteko.

#!/bin/sh

/usr/bin/certbot renew --quiet --nginx
cp /etc/letsencrypt/live/matrix.example.com/fullchain.pem /opt/synapse/letsencrypt-fullchain.pem
cp /etc/letsencrypt/live/matrix.example.com/privkey.pem /opt/synapse/letsencrypt-privkey.pem

Zagotovite dovoljenje za izvedbo.

sudo chmod +x /opt/renew-letsencypt.sh

Odprite datoteko opravila cron.

sudo crontab -e

Dodajte naslednjo vrstico na konec datoteke.

30 5 * * 1 /opt/renew-letsencypt.sh

Zgornje opravilo cron se bo izvajalo vsak ponedeljek ob 5.30. Če potrdilo poteče, jih bo samodejno podaljšalo.

Zdaj lahko obiščete https://matrix.example.com:8448. Videli boste, da pred povezavo ni opozorila SSL.

Nastavite Nginx z Let's Encrypt

Poleg zaščitenih zveznih vrat 8448Synapse posluša tudi nezaščitena vrata odjemalca 8008. Zdaj bomo Nginx konfigurirali kot povratni proxy za aplikacijo Synapse.

sudo yum -y install nginx

Ustvarite novo konfiguracijsko datoteko.

sudo nano /etc/nginx/conf.d/synapse.conf

Napolnite datoteko z naslednjo vsebino.

server {
    listen 80;
    server_name matrix.example.com;
    return 301 https://$host$request_uri;
}
server {

    listen 443;
    server_name matrix.example.com;

    ssl_certificate           /etc/letsencrypt/live/matrix.example.com/fullchain.pem;
    ssl_certificate_key       /etc/letsencrypt/live/matrix.example.com/privkey.pem;

    ssl on;
    ssl_session_cache  builtin:1000  shared:SSL:10m;
    ssl_protocols  TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
    ssl_prefer_server_ciphers on;

    access_log    /var/log/nginx/synapse.access.log;

    location /_matrix {

      proxy_pass          http://localhost:8008;
      proxy_set_header X-Forwarded-For $remote_addr;

    }
  }

Znova zaženite in omogočite, da se Nginx samodejno zažene ob zagonu.

sudo systemctl restart nginx
sudo systemctl enable nginx

Nazadnje lahko preverite, ali je do Synapse mogoče dostopati prek povratnega proxyja.

curl https://matrix.example.com/_matrix/key/v2/server/auto

Morali bi dobiti podoben rezultat.

[user@vultr ~]$ curl https://matrix.example.com/_matrix/key/v2/server/auto
{"old_verify_keys":{},"server_name":"matrix.example.com","signatures":{"matrix.example.com":{"ed25519:a_ffMf":"T/Uq/UN5vyc4w7v0azALjPIJeZx1vQ+HC6ohUGkTSqiFI4WI/ojGpb2763arwSSQLr/tP/2diCi1KLU2DEnOCQ"}},"tls_fingerprints":[{"sha256":"eorhQj/kubI2PEQZyBZvGV7K1x3EcQ7j/AO2MtZMplw"}],"valid_until_ts":1504876080512,"verify_keys":{"ed25519:a_ffMf":{"key":"Gc1hxkpPmQv71Cvjyk+uzR5UtrpmgV/UwlsLtosawEs"}}}

Nastavitev storitve Systemd

Za upravljanje procesa strežnika Synapse priporočamo uporabo storitve Systemd. Uporaba Systemd bo zagotovila, da se strežnik samodejno zažene ob zagonu sistema in napakah.

Ustvarite novo datoteko storitve Systemd.

sudo nano /etc/systemd/system/matrix-synapse.service

Izpolnite datoteko.

[Unit]
Description=Matrix Synapse service
After=network.target

[Service]
Type=forking
WorkingDirectory=/opt/synapse/
ExecStart=/opt/synapse/bin/synctl start
ExecStop=/opt/synapse/bin/synctl stop
ExecReload=/opt/synapse/bin/synctl restart
Restart=always
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=synapse

[Install]
WantedBy=multi-user.target

Zdaj lahko hitro zaženete strežnik Synapse.

sudo systemctl start matrix-synapse

Za zaustavitev ali ponovni zagon strežnika uporabite naslednje ukaze.

sudo systemctl stop matrix-synapse
sudo systemctl restart matrix-synapse

Lahko preverite stanje storitve.

sudo systemctl status matrix-synapse

Uporaba Riot

Strežnik Matrix Synapse je zdaj nameščen in konfiguriran na vašem strežniku. Ker je vgrajeni spletni odjemalec za Matrix zastarel, lahko izbirate med različnimi odjemalskimi aplikacijami, ki so na voljo za klepet. Riot je najbolj priljubljen odjemalec za klepet, ki je na voljo na skoraj vseh platformah. Uporabite lahko gostujočo različico Riotovega odjemalca za spletni klepet ali pa tudi gostite njegovo kopijo na svojem strežniku. Poleg tega lahko uporabljate tudi Riotove namizne in mobilne odjemalce za klepet, ki so na voljo za Windows, Mac, Linux, IOS in Android.

Če želite gostiti svojo lastno kopijo spletnega odjemalca Riot, lahko preberete še navodila za namestitev Riot na vaš strežnik. Za gostujoče, namizne in mobilne odjemalce lahko uporabite svoje uporabniško ime in geslo za prijavo neposredno v domači strežnik. Samo izberite my Matrix IDv spustnem meniju Sign Inmožnosti in vnesite uporabniško ime in geslo, ki ste ju ustvarili med registracijo novega uporabnika. Kliknite Custom serverin uporabite ime domene vašega primerka Synapse. Ker smo Nginx že konfigurirali, lahko uporabljamo le https://matrix.example.comkot domači strežnik in https://matrix.orgkot URL strežnika identitete.

Primer prijave v Riot

Nastavite Riot na lastnem strežniku.

Riot je tudi odprtokoden in brezplačen za gostovanje na svojem strežniku. Ne zahteva nobene baze podatkov ali odvisnosti. Ker že imamo zagnan strežnik Nginx, ga lahko gostimo na istem strežniku.

The domain or subdomain you are using for Synapse and Riot must be different to avoid cross-site scripting. However, you can use two subdomains of the same domain. In this tutorial, we will be using riot.example.com as the domain for the Riot application. Replace all occurrence of riot.example.com with your actual domain or subdomain for the Riot application.

Prenesite Riot na svoj strežnik.

cd /opt/
sudo wget https://github.com/vector-im/riot-web/releases/download/v0.12.3/riot-v0.12.3.tar.gz

Povezavo do najnovejše različice lahko vedno najdete na Riotovem Githubu .

Ekstrahirajte arhiv.

sudo tar -xzf riot-v*.tar.gz

Preimenujte imenik za udobje.

sudo mv riot-v*/ riot/

Ker smo Certbot že namestili, lahko certifikate ustvarimo neposredno. Prepričajte se, da je domena ali poddomena, ki jo uporabljate, usmerjena proti strežniku.

sudo systemctl stop nginx
sudo certbot certonly --standalone -d riot.example.com

Ustvarjena potrdila bodo verjetno shranjena v /etc/letsencrypt/live/riot.example.com/imeniku.

Ustvarite virtualni gostitelj za aplikacijo Riot.

sudo nano /etc/nginx/conf.d/riot.conf

Izpolnite datoteko.

server {
    listen 80;
    server_name riot.example.com;
    return 301 https://$host$request_uri;
}
server {

    listen 443;
    server_name riot.example.com;

    ssl_certificate           /etc/letsencrypt/live/riot.example.com/fullchain.pem;
    ssl_certificate_key       /etc/letsencrypt/live/riot.example.com/privkey.pem;

    ssl on;
    ssl_session_cache  builtin:1000  shared:SSL:10m;
    ssl_protocols  TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
    ssl_prefer_server_ciphers on;

    root /opt/riot;
    index index.html index.htm;

    location / {
            try_files $uri $uri/ =404;
    }

    access_log    /var/log/nginx/riot.access.log;

  }

Kopirajte vzorčno konfiguracijsko datoteko.

sudo cp /opt/riot/config.sample.json /opt/riot/config.json

Zdaj uredite konfiguracijsko datoteko, da naredite nekaj sprememb.

sudo nano /opt/riot/config.json

Poiščite naslednje vrstice.

"default_hs_url": "https://matrix.org",
"default_is_url": "https://vector.im",

Zamenjajte vrednost privzetega URL-ja domačega strežnika z URL-jem vašega strežnika Matrix. Za URL strežnika za identiteto lahko uporabite privzeto možnost ali pa njegovo vrednost zagotovite tudi strežniku identitete Matrix, ki je https://matrix.org.

"default_hs_url": "https://matrix.example.com",
"default_is_url": "https://matrix.org",

Shranite datoteko in zapustite. Zagotovite lastništvo datotek uporabniku Nginxa.

sudo chown -R nginx:nginx /opt/riot/

Znova zaženite Nginx.

sudo systemctl restart nginx

Do Riot lahko dostopate na https://riot.example.com. Sedaj se lahko prijavite z uporabniškim imenom in geslom, ki ste ju ustvarili prej. Lahko se povežete s privzetim strežnikom, saj smo že spremenili privzeti strežnik Matrix za našo aplikacijo.

Zdaj imate pripravljen domači strežnik Matrix Synapse. Imate tudi gostujočo kopijo Riot, ki jo lahko uporabite za pošiljanje sporočila drugim ljudem z uporabo njihovega Matrix ID-ja, e-pošte ali mobilne številke. Začnite tako, da ustvarite klepetalnico na svojem strežniku in povabite svoje prijatelje na Matrixu, da se pridružijo klepetalnici, ki ste jo ustvarili.