Обзор развертывания Element на сервере¶
Предварительные требования¶
Для корректной работы приложения требуются следующие параметры и условия:
-
Операционная система: Ubuntu.
-
Права доступа: Права суперпользователя (
root) для установки системных пакетов и управления Docker. -
Доменное имя: Необходимо наличие домена, настроенного на IP сервера.
-
Порты:
-
80,443— для веб-трафика и SSL. -
8448— для федерации Matrix. -
8008— внутренний порт приложения Synapse.
FQDN итоговой панели на домене hostkey.in¶
| Параметр | Значение |
|---|---|
| Префикс | element |
| Домен | hostkey.in |
| Полный шаблон | element{Server_ID_from_Invapi}.hostkey.in |
Структура файлов и каталогов¶
Все основные данные приложения сосредоточены в директории /opt/matrix.
-
/opt/matrix/files— рабочие файлы Synapse, включая конфигурациюhomeserver.yamlи медиа-данные. -
/opt/matrix/schemas— системные схемы базы данных. -
/root/nginx— конфигурация прокси-сервера Nginx и Docker Compose для управления SSL. -
/data/nginx/user_conf.d— пользовательские конфигурации виртуальных хостов Nginx.
Процесс установки приложения¶
Развертывание выполняется в несколько этапов:
-
Подготовка системы: Установка необходимых системных пакетов (
ca-certificates,curl,gnupg,lsb-release). -
Установка Docker: Если среда не содержит Docker, устанавливается
docker-ce,docker-compose-pluginи сопутствующие компоненты из официального репозитория Docker. -
Настройка окружения: Создание необходимых директорий (
/opt/matrix,/opt/matrix/files) с установкой прав доступа для пользователя с UID991. -
Развертывание контейнеров:
-
Генерация конфигурационных файлов (включая
homeserver.yamlиelement-config.json). -
Запуск стека Docker Compose, включающего базу данных, сервер Synapse и клиент Element.
-
Настройка проксирования: Настройка Nginx для работы с SSL-сертификатами через Certbot и перенаправление трафика на внутренние порты приложения.
Права доступа и безопасность¶
-
Пользователи: Основные данные приложения (
/opt/matrix/files) принадлежат пользователю с UID991. -
Брандмауэр: Должны быть открыты порты
80,443(HTTPS) и8448(для федерации Matrix). -
Безопасность Docker: После установки пакетов выполняется очистка кэша сборщика (
docker builder prune) и неиспользуемых данных системы.
Базы данных¶
В качестве базы данных используется контейнер postgres:15-alpine.
| Параметр | Значение |
|---|---|
| Пользователь БД | synapse |
| Имя базы данных | synapse |
| Метод подключения | Через внутреннюю сеть Docker (хост db) |
| Хранилище данных | Том postgres-data в Docker |
Контейнеры Docker и их запуск¶
Приложение разворачивается с использованием двух основных групп контейнеров.
Основной стек приложения¶
| Имя образа | Порты (внутри/снаружи) | Тома (Volumes) | Переменные окружения | Политика перезапуска |
|---|---|---|---|---|
postgres:15-alpine | Внутренние | postgres-data:/var/lib/postgresql/data | POSTGRES_USER, POSTGRES_PASSWORD | unless-stopped |
matrixdotorg/synapse:latest | 8008:8008 | ./files:/data | SYNAPSE_CONFIG_PATH=/data/homeserver.yaml | unless-stopped |
vectorim/element-web:latest | 80:80 (локально на 8080) | ./element-config.json:/app/config.json | — | unless-stopped |
Прокси-сервер и SSL¶
| Имя образа | Порты | Тома (Volumes) | Переменные окружения | Политика перезапуска |
|---|---|---|---|---|
jonasal/nginx-certbot:latest | host mode | nginx_secrets:/etc/letsencrypt, /data/nginx/user_conf.d:/etc/nginx/user_conf.d, /usr/share/element-web:/usr/share/element-web:ro | CERTBOT_EMAIL=hkadm@hostkey.com | unless-stopped |
Инструкция по обновлению приложения¶
Для обновления основного приложения необходимо выполнить следующие действия в директории /opt/matrix:
Расположение конфигурационных файлов и данных¶
-
Конфигурация сервера Matrix:
/opt/matrix/files/homeserver.yaml -
Конфигурация клиента Element:
/opt/matrix/element-config.json -
Данные базы данных: внутри Docker-тома
postgres-data -
Конфигурация Nginx (виртуальный хост):
/data/nginx/user_conf.d/{element{Server_ID_from_Invapi}.hostkey.in}.conf
Доступные порты для подключения¶
-
443— Основной веб-интерфейс и API (HTTPS). -
8448— Порт для федерации Matrix (HTTPS). -
8080— Локальный доступ к Element Web.
Запуск, остановка приложения¶
Управление основным стеком приложения осуществляется через Docker Compose в директории /opt/matrix:
-
Запуск:
docker compose up -d -
Остановка:
docker compose down