開源框架 Matrix-Dendrite 搭建聊天服務器

關于Matrix

Matrix 是一個開源、可互動、去中心化的實時通信服務框架，使用 Matrix 可以搭建安全的通信服務器，配合支持 Matrix 的客戶端可以實作個人、團隊間的實時聊天互動，

Matrix 相較于普通的通信服務（如微信、QQ等軟體使用的服務），最特別的地方在于其去中心化的架構，每個運行著 Matrix 的服務器都是一個節點（homeserver），用戶可以選擇在任意節點進行注冊、連接，和處于同一節點的其他用戶自由交流，用戶的隱私資料以加密的形式存盤于當前的節點上，同時，節點與節點間也可以通過聯鎖（Federation）機制進行通信，使在不同節點上的用戶之間可以互相交流，得益于去中心化的服務架構，用戶完全可以自行搭建節點服務器，使自己的聊天資料安全和隱私得到保護，

Matrix_Framework

支持 Matrix 協議的客戶端有很多，比較成熟的有 Element.io（Riot.IM），語音、視頻通話、附件等功能都有，并且支持 Windows，Linux，Android 等多個平臺，

開始搭建

Matrix 的服務端有兩種：Synapse 和 Dendrite，

Synapse 是用 Python 撰寫的第一代 Matrix 服務端，是十分穩定的正式版，使用者非常多，適合用于生產環境中，Dendrite 是 Matrix 的開發團隊使用 Go 語言撰寫的第二代 Matrix 服務端，它旨在為 Synapse 提供一個高效、可靠、可擴展的替代方案，目前 Dendrite 仍然在 Beta 開發中，像推送和提醒等一些功能還沒有實作，

如果是生產環境使用，還是搭建 Synapse，更穩定并且相關的教程也十分豐富，

本文使用 Dendrite 來搭建，在 Unraid 系統通過 Docker 容器來實作，主要是想嘗鮮噠！在其他系統下也可以參照本文進行部署，

需要準備的'東西'

一個域名和該域名的有效 TLS 證書
一個反向代理服務，比如 Nginx
可選：高性能資料庫引擎，推薦 PostgreSQL，對性能無要求可以使用內置的 SQLite，

PostgreSQL

Matrix 并不強制要求使用哪種資料庫，少量用戶的情況下完全可以使用其內置的 SQLite 資料庫，如果系統內已經有其他資料庫引擎運行，當然也可以直接使用，本文只是按照官方推薦使用 PostgreSQL 作為 Matrix 資料庫的管理引擎，

01.創建 PostgreSQL 組態檔目錄

在安裝 PostgreSQL Docker 前，先創建組態檔目錄 /mnt/user/appdata/PostgreSQL/，

訪問 https://github.com/matrix-org/dendrite/tree/main/build/docker/postgres 下載 create_db.sh 檔案，使用文本編輯器打開它，修改代碼中用戶名欄位為自己的資料庫用戶名，

# 這段代碼的作用是初始化資料庫，所以陳述句中的 Username 必須要替換成自己的資料庫管理員用戶名，
for db in userapi_accounts userapi_devices mediaapi syncapi roomserver keyserver federationapi appservice mscs; do
    createdb -U [Username] -O [Username] dendrite_$db # 注意修改[Username]
done

最后將 create_db.sh 檔案上傳到組態檔目錄里：/mnt/user/appdata/PostgreSQL/create_db.sh

02.創建 databases 檔案夾存盤資料庫

創建目錄用來存放 PostgreSQL 的資料庫：

/mnt/user/appdata/PostgreSQL/databases

03.配置 Docker 命令創建容器

本文使用 Unraid 系統進行搭建，進入 DOCKER -> ADD CONTAINER 即可配置容器引數，也可以使用 Unraid 插件中心進行安裝，其他系統使用 docker create 命令可能還更簡單，所以本文也將創建容器的命令列字串附于其后，

Unraid 創建容器需要添加/修改的引數如下：

[Type] Variable            [Name] 管理員用戶名
[Key]  POSTGRES_USER       [Value] FrozenSky

[Type] Variable            [Name] 管理員密碼
[Key]  POSTGRES_PASSWORD   [Value] xxxxxxx

[Type] Path                [Name] 資料庫存盤路徑
[Container Path] /var/lib/postgresql/data
[Host Path]      /mnt/user/appdata/PostgreSQL/databases
[Access Mode]    Read/Write

[Type] Path                [Name] 資料庫初始化腳本
[Container Path] /docker-entrypoint-initdb.d/20-create_db.sh
[Host Path]      /mnt/user/appdata/PostgreSQL/create_db.sh
[Access Mode]    Read/Write

[Type] Port                [Name] 埠映射
[Container Port] 5432
[Host Port]      5432

另外，官方還推薦開啟容器健康狀態檢查功能，在添加容器界面點擊高級視圖(ADVANCED VIEW)，在 Post Arguments 中添加下面的陳述句：

--health-cmd='["CMD-SHELL", "pg_isready -U dendrite"]' --health-interval=5s --health-timeout=5s --health-retries=5

配置完成后，點擊 APPLY 即可創建容器，

國內網路訪問 DockerHub 可能出現無法連接的問題，可以通過阿里云加速來解決，網路上教程很多，但多是需要更改 Unraid 系統檔案，其實完全沒必要，Docker 命令是支持自定義拉取服務器的，只需要在配置界面中倉庫(Repository)這一欄添加加速服務器即可：

比如：dazeaikzq.mirror.aliyuncs.com/library/postgres:14

關于 HEALTHCHECK

官方 docker-compose 檔案中，有個 HEALTHCHECK 欄位，如果使用 docker-cli 啟動容器的話可以參照下面的欄位進行替換，這個欄位是配置容器健康狀態檢查的，貌似不加也可以，

  --health-cmd            Command to run to check health
  --health-interval       Time between running the check
  --health-retries        Consecutive failures needed to report unhealthy
  --health-timeout        Maximum time to allow one check to run
  --health-start-period   Start period for the container to initialize before starting health-retries countdown
  --no-healthcheck        Disable any container-specified HEALTHCHECK

附：命令列方式創建Docker

docker create
    --name='PostgreSQL' 
    --net='bridge' 
    -e TZ="Asia/Shanghai" 
    -e HOST_OS="Unraid" 
    -e 'POSTGRES_PASSWORD'='xxxxxxx' 
    -e 'POSTGRES_USER'='FrozenSky' 
    -e 'POSTGRES_DB'='' 
    -p '5432:5432/tcp' 
    -v '/mnt/user/appdata/PostgreSQL/databases':'/var/lib/postgresql/data':'rw' 
    -v '/mnt/user/appdata/PostgreSQL/create_db.sh':'/docker-entrypoint-initdb.d/20-create_db.sh':'rw' 
    --restart=always 'postgres:14'
    --health-cmd='["CMD-SHELL", "pg_isready -U dendrite"]' 
    --health-interval=5s
    --health-timeout=5s
    --health-retries=5

04.連接資料庫以確認初始化正常

可以使用 PGAdmin、dbeaver、phpMyAdmin 等管理軟體連接遠程資料庫，查看是否已經創建了好多個 dendrite 開頭的資料，

PostgreSQL 的默認連接地址是： [IP]:5432

Matrix-Dendrite

Matrix-Dendrite 服務端分為2個版本，monolith 和 polylith，本文選擇了 monolith，因為它的各個組件都是整合在一起的，配置簡單，

Dendrite 的 Github 倉庫：https://github.com/matrix-org/dendrite

01.創建 Dendrite 檔案夾存盤組態檔

創建目錄：/mnt/user/appdata/Dendrite/config

該目錄下必須包含如下檔案：

dendrite.yaml 組態檔
matrix_key.pem 服務端密鑰（通過下文的命令生成）
server.crt 證書檔案（打算作為Matrix服務器的域名的證書）
server.key 證書私鑰

(1) 生成 matrix_key.pem 服務器密鑰檔案

把你的網站域名證書和私鑰上傳到配置目錄里：

/mnt/user/appdata/Dendrite/config/server.key
/mnt/user/appdata/Dendrite/config/server.crt

打開 Unraid 終端，進入組態檔目錄，執行下面的 Docker 命令：

# 注意：命令引數中 -tls-cert 和 -tls-key 的檔案名要和上面保持一致，
docker run --rm --entrypoint="" \
  -v $(pwd):/mnt \
  matrixdotorg/dendrite-monolith:latest \
  /usr/bin/generate-keys \
  -private-key /mnt/matrix_key.pem \
  -tls-cert /mnt/server.crt \
  -tls-key /mnt/server.key

該命令將在當前目錄中生成服務端密鑰 matrix_key.pem

# 命令輸出
Created TLS cert file:    /mnt/server.crt
Created TLS key file:     /mnt/server.key
Created private key file: /mnt/matrix_key.pem

(2) 修改 Dendrite 組態檔

從 Github 倉庫下載組態檔 dendrite.yaml 示例進行修改，下載地址：組態檔示例

以下組態檔將假設我的域名是 frozensky.org 并且打算在 1443 埠進行反向代理，將 Matrix 的 API 請求進行轉發；我的資料庫用戶名是 FrozenSky 密碼是 xxxxxxx ，資料庫訪問地址是：192.168.7.9:5432

主要修改的地方如下：

# 域名（運營商封443的話，就要填寫你的自定義反向代理埠）
server_name: frozensky.org:1443
# 服務器私鑰路徑（上文生成的私鑰）
private_key: /etc/dendrite/matrix_key.pem
# Well-known服務的域名（同域名）
well_known_server_name: "frozensky.org:1443"
# 每個組件的資料庫連接字串 connection_string 
# 組態檔中所有組件的資料庫連接URL都要改（使用內置SQLite則不需要改）
connection_string: postgresql://FrozenSky:[email protected]:5432/............

# 注釋掉 JetStream 默認的服務器地址
# Configuration for NATS JetStream
  jetstream:
    addresses:
    # - jetstream:4222  #注釋該行
    storage_path: /etc/JetStream_NATS #設定一個容器內目錄用來存盤資料

02.創建資料存盤目錄

創建一些目錄用來存盤 Dendrite 的資料：

JetStream：/mnt/user/appdata/Dendrite/JetStream

Media: /mnt/user/appdata/Dendrite/media

03.創建 Dendrite 容器

使用官方鏡像：matrixdotorg/dendrite-monolith

以下是容器配置：

[Type] Port 1              [Name] 埠映射
[Container Port] 8008
[Host Port]      8008

[Type] Port 2              [Name] 埠映射
[Container Port] 8448
[Host Port]      8448

[Type] Path                [Name] 組態檔路徑
[Container Path] /etc/dendrite
[Host Path]      /mnt/user/appdata/Dendrite/config
[Access Mode]    Read/Write

[Type] Path                [Name] 媒體檔案路徑
[Container Path] /var/dendrite/media
[Host Path]      /mnt/user/appdata/Dendrite/media
[Access Mode]    Read/Write

[Type] Path                [Name] JetStream路徑
[Container Path] /etc/JetStream_NATS
[Host Path]      /mnt/user/appdata/Dendrite/JetStream
[Access Mode]    Read/Write

在添加容器界面點擊高級視圖(ADVANCED VIEW)，在 Post Arguments 中添加下面的陳述句：

--tls-cert=server.crt --tls-key=server.key

點擊 APPLY 創建容器，

Nginx反向代理

安裝完成 Dendrite 后，其實 Matrix 服務框架的后端就已經運行起來了，但想要讓客戶端軟體與我們的服務端通信還需要通過 Nginx 配置，將客戶端的請求轉發到對應的服務器埠上來，

修改 Nginx 組態檔 /etc/nginx/sites-available （Nginx版本不同組態檔路徑可能不同）

以本文環境為例，因運營商封殺443埠，我在路由上將 1443 埠轉發到內部的 443 埠，組態檔要修改的部分本文都作了注釋，就不再為 Nginx 的配置做過多說明了，遇到問題可以自行搜索，教程還是很詳細的，

server {
	listen 80;
	listen 443 ssl;
	server_name frozensky.org; #域名
	charset utf-8;

	#ssl on;
	ssl_certificate     /etc/ssl/frozensky.org/fullchain.crt; #證書
	ssl_certificate_key /etc/ssl/frozensky.org/frozensky.org.key; #密鑰
	ssl_session_timeout 5m;
	ssl_protocols       SSLv2 SSLv3 TLSv1 TLSv1.2;
	ssl_ciphers         HIGH:!aNULL:!MD5;
	ssl_prefer_server_ciphers   on;

    # 代理請求的一些設定
    proxy_set_header Host      $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_read_timeout         600;
	
    # Dendrite組態檔中的server_name，注意埠是外部埠！！！
    location /.well-known/matrix/server {
        return 200 '{ "m.server": "frozensky.org:1443" }'; 
    }
	# Dendrite組態檔中的server_name，注意埠是外部埠！！！
    location /.well-known/matrix/client {
        return 200 '{ "m.homeserver": { "base_url": "https://frozensky.org:1443" } }';
    }
    # Dendrite后端的地址，IP是搭建Dendrite的服務器IP，埠是8008
    location /_matrix {
        proxy_pass http://192.168.7.10:8008;
    }
}

配置完成后保存退出，

多載組態檔和證書，重啟Nginx服務

sudo service nginx force-reload

sudo service nginx restart

測驗連接

至此，Matrix 服務就全部配置完成了，可以訪問 Federation Tester 輸入自己的 Matrix 網址 https://frozensky.org:1443 進行測驗，全部通過的話就表示服務運行正常且 Federation 聯鎖也已啟用，可以和其他服務器的小伙伴進行通信了，本文推薦安裝 Element.io 客戶端來使用，雖然 Matrix-Dendrite 還處于開發測驗階段，但經過這幾天的使用發現主要功能并沒有什么問題，

Element_io_client

Reference

在Docker命令中使用HEALTHCHECK

https://docs.docker.com/engine/reference/run/

Federation連接測驗

Federation Tester

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/440403.html

標籤：其他

上一篇：使用cms系統配置QQ郵箱,接收系統郵件

下一篇：Virtualbox NAT網路配置