Búðu til spjallþjón með Matrix Synapse og Riot á CentOS 7

Forkröfur

Settu upp þróunarverkfæri

Settu upp Synapse

Uppsetning og stilling PostgreSQL

Stillir Synapse

Setja upp Let's Encrypt Certificates

Settu upp Nginx með Let's Encrypt

Setja upp Systemd þjónustuna

Að nota Riot

Settu Riot upp á þínum eigin netþjóni.

Matrix er opið staðlað samskiptareglur fyrir dreifð rauntímasamskipti. Matrix er útfært sem heimaþjónar sem er dreift yfir internetið; þess vegna er enginn einn stjórnunar- eða bilunarpunktur. Matrix býður upp á RESTful HTTP API til að búa til og hafa umsjón með dreifðum spjallþjónum sem felur í sér að senda og taka á móti skilaboðum, bjóða og stjórna meðlimum spjallrásar, viðhalda notendareikningum og veita háþróaða spjalleiginleika eins og VoIP og myndsímtöl o.s.frv. Matrix setur einnig upp a örugga samstillingu milli netþjóna heima sem eru dreift um allan heim.

Synapse er útfærsla á Matrix heimaþjóni skrifuð af Matrix teyminu. Matrix vistkerfið samanstendur af neti margra samtaka heimaþjóna sem dreift er um allan heim. Matrix notandi notar spjallbiðlara til að tengjast heimaþjóninum, sem aftur tengist Matrix netinu. Heimaþjónn geymir spjallferilinn og innskráningarupplýsingar viðkomandi notanda.

Forkröfur

• Vultr CentOS 7 netþjónstilvik.
• A sudo notandi .

Í þessari kennslu munum við nota matrix.example.comsem lén sem notað er fyrir Matrix Synapse. Skiptu út öllum tilvikum matrix.example.commeð raunverulegu léninu þínu sem þú vilt nota fyrir Synapse heimaþjóninn þinn.

Uppfærðu grunnkerfið þitt með því að nota handbókina Hvernig á að uppfæra CentOS 7 . Þegar kerfið þitt hefur verið uppfært skaltu halda áfram að setja upp Python.

Settu upp þróunarverkfæri

Matrix Synapse þarf Python 2.7 til að virka. Python 2.7 kemur foruppsett í öllum CentOS netþjónstilvikum. Þú getur athugað uppsettu útgáfuna af Python.

python -V

Þú ættir að fá svipað úttak.

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

Að breyta sjálfgefna útgáfu Python gæti brotið YUM geymslustjóra. Hins vegar, ef þú vilt nýjustu útgáfuna af Python, geturðu gert aðra uppsetningu, án þess að skipta um sjálfgefna Python.

Settu upp pakkana í Development toolshópnum sem þarf til að setja saman uppsetningarskrárnar.

sudo yum groupinstall -y "Development tools"

Settu upp nokkrar nauðsynlegar ósjálfstæðir í viðbót.

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 

Settu upp Python pip. Pip er ávanastjóri Python pakka.

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

Settu upp Synapse

Búðu til sýndarumhverfi fyrir Synapse forritið þitt. Python sýndarumhverfi er notað til að búa til einangrað sýndarumhverfi fyrir Python verkefni. Sýndarumhverfi inniheldur sínar eigin uppsetningarskrár og deilir ekki bókasöfnum með alþjóðlegu og öðru sýndarumhverfi.

sudo virtualenv -p python2.7 /opt/synapse

Veittu núverandi notanda eignarhald á skránni.

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

Virkjaðu nú sýndarumhverfið.

source /opt/synapse/bin/activate

Gakktu úr skugga um að þú sért með nýjustu útgáfuna af pipog setuptools.

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

Settu upp nýjustu útgáfuna af Synapse með því að nota pip.

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

Ofangreind skipun mun taka nokkurn tíma að framkvæma þar sem hún dregur og setur upp nýjustu útgáfuna af Synapse og öllum ósjálfstæði frá Github geymslunni.

Uppsetning og stilling PostgreSQL

Synapse notar SQLite sem sjálfgefinn gagnagrunn. SQLite geymir gögnin í gagnagrunni sem er geymdur sem flöt skrá á diski. Notkun SQLite er mjög einföld, en ekki mælt með því fyrir framleiðslu þar sem það er mjög hægt miðað við PostgreSQL.

PostgreSQL er hluttengslagagnagrunnskerfi. Þú þarft að bæta PostgreSQL geymslunni við kerfið þitt, þar sem forritið er ekki tiltækt í sjálfgefna YUM geymslunni.

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

Settu upp PostgreSQL gagnagrunnsþjóninn.

sudo yum -y install postgresql96-server postgresql96-contrib

Frumstilla gagnagrunninn.

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

Breyttu til /var/lib/pgsql/9.6/data/pg_hba.confað virkja MD5 byggða auðkenningu.

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

Finndu eftirfarandi línur og breyttu peerí trustog idnetí 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

Þegar uppfærsla hefur verið uppfærð ætti uppsetningin að líta svona út.

# 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

Ræstu PostgreSQL þjóninn og gerðu það kleift að ræsa sjálfkrafa við ræsingu.

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

Breyttu lykilorðinu fyrir sjálfgefinn PostgreSQL notanda.

sudo passwd postgres

Skrá inn.

sudo su - postgres

Búðu til nýjan PostgreSQL notanda fyrir Synapse.

createuser synapse

PostgreSQL veitir psqlskelina til að keyra fyrirspurnir í gagnagrunninum. Skiptu yfir í PostgreSQL skelina með því að keyra.

psql

Stilltu lykilorð fyrir nýstofnaðan notanda fyrir Synapse gagnagrunn.

ALTER USER synapse WITH ENCRYPTED password 'DBPassword';

Skiptu út DBPasswordfyrir sterkt lykilorð og skráðu það þar sem við munum nota lykilorðið síðar. Búðu til nýjan gagnagrunn fyrir PostgreSQL gagnagrunninn.

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

Farið úr psqlskelinni.

\q

Skiptu yfir í sudonotanda frá núverandi postgresnotanda.

exit

Þú þarft einnig að setja upp pakkana sem þarf til að Synapse geti átt samskipti við PostgreSQL gagnagrunnsþjóninn.

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

Stillir Synapse

Synapse þarf stillingarskrá áður en hægt er að ræsa hana. Stillingarskráin geymir stillingar netþjónsins. Skiptu yfir í sýndarumhverfið og búðu til stillingar fyrir 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

Replace matrix.example.com with your actual domain name and make sure that the server name is resolvable to the IP address of your Vultr instance. Provide --report-stats=yes if you want the servers to generate the reports, provide --report-stats=no to disable the generation of reports and statistics.

You should see a similar output.

(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

By default, the homeserver.yaml is configured to use a SQLite database. We need to modify it to use the PostgreSQL database we have created earlier.

Edit the newly created homeserver.yaml.

nano homeserver.yaml

Find the existing database configuration which uses SQLite3. Comment out the lines as shown below. Also, add the new database configuration for PostgreSQL. Make sure that you use the correct database credentials.

# 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

Finally, you can verify if Synapse can be accessed through the reverse proxy.

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

You should get similar output.

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

Setting up the Systemd Service

It is recommended to use the Systemd service to manage the Synapse server process. Using Systemd will ensure that the server is automatically started on system startup and failures.

Create a new Systemd service file.

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

Populate the file.

[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

Now you can quickly start the Synapse server.

sudo systemctl start matrix-synapse

To stop or restart the server using following commands.

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

You can check the status of service.

sudo systemctl status matrix-synapse

Using Riot

Matrix Synapse server is now installed and configured on your server. As the built-in web client for Matrix is outdated, you can choose from the variety of the client applications available for chat. Riot is the most popular chat client, which is available on almost all platforms. You can use the hosted version of Riot's web chat client, or you can also host a copy of it on your own server. Apart from this, you can also use Riot's desktop and mobile chat clients, which are available for Windows, Mac, Linux, IOS and Android.

If you wish to host your own copy of Riot web client, you can read further for the instructions to install Riot on your server. For hosted, desktop and mobile client, you can use your username and password to login directly to your homeserver. Just choose my Matrix ID from the dropdown menu of the Sign In option and provide the username and password you have created during the registration of a new user. Click on the Custom server and use the domain name of your Synapse instance. As we have already configured Nginx, we can just use https://matrix.example.com as the Home server and https://matrix.org as Identity server URL.

Riot Login Example

Setup Riot on Your Own Server.

Riot is also open source and free to host on your own server. It does not require any database or dependencies. As we already have an Nginx server running, we can host it on the same server.

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.

Sæktu Riot á netþjóninum þínum.

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

Þú getur alltaf fundið hlekkinn á nýjustu útgáfuna á Riot's Github .

Dragðu út skjalasafnið.

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

Endurnefna möppuna til að auðvelda meðhöndlun.

sudo mv riot-v*/ riot/

Vegna þess að við höfum þegar sett upp Certbot getum við búið til vottorðin beint. Gakktu úr skugga um að lénið eða undirlénið sem þú ert að nota bendi í átt að þjóninum.

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

Líklegt er að útbúin vottorð séu geymd í /etc/letsencrypt/live/riot.example.com/skránni.

Búðu til sýndargestgjafa fyrir Riot forritið.

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

Fylltu út skrána.

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;

  }

Afritaðu sýnishorn af stillingarskránni.

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

Breyttu nú stillingarskránni til að gera nokkrar breytingar.

sudo nano /opt/riot/config.json

Finndu eftirfarandi línur.

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

Skiptu um gildi sjálfgefna heimamiðlarans vefslóðar fyrir vefslóð Matrix netþjónsins þíns. Fyrir vefslóð auðkennisþjónsins geturðu notað sjálfgefna valmöguleikann, eða þú getur líka gefið upp gildi hans til Matrix auðkennisþjónsins, sem er https://matrix.org.

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

Vistaðu skrána og hættu. Veittu Nginx notandanum eignarhald á skránum.

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

Endurræstu Nginx.

sudo systemctl restart nginx

Þú getur fengið aðgang að Riot á https://riot.example.com. Þú getur nú skráð þig inn með notendanafninu og lykilorðinu sem þú hefur búið til áður. Þú getur tengst með því að nota sjálfgefna netþjóninn þar sem við höfum þegar breytt sjálfgefna Matrix netþjóninum fyrir forritið okkar.

Þú ert nú með Matrix Synapse heimaþjónn í gangi. Þú ert líka með hýst eintak af Riot, sem þú getur notað til að senda skilaboð til annarra með því að nota Matrix ID þeirra, tölvupóst eða farsímanúmer. Byrjaðu á því að búa til spjallrás á þjóninum þínum og bjóddu vinum þínum á Matrix að taka þátt í spjallrásinni sem þú hefur búið til.