CentOS 7でMatrix SynapseとRiotを使用してチャットサーバーを作成する

• 前提条件
• 開発ツールをインストールする
• Synapseをインストールする
• PostgreSQLのインストールと構成
• シナプスの構成
• Let's Encrypt証明書のセットアップ
• Let's EncryptでNginxをセットアップする
• Systemdサービスのセットアップ
• Riotの使用
• 自分のサーバーにRiotをセットアップします。

Matrixは、分散型リアルタイム通信用のオープンスタンダードの通信プロトコルです。Matrixは、インターネット経由で配布されるホームサーバーとして実装されます。したがって、単一の制御点や障害はありません。Matrixは、メッセージの送受信、チャットルームメンバーの招待と管理、ユーザーアカウントの維持、VoIPやビデオ通話などの高度なチャット機能の提供など、分散型チャットサーバーを作成および管理するためのRESTful HTTP APIを提供します。Matrixは、世界中に分散しているホームサーバー間の安全な同期。

Synapseは、Matrixチームが作成したMatrixホームサーバーの実装です。Matrixエコシステムは、世界中に分散された多くのフェデレーションホームサーバーのネットワークで構成されています。Matrixユーザーは、チャットクライアントを使用してホームサーバーに接続し、ホームサーバーはMatrixネットワークに接続します。ホームサーバーは、特定のユーザーのチャット履歴とログイン情報を保存します。

前提条件

• Vultr CentOS 7サーバーインスタンス。
• sudoのユーザー。

このチュートリアルではmatrix.example.com、Matrix Synapseに使用されるドメイン名として使用します。のすべての出現matrix.example.com箇所を、Synapseホームサーバーに使用する実際のドメイン名に置き換えます。

CentOS 7のアップデート方法ガイドを使用して、ベースシステムをアップデートします。システムが更新されたら、Pythonのインストールに進みます。

開発ツールをインストールする

Matrix Synapseが機能するには、Python 2.7が必要です。Python 2.7はすべてのCentOSサーバーインスタンスにプリインストールされています。インストールされているPythonのバージョンを確認できます。

python -V

同様の出力が得られるはずです。

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

Pythonのデフォルトバージョンを変更すると、YUMリポジトリマネージャーが機能しなくなる可能性があります。ただし、最新バージョンのPythonが必要な場合は、デフォルトのPythonを置き換えることなく、代替インストールを行うことができます。

Development toolsインストーラーファイルのコンパイルに必要なパッケージをグループにインストールします。

sudo yum groupinstall -y "Development tools"

さらにいくつかの必要な依存関係をインストールします。

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 

Python pipをインストールします。PipはPythonパッケージの依存関係マネージャーです。

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

Synapseをインストールする

Synapseアプリケーションの仮想環境を作成します。Python仮想環境は、Pythonプロジェクト用の分離された仮想環境を作成するために使用されます。仮想環境には独自のインストールディレクトリが含まれ、グローバル環境や他の仮想環境とライブラリを共有しません。

sudo virtualenv -p python2.7 /opt/synapse

現在のユーザーにディレクトリの所有権を提供します。

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

次に、仮想環境をアクティブ化します。

source /opt/synapse/bin/activate

pipおよびの最新バージョンを使用していることを確認してくださいsetuptools。

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

pipを使用してSynapseの最新バージョンをインストールします。

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

上記のコマンドは、最新バージョンのSynapseとすべての依存関係をGithubリポジトリから取得してインストールするため、実行に時間がかかります。

PostgreSQLのインストールと構成

SynapseはSQLiteをデフォルトのデータベースとして使用します。SQLiteは、データをディスクにフラットファイルとして保持されるデータベースに格納します。SQLiteの使用は非常に簡単ですが、PostgreSQLに比べて非常に遅いため、本番環境にはお勧めしません。

PostgreSQLはオブジェクトリレーショナルデータベースシステムです。アプリケーションはデフォルトのYUMリポジトリでは利用できないため、システムにPostgreSQLリポジトリを追加する必要があります。

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

PostgreSQLデータベースサーバーをインストールします。

sudo yum -y install postgresql96-server postgresql96-contrib

データベースを初期化します。

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

を編集し/var/lib/pgsql/9.6/data/pg_hba.confて、MD5ベースの認証を有効にします。

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

次の行と変更検索peerするtrustと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

更新すると、構成は次のようになります。

# 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

PostgreSQLサーバーを起動し、起動時に自動的に起動するようにします。

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

デフォルトのPostgreSQLユーザーのパスワードを変更します。

sudo passwd postgres

ログインする。

sudo su - postgres

Synapseの新しいPostgreSQLユーザーを作成します。

createuser synapse

PostgreSQLは、psqlデータベースでクエリを実行するためのシェルを提供します。実行して、PostgreSQLシェルに切り替えます。

psql

Synapseデータベース用に新しく作成したユーザーのパスワードを設定します。

ALTER USER synapse WITH ENCRYPTED password 'DBPassword';

DBPassword強力なパスワードに置き換えて、後でパスワードを使用するため、メモしておきます。PostgreSQLデータベース用の新しいデータベースを作成します。

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

psqlシェルを終了します。

\q

sudo現在のユーザーからユーザーに切り替えpostgresます。

exit

SynapseがPostgreSQLデータベースサーバーと通信するために必要なパッケージもインストールする必要があります。

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

シナプスの構成

Synapseを起動するには、構成ファイルが必要です。構成ファイルには、サーバー設定が格納されます。仮想環境に切り替えて、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

matrix.example.com実際のドメイン名に置き換え、サー��ー名がVultrインスタンスのIPアドレスに解決可能であることを確認します。--report-stats=yesサーバーでレポートを生成する場合--report-stats=noは、レポートと統計の生成を無効にするように指定します。

同様の出力が表示されるはずです。

(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

デフォルトでは、homeserver.yamlはSQLiteデータベースを使用するように設定されています。以前に作成したPostgreSQLデータベースを使用するように変更する必要があります。

新しく作成したを編集し homeserver.yamlます。

nano homeserver.yaml

SQLite3を使用する既存のデータベース構成を見つけます。以下のように行をコメント化します。また、PostgreSQLの新しいデータベース構成を追加します。正しいデータベース資格情報を使用していることを確認してください。

# 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

デフォルトでは、Webインターフェースからの新規ユーザーの登録は無効になっています。登録を有効にするには、設定することができますenable_registrationにTrue。秘密登録キーを設定することもできます。これにより、登録が無効になっている場合でも、誰でもその秘密キーを持つ人を登録できます。

enable_registration: False

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

ファイルを保存して、エディターを終了します。次に、最初のユーザーを登録する必要があります。ただし、新しいユーザーを登録する前に、まずアプリケーションを起動する必要があります。

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

次の行が表示されます。

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

新しいMatrixユーザーを登録します。

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

次のようになります。

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

最後に、ホームサーバーを使用する前に、ポート8448がファイアウォールを通過できるようにする必要があります。ポート8448は、保護されたフェデレーションポートとして使用されます。ホームサーバーはこのポートを使用して、互いに安全に通信します。このポートを介して、組み込みのMatrix Webチャットクライアントを使用することもできます。

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

これでhttps://matrix.example.com:8448、お気に入りのブラウザーを使用してMatrix Webチャットクライアントにログインできます。使用される証明書は自己署名されているため、SSL証明書に関する警告が表示されます。このWebチャットクライアントは古く、メンテナンスされていないため、使用しません。作成したユーザーアカウントを使用してログインできるかどうかを確認してください。

Let's Encrypt証明書のセットアップ

フェデレーションポートを保護するために自己署名証明書を使用する代わりに、Let's Encryptの無料SSLを使用できます。Let's Encryptの無料SSLは、Certbotと呼ばれる公式のLet's Encryptクライアントから入手できます。

Certbotをインストールします。

sudo yum -y install certbot

ファイアウォールの設定を調整して、標準HTTPとHTTPSポートがファイアウォールを通過できるようにします。CertbotはHTTP、ドメイン権限を確認するために接続を行う必要があります。

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

Let's Encrypt CAから証明書を取得するには、証明書を生成するドメインがサーバーに向けられていることを確認する必要があります。そうでない場合は、ドメインのDNSレコードに必要な変更を加え、DNSが伝播するのを待ってから、証明書要求を再度行ってください。証明書ボットは、証明書を提供する前にドメイン認証局をチェックします。

次に、Certbotの組み込みWebサーバーを使用して、ドメインの証明書を生成します。

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

生成された証明書は、おそらくに保存され/etc/letsencrypt/live/matrix.example.com/ます。SSL証明書はとして保存されfullchain.pem、秘密鍵はとして保存されprivkey.pemます。

証明書をコピーします。

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

homeserver.yamlファイルから証明書とキーへのパスを変更する必要があります。構成を編集します。

nano /opt/synapse/homeserver.yaml

次の行を見つけてパスを変更します。

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

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

ファイルを保存して、エディターを終了します。Synapseサーバーを再起動して、変更を有効にします。

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

Let's Encrypt証明書は90日で期限が切れるので、cronジョブを使用して証明書の自動更新を設定することをお勧めします。Cronは、定期的なタスクを実行するために使用されるシステムサービスです。

証明書を更新する新しいスクリプトを作成し、更新した証明書をSynapseディレクトリにコピーします。

sudo nano /opt/renew-letsencypt.sh  

ファイルに入力します。

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

実行権限を付与します。

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

cronジョブファイルを開きます。

sudo crontab -e

ファイルの最後に次の行を追加します。

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

上記のcronジョブは、毎週月曜日の午前5時30分に実行されます。証明書の有効期限が切れる場合は、自動的に更新されます。

これでにアクセスできますhttps://matrix.example.com:8448。接続前にSSL警告が表示されないことがわかります。

Let's EncryptでNginxをセットアップする

保護されたフェデレーションポートとは別に8448、Synapse は保護されていないクライアントポートもリッスンします8008。次に、NginxをSynapseアプリケーションのリバースプロキシとして構成します。

sudo yum -y install nginx

新しい構成ファイルを作成します。

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

ファイルに次の内容を入力します。

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;

    }
  }

再起動し、Nginxが起動時に自動的に開始するようにします。

sudo systemctl restart nginx
sudo systemctl enable nginx

最後に、リバースプロキシを介してSynapseにアクセスできるかどうかを確認できます。

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

同様の出力が得られるはずです。

[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サービスのセットアップ

Synapseサーバープロセスを管理するには、Systemdサービスを使用することをお勧めします。Systemdを使用すると、システムの起動時や障害時にサーバーが自動的に起動するようになります。

新しいSystemdサービスファイルを作成します。

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

ファイルに入力します。

[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

これで、Synapseサーバーをすばやく起動できます。

sudo systemctl start matrix-synapse

次のコマンドを使用してサーバーを停止または再起動します。

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

サービスの状態を確認できます。

sudo systemctl status matrix-synapse

Riotの使用

これで、Matrix Synapseサーバーがサーバーにインストールされ、構成されました。Matrixに組み込まれているWebクライアントは古くなっているため、チャットに利用できるさまざまなクライアントアプリケーションから選択できます。Riotは最も人気のあるチャットクライアントで、ほとんどすべてのプラットフォームで利用できます。RiotのWebチャットクライアントのホストされたバージョンを使用することも、独自のサーバーでそのコピーをホストすることもできます。これとは別に、Windows、Mac、Linux、IOS、Androidで利用可能なRiotのデスクトップおよびモバイルチャットクライアントを使用することもできます。

Riot Webクライアントの独自のコピーをホストしたい場合は、サーバーにRiotをインストールする手順をさらに読むことができます。ホスト型のデスクトップおよびモバイルクライアントの場合、ユーザー名とパスワードを使用してホームサーバーに直接ログインできます。オプションのmy Matrix IDドロップダウンメニューから選択し、Sign In新しいユーザーの登録時に作成したユーザー名とパスワードを入力するだけです。をクリックしてCustom server、Synapseインスタンスのドメイン名を使用します。すでにNginxを構成しているのでhttps://matrix.example.com、ホームサーバーおよびhttps://matrix.orgIdentityサーバーのURLとして使用できます。

暴動ログインの例

自分のサーバーにRiotをセットアップします。

Riotはオープンソースでもあり、独自のサーバーで無料でホストできます。データベースや依存関係は必要ありません。すでにNginxサーバーを実行しているので、同じサーバーでホストできます。

SynapseとRiotに使用���ているドメインまたはサブドメインは、クロスサイトスクリプティングを回避するために異なるものにする必要があります。ただし、同じドメインの2つのサブドメインを使用できます。このチュートリアルではriot.example.com、Riotアプリケーションのドメインとして使用します。のすべての出現riot.example.com箇所を、Riotアプリケーションの実際のドメインまたはサブドメインに置き換えます。

サーバーにRiotをダウンロードします。

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

RiotのGithubで常に最新バージョンへのリンクを見つけることができます。

アーカイブを抽出します。

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

便宜上、ディレクトリの名前を変更します。

sudo mv riot-v*/ riot/

Certbotはすでにインストールされているため、証明書を直接生成できます。使用しているドメインまたはサブドメインがサーバーに向けられていることを確認してください。

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

生成された証明書は、/etc/letsencrypt/live/riot.example.com/ディレクトリに格納される可能性があります。

Riotアプリケーションの仮想ホストを作成します。

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

ファイルに入力します。

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;

  }

サンプル構成ファイルをコピーします。

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

次に、構成ファイルを編集して、いくつかの変更を加えます。

sudo nano /opt/riot/config.json

次の行を見つけます。

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

デフォルトのホームサーバーURLの値を、MatrixサーバーのURLに置き換えます。IDサーバーのURLには、デフォルトのオプションを使用するか、その値をMatrix IDサーバーに提供することもできますhttps://matrix.org。

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

ファイルを保存して終了します。Nginxユーザーにファイルの所有権を提供します。

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

Nginxを再起動します。

sudo systemctl restart nginx

Riotにはからアクセスできますhttps://riot.example.com。これで、以前に作成したユーザー名とパスワードを使用してログインできます。アプリケーションのデフォルトのMatrixサーバーはすでに変更されているため、デフォルトのサーバーを使用して接続できます。

これで、Matrix Synapseホームサーバーが稼働しました。また、ホストされているRiotのコピーもあり、Matrix ID、電子メール、または携帯電話番号を使用して他の人にメッセージを送信できます。まず、サーバー上にチャットルームを作成し、作成したチャットルームにMatrixの友達を招待します。