Looge vestlusserver, kasutades CentOS 7-s Matrix Synapse ja Riot

Matrix on avatud standardne sideprotokoll detsentraliseeritud reaalajas suhtluseks. Matrixit rakendatakse koduserveritena, mida levitatakse Interneti kaudu; järelikult pole ühtset kontrolli- või tõrkepunkti. Matrix pakub RESTful HTTP API-d hajutatud vestlusserverite loomiseks ja haldamiseks, mis hõlmab sõnumite saatmist ja vastuvõtmist, jututoa liikmete kutsumist ja haldamist, kasutajakontode haldamist ning täiustatud vestlusfunktsioonide pakkumist, nagu VoIP ja videokõned jne. Matrix loob ka turvaline sünkroonimine koduserverite vahel, mis on levinud üle maailma.

Synapse on Matrixi koduserveri juurutamine, mille on kirjutanud Matrixi meeskond. Matrixi ökosüsteem koosneb paljudest koondatud koduserverite võrgust, mis on jaotatud üle kogu maailma. Matrixi kasutaja kasutab koduserveriga ühenduse loomiseks vestlusklienti, mis omakorda loob ühenduse Matrixi võrguga. Koduserver salvestab selle konkreetse kasutaja vestluste ajaloo ja sisselogimisandmed.

Eeltingimused

• Vultr CentOS 7 serveri eksemplar.
• Sudo kasutaja .

Selles õpetuses kasutame matrix.example.comMatrix Synapse'i domeeninimena. Asendage kõik esinemised matrix.example.comoma tegeliku domeeninimega, mida soovite oma Synapse'i koduserveri jaoks kasutada.

Värskendage oma baassüsteemi, kasutades juhendit CentOS 7 värskendamine . Kui teie süsteem on värskendatud, jätkake Pythoni installimisega.

Installige arendustööriistad

Matrix Synapse vajab töötamiseks Python 2.7. Python 2.7 on eelinstallitud kõikidesse CentOS-i serveri eksemplaridesse. Saate kontrollida Pythoni installitud versiooni.

python -V

Peaksite saama sarnase väljundi.

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

Pythoni vaikeversiooni muutmine võib YUM-i hoidlahalduri rikkuda. Kui soovite aga Pythoni uusimat versiooni, saate teha alternatiivse installi, ilma vaike Pythoni asendamata.

Installige installifailide koostamiseks vajalikke pakette Development toolsrühma.

sudo yum groupinstall -y "Development tools"

Installige veel mõned vajalikud sõltuvused.

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 

Installige Python pip. Pip on Pythoni pakettide sõltuvushaldur.

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

Installige Synapse

Looge oma Synapse'i rakenduse jaoks virtuaalne keskkond. Pythoni virtuaalset keskkonda kasutatakse Pythoni projekti jaoks isoleeritud virtuaalse keskkonna loomiseks. Virtuaalne keskkond sisaldab oma installikatalooge ega jaga teeke globaalsete ja muude virtuaalsete keskkondadega.

sudo virtualenv -p python2.7 /opt/synapse

Andke praegusele kasutajale kataloogi omandiõigus.

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

Nüüd aktiveerige virtuaalne keskkond.

source /opt/synapse/bin/activate

Veenduge, et teil on viimane versioon pipja setuptools.

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

Installige Synapse uusim versioon pipi abil.

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

Ülaltoodud käsu täitmine võtab aega, kuna see tõmbab ja installib Synapse'i uusima versiooni ja kõik sõltuvused Githubi hoidlast.

PostgreSQL-i installimine ja konfigureerimine

Synapse kasutab vaikeandmebaasina SQLite'i. SQLite salvestab andmed andmebaasi, mida hoitakse kindla failina kettal. SQLite'i kasutamine on väga lihtne, kuid pole tootmiseks soovitatav, kuna see on PostgreSQL-iga võrreldes väga aeglane.

PostgreSQL on objektide relatsiooniline andmebaasisüsteem. Peate oma süsteemi lisama PostgreSQL-i hoidla, kuna rakendus pole YUM-i vaikehoidlas saadaval.

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

Installige PostgreSQL andmebaasiserver.

sudo yum -y install postgresql96-server postgresql96-contrib

Initsialiseerige andmebaas.

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

Redigeerige /var/lib/pgsql/9.6/data/pg_hba.confMD5-põhise autentimise lubamiseks.

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

Leia järgmised read ja muuda peeret trustja idnetet 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

Pärast värskendamist peaks konfiguratsioon välja nägema selline.

# 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

Käivitage PostgreSQL-server ja lubage see alglaadimisel automaatselt käivituda.

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

Muutke PostgreSQL-i vaikekasutaja parooli.

sudo passwd postgres

Logi sisse.

sudo su - postgres

Looge Synapse jaoks uus PostgreSQL-i kasutaja.

createuser synapse

PostgreSQL pakub psqlandmebaasis päringute käitamiseks kesta. Lülituge PostgreSQL-i kestale käivitades.

psql

Määrake Synapse'i andmebaasi vastloodud kasutajale parool.

ALTER USER synapse WITH ENCRYPTED password 'DBPassword';

Asendage DBPasswordtugeva parooliga ja märkige see üles, kuna kasutame seda parooli hiljem. Looge PostgreSQL-i andmebaasi jaoks uus andmebaas.

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

Väljuge psqlkestast.

\q

Lülituge sudopraeguselt postgreskasutajalt kasutajale.

exit

Samuti peate installima Synapse'i jaoks PostgreSQL-i andmebaasiserveriga suhtlemiseks vajalikud paketid.

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

Synapse'i seadistamine

Synapse vajab enne käivitamist konfiguratsioonifaili. Konfiguratsioonifail salvestab serveri sätted. Lülituge virtuaalsesse keskkonda ja looge Synapse'i konfiguratsioon.

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

Asendage matrix.example.comoma tegeliku domeeninimega ja veenduge, et serveri nimi oleks lahendatav teie Vultri eksemplari IP-aadressiga. Anda --report-stats=yeskui soovite serverid, et genereerida aruandeid, pakkuda --report-stats=novälja lülitada põlvkonna aruannete ja statistika.

Peaksite nägema sarnast väljundit.

(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

Vaikimisi homeserver.yamlon see konfigureeritud kasutama SQLite'i andmebaasi. Peame seda muutma, et kasutada varem loodud PostgreSQL-i andmebaasi.

Redigeerige vastloodud homeserver.yaml.

nano homeserver.yaml

Otsige üles olemasolev andmebaasi konfiguratsioon, mis kasutab SQLite3. Kommenteerige read, nagu allpool näidatud. Lisage ka PostgreSQL-i jaoks uus andmebaasi konfiguratsioon. Veenduge, et kasutate õigeid andmebaasi mandaate.

# 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

Registration of a new user from a web interface is disabled by default. To enable registration, you can set enable_registration to True. You can also set a secret registration key, which allows anyone to register who has the secret key, even if registration is disabled.

enable_registration: False

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

Save the file and exit from the editor. Now you will need to register your first user. Before you can register a new user, though, you will need to start the application first.

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

You should see the following lines.

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')

Register a new Matrix user.

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

You should see the following.

(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.

Finally, before you can use the Homeserver, you will need to allow port 8448 through the Firewall. Port 8448 is used as the secured federation port. Homeservers use this port to communicate with each other securely. You can also use the built-in Matrix web chat client through this port.

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.

Create a new script to renew certificates and copy the renewed certificates to the Synapse directory.

sudo nano /opt/renew-letsencypt.sh  

Populate the file.

#!/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

Provide the execution permission.

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

Open the cron job file.

sudo crontab -e

Add the following line at the end of the file.

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

The above cron job will run every Monday at 5:30 AM. If the certificate is due to expire, it will automatically renew them.

Now you can visit https://matrix.example.com:8448. You will see that there is no SSL warning before connection.

Setup Nginx With Let's Encrypt

Apart from the secured federation port 8448, Synapse also listens to the unsecured client port 8008. We will now configure Nginx as a reverse proxy to the Synapse application.

sudo yum -y install nginx

Create a new configuration file.

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

Populate the file with the following content.

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;

    }
  }

Restart and enable Nginx to automatically start at boot time.

sudo systemctl restart nginx
sudo systemctl enable nginx

Lõpuks saate kontrollida, kas Synapse'ile pääseb juurde pöördpuhverserveri kaudu.

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

Peaksite saama sarnase väljundi.

[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"}}}

Systemd teenuse seadistamine

Synapse serveri protsessi haldamiseks on soovitatav kasutada teenust Systemd. Systemdi kasutamine tagab serveri automaatse käivitamise süsteemi käivitamisel ja tõrgete korral.

Looge uus Systemd teenusefail.

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

Täitke fail.

[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

Nüüd saate Synapse serveri kiiresti käivitada.

sudo systemctl start matrix-synapse

Serveri peatamiseks või taaskäivitamiseks järgmiste käskude abil.

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

Saate kontrollida teenuse olekut.

sudo systemctl status matrix-synapse

Rioti kasutamine

Matrix Synapse server on nüüd teie serverisse installitud ja konfigureeritud. Kuna Matrixi sisseehitatud veebiklient on aegunud, saate valida erinevate vestluseks saadaolevate kliendirakenduste hulgast . Riot on kõige populaarsem vestlusklient, mis on saadaval peaaegu kõigil platvormidel. Võite kasutada Rioti veebivestluskliendi hostitud versiooni või majutada selle koopiat oma serveris. Peale selle saate kasutada ka Rioti töölaua- ja mobiilivestluskliente, mis on saadaval Windowsi, Maci, Linuxi, IOS-i ja Androidi jaoks.

Kui soovite majutada oma Rioti veebikliendi koopiat, lugege edasi juhiseid Rioti serverisse installimiseks. Hostitud, lauaarvuti- ja mobiilkliendi puhul saate oma kasutajanime ja parooliga otse oma koduserverisse sisse logida. Valige lihtsalt my Matrix IDrippmenüüst Sign Invalik ja sisestage uue kasutaja registreerimisel loodud kasutajanimi ja parool. Klõpsake Custom serverja kasutage oma Synapse'i eksemplari domeeninime. Kuna oleme Nginxi juba konfigureerinud, saame seda kasutada lihtsalt https://matrix.example.comkoduserveri ja https://matrix.orgidentiteediserveri URL-ina.

Riot sisselogimise näide

Seadistage Riot oma serveris.

Riot on ka avatud lähtekoodiga ja seda saab tasuta oma serveris majutada. See ei nõua andmebaasi ega sõltuvusi. Kuna meil juba töötab Nginxi server, saame seda samas serveris majutada.

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.

Laadige oma serverisse alla Riot.

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

Viimase versiooni lingi leiate alati Riot's Githubist .

Tõmmake arhiiv välja.

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

Käsitsemise mugavuse huvides nimetage kataloog ümber.

sudo mv riot-v*/ riot/

Kuna oleme Certboti juba installinud, saame sertifikaadid otse genereerida. Veenduge, et teie kasutatav domeen või alamdomeen on suunatud serveri poole.

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

Loodud sertifikaadid salvestatakse tõenäoliselt /etc/letsencrypt/live/riot.example.com/kataloogi.

Looge rakendusele Riot virtuaalne host.

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

Täitke fail.

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;

  }

Kopeerige näidiskonfiguratsioonifail.

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

Nüüd redigeerige konfiguratsioonifaili, et teha mõned muudatused.

sudo nano /opt/riot/config.json

Otsige üles järgmised read.

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

Asendage koduserveri vaike-URL-i väärtus oma Matrixi serveri URL-iga. Identiteediserveri URL-i jaoks saate kasutada vaikevalikut või anda selle väärtuse ka Matrixi identiteediserverile, milleks on https://matrix.org.

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

Salvestage fail ja väljuge. Andke failide omandiõigus Nginxi kasutajale.

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

Taaskäivitage Nginx.

sudo systemctl restart nginx

Riotile pääsete juurde aadressil https://riot.example.com. Nüüd saate sisse logida varem loodud kasutajanime ja parooliga. Saate ühenduse luua vaikeserveri abil, kuna oleme juba muutnud oma rakenduse Matrixi vaikeserverit.

Nüüd on teil Matrix Synapse'i koduserver üleval ja töötab. Teil on ka hostitud Rioti koopia, mida saate kasutada teistele inimestele sõnumi saatmiseks, kasutades nende Matrixi ID-d, e-posti või mobiilinumbrit. Alustage oma serverisse jututoa loomisega ja kutsuge oma sõpru Matrixis enda loodud jututoaga liituma.