Обзор развертывания Element на сервере¶

Предварительные требования¶

Для корректной работы приложения сервер должен соответствовать следующим требованиям:

Операционная система: Ubuntu.
Права доступа: Права суперпользователя (root) для установки системных пакетов и управления Docker.
Доменное имя: Наличие настроенного домена, соответствующего шаблону в разделе ниже.
Порты: Должны быть открыты порты 80, 443 (HTTPS), 8448 (Federation) и 8008 (Synapse API).

Для работы сервиса используется динамически формируемый поддомен.

Параметр	Значение
Префикс	`element`
Домен	`hostkey.in`
Полный шаблон	`element{Server_ID_from_Invapi}.hostkey.in`

Все основные данные приложения и конфигурации сосредоточены в директории /opt/matrix.

/opt/matrix/docker-compose.yml — основной файл развертывания контейнеров.
/opt/matrix/files/homeserver.yaml — главный конфигурационный файл сервера Synapse.
/opt/matrix/files/element-config.json — конфигурация веб-клиента Element.
/data/nginx/user_conf.d/ — директория с конфигурациями виртуальных хостов Nginx.
/root/nginx/compose.yml — файл развертывания прокси-сервера для управления SSL.

Развертывание выполняет комплексную настройку системы, состоящую из следующих этапов:

Подготовка среды: Установка необходимых системных пакетов (ca-certificates, curl, gnupg, lsb-release).
Установка Docker: Если среда не содержит Docker, устанавливается docker-ce, docker-compose-plugin и сопутствующие компоненты из официального репозитория.
Настройка окружения: Создание рабочей директории /opt/matrix и подкаталогов для данных (files) и схем базы данных (schemas).
Развертывание контейнеров:
Загрузка образов из Docker Hub.
Развертывание стека сервисов через docker compose.
Настройка прокси и SSL: Создание конфигурации Nginx для управления входящим трафиком и автоматического получения сертификатов через Certbot.

Конфигурационные файлы в /opt/matrix имеют ограниченный доступ (владелец root).
Данные Synapse в каталоге /opt/matrix/files принадлежат пользователю с UID 991.
Директория для конфигураций Nginx создается с правами 0755.

В качестве базы данных используется контейнер PostgreSQL 15 (Alpine).

Имя пользователя: synapse
Пароль: synapse
Метод хранения: Данные хранятся в именованном Docker-томе postgres-data.
Настройки кодировки: Используется UTF-8 с параметрами LC_COLLATE=C и LC_CTYPE=C.

Приложение развертывается в виде группы контейнеров.

Имя образа	Сервис	Порты	Тома (Volumes)	Политика перезапуска
`postgres:15-alpine`	`db`	Нет	`postgres-data:/var/lib/postgresql/data`	`unless-stopped`
`matrixdotorg/synapse:latest`	`synapse`	`8008:8008`	`./files:/data`	`unless-stopped`
`vectorim/element-web:latest`	`element`	`127.0.0.1:8080:80`	`./element-config.json:/app/config.json`	`unless-stopped`

Имя образа	Сервис	Порты	Тома (Volumes)	Политика перезапуска
`jonasal/nginx-certbot:latest`	`nginx`	`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`	`unless-stopped`

Для обновления основного приложения необходимо выполнить следующие действия в директории /opt/matrix:

Подтянуть новые версии образов:
```
docker compose pull
```
Перезапустить контейнеры с использованием новых образов:
```
docker compose up -d
```

Порт	Назначение	Доступность
`443`	HTTPS (Web Client / API)	Публично
`8448`	Matrix Federation	Публично
`8008`	Synapse API (внутренний)	Локально
`8080`	Element Web (локальный прокси)	Только localhost