Перейти к содержимому

Статья 91 из 141

Гайды

Свой мессенджер на Matrix: установка Synapse с PostgreSQL в Docker на VPS

Matrix — открытый протокол для чатов, похожий на электронную почту: у каждого сервера свои пользователи, и серверы общаются друг с другом (федерация). Synapse — эталонный сервер Matrix от команды Element. Вы ставите его на VPS и получаете мессенджер под своим контролем: личные и групповые чаты, файлы, сквозное шифрование. Подключаться можно приложением Element на любой платформе.

Ресурс Минимум Комфортно
RAM 1 ГБ 2 ГБ и больше
vCPU 1 2
Диск 10 ГБ NVMe 20 ГБ и больше: файлы пользователей растут

Документация Synapse просит не меньше 1 ГБ свободной памяти, если вы будете вступать в большие публичные комнаты. Для семьи или небольшой команды хватит 2 ГБ.

Ещё понадобятся:

  • Docker с Docker Compose.
  • Домен. В примере example.com будет частью адресов пользователей, а сам сервер будет жить на поддомене matrix.example.com. Создайте A-записи для обоих: DNS.
  • Nginx и Certbot на хосте: Nginx, Let’s Encrypt.

server_name задаёт вторую часть адреса пользователя: @ivan:example.com. Его нельзя поменять после установки. Выберите сразу.

Удобная схема:

  • server_name = example.com: короткие адреса пользователей.
  • Synapse работает на matrix.example.com.
  • Файлы .well-known на example.com сообщают клиентам и другим серверам, где искать Synapse. Это называется делегированием.

Если на example.com у вас ничего нет, можно сделать server_name равным matrix.example.com. Тогда адреса будут вида @ivan:matrix.example.com.

Окно терминала
mkdir -p /opt/matrix && cd /opt/matrix
docker run -it --rm \
-v /opt/matrix/data:/data \
-e SYNAPSE_SERVER_NAME=example.com \
-e SYNAPSE_REPORT_STATS=no \
matrixdotorg/synapse:latest generate

В /opt/matrix/data появятся homeserver.yaml, конфиг логов и ключ подписи example.com.signing.key. Ключ подписи сервера нужно беречь: по нему другие серверы узнают ваш.

По умолчанию Synapse использует SQLite. Документация считает его пригодным только для тестов. Откройте data/homeserver.yaml и замените блок database:

database:
name: psycopg2
args:
user: synapse
password: "СЛОЖНЫЙ_ПАРОЛЬ"
dbname: synapse
host: db
cp_min: 5
cp_max: 10

В том же файле проверьте:

public_baseurl: "https://matrix.example.com/"
enable_registration: false

В блоке listeners у порта 8008 должно стоять x_forwarded: true, чтобы Synapse видел реальные IP клиентов за Nginx.

/opt/matrix/docker-compose.yml:

services:
synapse:
image: matrixdotorg/synapse:latest
restart: unless-stopped
environment:
SYNAPSE_CONFIG_PATH: /data/homeserver.yaml
volumes:
- ./data:/data
ports:
- "127.0.0.1:8008:8008"
depends_on:
- db
db:
image: postgres:16-alpine
restart: unless-stopped
environment:
POSTGRES_USER: synapse
POSTGRES_PASSWORD: "СЛОЖНЫЙ_ПАРОЛЬ"
POSTGRES_DB: synapse
POSTGRES_INITDB_ARGS: "--encoding=UTF-8 --lc-collate=C --lc-ctype=C"
volumes:
- ./pgdata:/var/lib/postgresql/data

POSTGRES_INITDB_ARGS обязателен. С другой кодировкой или локалью Synapse откажется запускаться. Порт базы наружу не открыт, Synapse слушает только 127.0.0.1.

Окно терминала
docker compose up -d
docker compose logs -f synapse

Подробнее о PostgreSQL: PostgreSQL.

Конфиг для matrix.example.com, файл /etc/nginx/sites-available/matrix:

server {
listen 80;
server_name matrix.example.com;
location ~ ^(/_matrix|/_synapse/client) {
proxy_pass http://127.0.0.1:8008;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $host;
client_max_body_size 50M;
proxy_http_version 1.1;
}
}

После proxy_pass не добавляйте путь, даже /. Иначе Nginx изменит URI и федерация сломается на проверке подписей. client_max_body_size должен совпадать с max_upload_size в homeserver.yaml (по умолчанию 50M).

Окно терминала
ln -s /etc/nginx/sites-available/matrix /etc/nginx/sites-enabled/
nginx -t && systemctl reload nginx
certbot --nginx -d matrix.example.com

Другие серверы ищут ваш по server_name. Без делегирования они идут на example.com:8448. С делегированием можно обойтись портом 443.

Добавьте в блок server сайта example.com (с уже настроенным HTTPS):

location = /.well-known/matrix/server {
default_type application/json;
return 200 '{"m.server": "matrix.example.com:443"}';
}
location = /.well-known/matrix/client {
default_type application/json;
add_header Access-Control-Allow-Origin *;
return 200 '{"m.homeserver": {"base_url": "https://matrix.example.com"}}';
}

Первый файл нужен серверам, второй клиентам: пользователь вводит example.com, а приложение само находит matrix.example.com.

Если server_name совпадает с доменом сервера и делегирование не нужно, добавьте в Nginx listen 8448 ssl; для того же server и откройте порт 8448 в файрволе.

Проверить федерацию можно сервисом federationtester.matrix.org.

В сгенерированном homeserver.yaml есть строка registration_shared_secret. Если её нет, добавьте длинную случайную строку и перезапустите Synapse. Создайте пользователя:

Окно терминала
docker compose exec synapse register_new_matrix_user \
-c /data/homeserver.yaml -u admin -a http://localhost:8008

Команда спросит пароль. Флаг -a делает пользователя администратором.

Знающий registration_shared_secret может создавать аккаунты даже при закрытой регистрации. Когда пользователи созданы, удалите строку и выполните docker compose restart synapse.

enable_registration: false стоит по умолчанию. Не включайте открытую регистрацию на публичном сервере: её быстро найдут спамеры. Новых людей добавляйте той же командой register_new_matrix_user без флага -a.

  • Element есть для Windows, macOS, Linux, Android, iOS и в браузере на app.element.io. При входе нажмите «Изменить» у адреса сервера и введите example.com.
  • Своя Element Web. Официальный образ vectorim/element-web, слушает порт 80, конфиг монтируется в /app/config.json. Публикуйте его на 127.0.0.1 и отдавайте через Nginx на отдельном поддомене, например chat.example.com.

Минимальный config.json для своей Element Web, чтобы она сразу подключалась к вашему серверу и открывалась на русском:

{
"default_server_config": {
"m.homeserver": { "base_url": "https://matrix.example.com", "server_name": "example.com" }
},
"setting_defaults": { "language": "ru" }
}

Вход в Element Web со своим сервером Matrix

Если Element Web на отдельном поддомене пишет в консоли браузера ошибку CORS для /.well-known/matrix/client, проверьте заголовок Access-Control-Allow-Origin * в блоке .well-known из раздела про федерацию.

Звонки один на один идут напрямую между устройствами. Если оба собеседника за NAT, без TURN-сервера звонок не соединится. Обычно для этого ставят coturn.

Что нужно знать:

  • TURN использует порт 3478 (TCP и UDP), 5349 для TLS и диапазон UDP 49152–65535 для медиа. Все эти порты должны быть открыты.
  • В coturn включают use-auth-secret и задают static-auth-secret.
  • В homeserver.yaml указывают turn_uris, например "turn:turn.example.com?transport=udp" и "turn:turn.example.com?transport=tcp", и turn_shared_secret с тем же секретом.

Пошаговая настройка есть в документации Synapse, раздел TURN howto.

Окно терминала
cd /opt/matrix
docker compose pull
docker compose up -d

Перед обновлением сделайте бэкап базы. Прочитайте заметки к релизу Synapse: иногда меняются настройки или минимальная версия PostgreSQL.

Сохраняйте три вещи:

Что Где
База дамп PostgreSQL
Конфиг и ключ подписи data/homeserver.yaml, data/*.signing.key, конфиг логов
Файлы пользователей data/media_store/local_content и local_thumbnails

Дамп базы без остановки сервиса:

Окно терминала
cd /opt/matrix
docker compose exec -T db pg_dump -U synapse -Fc \
--exclude-table-data e2e_one_time_keys_json synapse > /root/synapse-$(date +%F).dump
tar -czf /root/synapse-files-$(date +%F).tar.gz \
-C /opt/matrix/data homeserver.yaml example.com.signing.key example.com.log.config media_store/local_content media_store/local_thumbnails

Таблицу e2e_one_time_keys_json документация советует исключать: при восстановлении старого дампа эти ключи выдадутся повторно и сообщения перестанут расшифровываться. Восстанавливают в пустую базу через pg_restore. Копии держите вне сервера: бэкапы.

Симптом Причина/решение
Synapse не стартует, в логе ошибка про COLLATE или CTYPE База создана без C-локали. Пересоздайте её с POSTGRES_INITDB_ARGS из примера
Synapse не видит базу Проверьте host: db и пароль в homeserver.yaml, затем docker compose logs db
Клиент пишет, что сервер не найден Нет /.well-known/matrix/client на example.com или не тот JSON. Проверьте curl https://example.com/.well-known/matrix/client
Не работает федерация Проверьте /.well-known/matrix/server или доступность порта 8448: проверка порта
Ошибки подписи при федерации После proxy_pass в Nginx указан путь. Оставьте http://127.0.0.1:8008 без /
Не загружаются файлы, ошибка 413 Увеличьте client_max_body_size в Nginx до max_upload_size
Звонки не соединяются Нет TURN-сервера или закрыты его порты
Сервер тормозит, кончается память Большие публичные комнаты съедают RAM. Добавьте swap или смените тариф