Чтобы разместить собственный веб-клиент Element на Nginx, загрузите официальный предварительно собранный релиз Element Web, разместите его статические файлы на своем веб-сервере, настройте его config.jsonс помощью вашего домашнего сервера Matrix и обслуживайте сайт по протоколу HTTPS. Nginx не запускает сам Element: он обслуживает файлы браузерного приложения, в то время как приложение подключается к вашему домашнему серверу Matrix отдельно. Используйте разные имена хостов для клиента и домашнего сервера, например, chat.example.comи matrix.example.com.
В этом руководстве предполагается использование Debian или Ubuntu, сервера Nginx с публичным DNS-именем и существующего домашнего сервера Matrix, доступного по HTTPS. Используется официальный архив релизов, а не сборка для разработчиков. В текущей документации проекта Element развернутое веб-приложение описывается как статическое содержимое и требует указания ключевых параметров конфигурации и URL-адресов точек входа во избежание кэширования. При выборе релиза или изменении параметров ознакомьтесь с примечаниями к выпуску и текущей документацией по конфигурации.
1. Подготовьте имя хоста и сервер.
Создайте запись A, chat.example.comуказывающую на публичный IPv4-адрес сервера Nginx. Добавьте запись AAAA только в том случае, если сервер доступен по IPv6. Разрешите входящие TCP-порты 80 и 443 через брандмауэр хоста и облачный брандмауэр. Убедитесь, что эти порты еще не заняты другим веб-сервером.
Установите Nginx и создайте директорию для веб-приложения:
sudo apt update
sudo apt install nginx
sudo mkdir -p /var/www/element
На другом компьютере откройте официальную страницу релизов Element Web и выберите опубликованный стабильный релиз. Загрузите его предварительно собранный веб-архив, а затем перенесите архив на сервер. Избегайте использования developветки или ночной сборки для общедоступного сервиса, если вы не собираетесь запускать программное обеспечение для предварительного просмотра.
2. Установите статические файлы и настройте домашний сервер.
Сначала распакуйте архив релиза во временную директорию. Изучите структуру корневого каталога архива, затем скопируйте его веб-файлы в эту директорию /var/www/element; сохраните структуру каталогов релиза. Структура пакетов может измениться, поэтому убедитесь index.html, что файлы , пакеты i18n, и файл конфигурации находятся там, где будет указывать корневой каталог Nginx.
sudo mkdir -p /tmp/element-release
tar -xzf /tmp/element-web-REPLACE_WITH_RELEASE.tar.gz -C /tmp/element-release
find /tmp/element-release -maxdepth 2 -name index.html
index.htmlПри копировании содержимого релиза в используйте в качестве источника каталог, содержащий /var/www/element. Если архив имеет один версионированный каталог верхнего уровня, скопируйте содержимое этого каталога, а не создавайте дополнительный вложенный каталог. Не заменяйте развернутое приложение, пока новые файлы не будут полностью скопированы; неполное копирование может привести к отсутствию пакетов JavaScript у пользователей.
Скопируйте файл релиза config.sample.json, config.jsonесли он есть в архиве, затем отредактируйте новый файл. Для запуска Element требуется настройка подключения к домашнему серверу по умолчанию. Предпочтительный поддерживаемый формат — default_server_config, использующий базовый URL-адрес клиентского API. Пример ниже является иллюстративным; замените URL-адрес на фактический URL-адрес, обслуживаемый вашим домашним сервером Matrix:
{
"default_server_config": {
"m.homeserver": {
"base_url": "https://matrix.example.com"
}
},
"brand": "Example Chat"
}
В документации по настройке Element также поддерживается опция default_server_name, основанная на .well-knownобнаружении Matrix. Используйте её, default_server_configесли хотите указать URL-адрес домашнего сервера напрямую. Не размещайте пароли, токены доступа, ключи подписи или другие секреты в этом общедоступном JSON-файле. Эта brandопция изменяет некоторые метки приложения; это не является полным ребрендингом под чужим брендом.
3. Настройте Nginx для приложения.
Создайте блок сервера Nginx, например, такой: `<имя сервера>` /etc/nginx/sites-available/element. При необходимости замените домен. Эта простая конфигурация предоставляет Element в виде статических файлов и отправляет отсутствующие пути в `< index.htmlимя сервера>`, помечая все ответы для повторной проверки. Такая консервативная политика кэширования предотвращает получение пользователями устаревшей оболочки приложения или устаревшей конфигурации после выпуска; вы можете настроить кэширование ресурсов позже, если ваш процесс развертывания сохраняет необходимые для Element пути без кэширования.
server {
listen 80;
listen [::]:80;
server_name chat.example.com;
root /var/www/element;
index index.html;
location / {
try_files $uri $uri/ =404;
add_header Cache-Control "no-cache" always;
add_header X-Frame-Options SAMEORIGIN always;
add_header X-Content-Type-Options nosniff always;
add_header Content-Security-Policy "frame-ancestors 'self'" always;
}
}
В рекомендациях Element по веб-хостингу говорится, что не следует кэшировать /config.*.json, /i18n, /version, или /index.html, и рекомендуется повторная проверка браузера при загрузке страницы. Пример применим no-cacheко всему в качестве простой отправной точки. Он также включает рекомендуемые Element заголовки безопасности, в том числе политику фреймов и защиту от определения MIME-типа. Если вы уже определили политику безопасности контента в другом месте, объедините ее frame-ancestors 'self'с этой политикой, вместо того чтобы отправлять конфликтующие политики.
Включите сайт и проверьте работоспособность Nginx перед перезагрузкой:
sudo ln -s /etc/nginx/sites-available/element /etc/nginx/sites-enabled/element
sudo nginx -t
sudo systemctl reload nginx
4. Добавьте HTTPS и протестируйте клиент.
Элемент должен обслуживаться по протоколу HTTPS. После того, как DNS-запрос установит соединение с этим сервером и станет доступен порт 80, установите Certbot, используя текущие инструкции для вашего дистрибутива, затем запросите и установите сертификат с его интеграцией с Nginx. Проект Certbot документирует процесс certbot --nginxи проверки обновления; установка пакета различается в зависимости от операционной системы, поэтому используйте текущие инструкции Nginx для вашей версии. Если Certbot изменит блок сервера, запустите его sudo nginx -tснова и подтвердите, что обновление запланировано.
Откройте https://chat.example.comокно браузера в режиме приватного просмотра. Экран входа в Element должен загрузиться без отсутствующих скриптов или стилей, отображать ожидаемый домашний сервер и иметь действительный значок замка в адресной строке браузера. Войдите в систему с помощью тестовой учетной записи и убедитесь, что браузер может связаться с домашним сервером. Если вход не удается, проверьте консоль разработчика браузера и панель сети на наличие заблокированных запросов, ошибок сертификатов или неправильного адреса base_url.
Распространенные проблемы развертывания
- Пустая или частично загруженная страница: убедитесь, что Nginx
rootуказывает на каталог, содержащий index.html, и что пакеты и i18nкаталог были скопированы вместе с ним. - Появляется неверный домашний сервер: проверьте синтаксис JSON
config.jsonи убедитесь, что файл находится в корневом каталоге веб-сервера. Если вы настроите файл, специфичный для домена config.chat.example.com.json, Element попытается использовать этот файл перед другим config.json; файлы не будут объединены. - После обновления пользователи видят старые настройки: убедитесь , что
index.html, version, i18n, и JSON-файлы конфигурации не кэшируются. Очистите или повторно проверьте кэш браузера после изменения политики Nginx. - Вход в систему загружается, но запросы к API завершаются с ошибкой: убедитесь, что URL домашнего сервера указан правильно, использует HTTPS и настроен для доступа через браузер, включая соответствующее поведение CORS, где это необходимо. Размещение Element на Nginx не является проксером и не заменяет домашний сервер Matrix.
Для успешного развертывания клиент загружается по пользовательскому домену по HTTPS, его конфигурация указывает на нужный домашний сервер, и тестовая учетная запись может войти в систему без сбоев сетевых запросов. Основными источниками информации по описанному здесь статическому развертыванию и поведению серверных блоков являются заметки Element по веб-хостингу и документация по индексу Nginx .