開源框架 Matrix-Dendrite 搭建聊天服務器的詳細過程
開源框架 Matrix-Dendrite 搭建聊天服務器
關於Matrix
Matrix 是一個開源、可交互、去中心化的實時通信服務框架。使用 Matrix 可以搭建安全的通信服務器,配合支持 Matrix 的客戶端可以實現個人、團隊間的實時聊天交互。
Matrix 相較於普通的通信服務(如微信、QQ等軟件使用的服務),最特別的地方在於其去中心化的架構。每個運行著 Matrix 的服務器都是一個節點(homeserver),用戶可以選擇在任意節點進行註冊、連接,和處於同一節點的其他用戶自由交流,用戶的隱私數據以加密的形式存儲於當前的節點上。同時,節點與節點間也可以通過聯鎖(Federation)機制進行通信,使在不同節點上的用戶之間可以互相交流。得益於去中心化的服務架構,用戶完全可以自行搭建節點服務器,使自己的聊天數據安全和隱私得到保護。
支持 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 [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 [Type] Path [Name] JetStream路徑 [Container Path] /etc/JetStream_NATS [Host Path] /mnt/user/appdata/Dendrite/JetStream
在添加容器界面點擊高級視圖(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 還處於開發測試階段,但經過這幾天的使用發現主要功能並沒有什麼問題。
Reference
在Docker命令中使用HEALTHCHECK
https://docs.docker.com/engine/reference/run/
Federation連接測試
Federation Tester
到此這篇關於開源框架 Matrix-Dendrite 搭建聊天服務器的文章就介紹到這瞭,更多相關Matrix Dendrite聊天服務器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- Docker中運行PostgreSQL並推薦幾款連接工具
- docker安裝postgresql的圖文教程
- PostgreSQL使用MySQL外表的步驟詳解(mysql_fdw)
- docker安裝並持久化postgresql數據庫的操作步驟
- Docker環境下升級PostgreSQL的步驟方法詳解