Matrix-Synapse安装使用与注意事项

最新推荐文章于 2024-06-08 09:33:11 发布

七夜草

最新推荐文章于 2024-06-08 09:33:11 发布

阅读量3k

点赞数

文章标签：服务器后端信息与通信

本文链接：https://blog.csdn.net/weixin_45581473/article/details/127759330

版权

本篇的环境为Ubuntu20.04，使用PostgreSQL14，Python3.8运行，且使用apt方式安装，其他情况请不要直接套用。

Matrix-Synapse是目前最成熟的Matrix家庭服务器，也是应用最广的一个。全世界有数以千万计的人享受着Matrix-Synapse带来的便捷与安全。考虑到https://matrix.org 难以在国内访问，本篇文章同时也会简单说明一下安装步骤，详细的步骤还请访问GitHub上面Matrix官方的文档。

安装

Ubuntu仓库中的很多软件并不是最新版本，Synapse也不例外。所以首先，你需要先将下载源调换为官方下载源（本文特指发行版，如需预发行版请自行设置）。
（你的服务器需要可以访问外网）

sudo apt install -y lsb-release wget apt-transport-https
sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" |
    sudo tee /etc/apt/sources.list.d/matrix-org.list
sudo apt update
sudo apt install matrix-synapse-py3

安装完成？恭喜你，你已经安装好了Synapse！
不过这只是开始，安装完毕后是不能直接用的，你需要编辑位于/etc/matrix-synapse的文件（如果在别处编辑文件并且使用别处的文件且用systemd进行管理，请自行修改matrix-synapse.service中配置文件的路径）
现在让我们安装PostgreSQL，实际上Ubuntu仓库中的12版本是可以使用的，但是为了方便未来更新，我们还是直接一步到位使用新版本PostgreSQL作为数据库程序。请不要有长期使用SQLite3的想法，你不会获得任何好处。

sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
sudo apt-get update
sudo apt-get -y install postgresql

然后安装Redis

curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list

sudo apt-get update
sudo apt-get install redis

请注意，如果Redis通过systemd启动失败，请检查日志对应文件及其所有者。
（如果你想，你可以再设置Redis的访问密码，步骤简单，在这里不多赘述）

数据库

如使用宝塔，请注意不要使用宝塔内的PostgreSQL生成数据库，这不合规。
首先我们进入postgres账户：

su - postgres
#or
sudo -u postgres bash

然后创建一个用户以及其下的一个数据库：

createuser --pwprompt username

createdb --encoding=UTF8 --locale=C --template=template0 --owner=username dbname

你可以为该用户设置一个强密码，准备完毕后就不再需要对数据库执行操作了。
数据库相关的配置如下（参考的整体配置在最后面）

database:
  name: psycopg2
  args:
    user: <user>
    password: <pass>
    database: <db>
    host: <host>
    cp_min: 5
    cp_max: 10

基础配置

基础配置部分大多数无需改动，部分诸如"server_name"等请自行填写。请注意仔细填写，诸如server_name等项一经启动初始化便无法修改，唯一方法便是清空数据库重新开始。

如果你想让它变成同一域名既可以当做Matrix服务器又可以同时做其他事，请直接填写目标域名，例如，想要example.com同时成为Matrix服务器与运行别的服务，请直接填写example.com。

接下来重点讲讲易踩坑部分

使日志占用降低

如果你打开log.yaml阅读过，你可以惊喜地发现Matrix贴心地默认将日志等级设置为INFO，而这意味着大量操作将被记录，空间占用将明显上升。建议调整为WARNING或ERROR，既可以定位问题，又不至于过度占用资源。

如何运行Synapse？

你可以在homeserver.yaml同目录下运行synctl start/stop/restart来操作Synapse且在本次开机（注意不是会话）期间有效，你也可以使用systemd实现开机自启，文件如下：

[Unit]
Description=Synapse master

# This service should be restarted when the synapse target is restarted.
PartOf=matrix-synapse.target
ReloadPropagatedFrom=matrix-synapse.target

[Service]
Type=notify
NotifyAccess=main
User=matrix-synapse
WorkingDirectory=/var/lib/matrix-synapse
EnvironmentFile=-/etc/default/matrix-synapse
ExecStartPre=/opt/venvs/matrix-synapse/bin/python -m synapse.app.homeserver --config-path=/etc/matrix-synapse/homeserver.yaml --config-path=/etc/matrix-synapse/conf.d/ --generate-keys
ExecStart=/opt/venvs/matrix-synapse/bin/python -m synapse.app.homeserver --config-path=/etc/matrix-synapse/homeserver.yaml --config-path=/etc/matrix-synapse/conf.d/
ExecReload=/bin/kill -HUP $MAINPID
Restart=always
RestartSec=3
SyslogIdentifier=matrix-synapse

[Install]
WantedBy=matrix-synapse.target