Развёртывание с Docker

Альтернатива пакету .deb: сервер uVersion и его база данных PostgreSQL работают в контейнерах, запускаемых одной командой docker compose up. Идеально, если вы предпочитаете контейнерное развёртывание или хотите быстро попробовать.

Требования: Docker Engine 20.10+ с плагином Compose v2 (docker compose version) и лицензионный ключ uVersion. Сервер отказывается запускаться без действительного подписанного ключа: получите его в своём аккаунте (или запросите его на странице регистрации).

Установка

1. Получить compose и шаблон окружения

Два файла в новой папке, которая станет папкой стека: docker-compose.yml и шаблон .env.

mkdir uversion && cd uversion
wget -N -O docker-compose.yml https://uversion.io/downloads/server/docker/docker-compose.yml
wget -N -O .env https://uversion.io/downloads/server/docker/env.example

2. Получить образ

В сети достаточно реестра:

docker compose pull

Без доступа к Интернету (изолированная сеть) вместо этого скачайте архив и загрузите его: он несёт то же имя образа, что и compose, поэтому запуск находит его, ничего не скачивая.

wget -N https://uversion.io/downloads/server/docker/uversion-server_latest_docker.tar.gz
docker load -i uversion-server_latest_docker.tar.gz

3. Заполнить .env

Обязательны два значения: UVERSION_LICENCE__KEY (ваш лицензионный ключ, длинная подписанная строка, полученная по электронной почте) и POSTGRES_PASSWORD (надёжный пароль для входящей в комплект базы данных).

nano .env

Секрет, которым подписываются сессии, создаётся при первом запуске и хранится в каталоге данных. Вам ничего не нужно вводить. Он входит в резервную копию: если он исчезнет, каждому придётся войти заново один раз, ничего не теряется. Если вы предпочитаете задать свой (минимум 32 символа), заполните UVERSION_SECURITY__JWT_SECRET в .env: он действительно передаётся в контейнер, который затем использует его вместо создания нового.

# Changer reellement le mot de passe de la base
docker compose exec db psql -U uversion -c "ALTER USER uversion PASSWORD 'nouveau-mot-de-passe'"

# Puis reporter la MEME valeur dans POSTGRES_PASSWORD (.env) et relancer
docker compose up -d

4. Запустить стек

docker compose up -d

После этого сервер доступен по адресу https://YOUR-HOST:8443. Не требуется ни домена, ни сертификата Let’s Encrypt: этим занимается модель TOFU, то есть доверие при первом контакте, как SSH, когда он при первом разе просит вас подтвердить отпечаток машины.

5. Считать отпечаток сервера

Он переписывается в журналы при каждом запуске:

# L'empreinte du serveur, reecrite dans les journaux a chaque demarrage
docker compose logs server | grep -i "TLS fingerprint"

Это отпечаток сервера (SHA-256 его сертификата): сервер отдаёт самоподписанный HTTPS на порту 8443, и каждый клиент подтверждает его при первом подключении. Поделитесь им со своей командой (см. Отпечаток TLS). Не путайте его с контрольной суммой, которая служит для проверки скачанного файла: этот идентифицирует ваш сервер.

6. Считать первоначальный пароль администратора

Войдите как admin с этим паролем, затем смените его. Файл удаляется, как только вы его меняете.

# Le mot de passe admin initial (le fichier disparait des que vous le changez)
docker compose exec server cat /data/initial-admin-password

Чтобы следить за запуском в реальном времени, подойдёт docker compose logs -f server, но не ставьте её в середину последовательности команд: -f следует за журналами бесконечно и никогда не возвращает управление (Ctrl + C для выхода).

Данные и база данных

Всё состояние сервера (хранилище чанков, сертификат TLS и, следовательно, отпечаток, идентичность сервера) живёт в одном каталоге хоста, а база данных PostgreSQL в другом. Оба настраиваются в .env:

# Dans .env : placer les donnees et la base sur un disque large et sauvegarde
UVERSION_DATA_DIR=/srv/uversion/data      # chunks, cert TLS, identite serveur
UVERSION_DB_DIR=/srv/uversion/db          # PostgreSQL fourni

Для настоящего развёртывания направьте UVERSION_DATA_DIR на большой резервируемый диск: двоичные чанки проекта Unreal могут быть объёмными. Контейнер сам настраивает права смонтированного каталога (он запускается от root лишь на время исправления владельца, затем понижается до непривилегированного пользователя), так что вам не нужно заранее ничего делать через chown.

Чтобы использовать уже имеющийся внешний PostgreSQL, заполните UVERSION_DATABASE__URL в .env, затем удалите службу db и блок depends_on в docker-compose.yml.

# Dans .env : brancher un PostgreSQL existant
UVERSION_DATABASE__URL=postgres://user:motdepasse@db.interne:5432/uversion

Перенос данных и базы данных

Самый простой случай, задать обе переменные до первого up: ещё ничего не существует, копировать нечего. Если стек уже работает, нужно остановить его и скопировать каталоги вручную, сохраняя владельцев.

1. Остановить стек

Во время копирования ничто не должно писать:

docker compose down

2. Скопировать два каталога

Именно -a сохраняет владельцев и права:

sudo rsync -a ./data/server/ /srv/uversion/data/
sudo rsync -a ./data/db/     /srv/uversion/db/

3. Указать .env на новое расположение

# Dans .env, LES DEUX lignes, pas une seule
UVERSION_DATA_DIR=/srv/uversion/data
UVERSION_DB_DIR=/srv/uversion/db

4. Перезапустить

docker compose up -d

Три ловушки путей, все встречались:

• Относительный путь разрешается относительно файла compose, а не относительно каталога, из которого вы запускаете команду. ./data/server всегда обозначает соседа docker-compose.yml.
• Сетевой ресурс (NFS, CIFS, общий ресурс Windows) обычно отказывает в chown, который контейнер выполняет при запуске. Тогда контейнер немедленно завершается с ошибкой прав, которая не упоминает ни uVersion, ни хранилище. Используйте локальный диск или блочный том.
• Именно rsync -a сохраняет владельцев и права. Копия, сделанная cp без опций или из файлового проводника, сбрасывает всё на текущую учётную запись, и PostgreSQL тогда отказывается запускаться на собственном каталоге.

Эксплуатация

Резервное копирование: база данных

Она несёт метаданные: файлы, ревизии, пользователи, блокировки.

docker compose exec db pg_dump -U uversion uversion > uversion-db.sql

Резервное копирование: данные сервера

Это каталог хоста, обозначенный UVERSION_DATA_DIR. Обе резервные копии важны: одна без другой ничего не восстанавливает.

# .env n'est pas charge dans votre shell, chargez-le pour reutiliser la variable
set -a; . ./.env; set +a
DATA_DIR="$UVERSION_DATA_DIR"
[ -n "$DATA_DIR" ] || DATA_DIR=./data/server      # valeur par defaut

tar czf uversion-data.tar.gz -C "$DATA_DIR" .

Обновление

Данные и база данных не затрагиваются, миграции применяются при запуске.

docker compose pull
docker compose up -d   # les migrations s'appliquent au demarrage

В изолированной сети вместо этого загрузите более свежий архив:

wget -N https://uversion.io/downloads/server/docker/uversion-server_latest_docker.tar.gz
docker load -i uversion-server_latest_docker.tar.gz
docker compose up -d

Остановка

docker compose stop останавливает контейнеры, docker compose down удаляет их. В обоих случаях ваши данные остаются на месте.