Инструкция по установке, запуску и использованию программы «Папка» (серверная часть)

1. Что нужно до начала

Что Требование
Операционная система 64-разрядный Linux (проверено на Ubuntu 24.04 LTS и 26.04 LTS) [ЗАПОЛНИТЬ: вторая ОС из реестра, на которой пройдены испытания]
Среда контейнеров Docker Engine 24 и новее, Docker Compose v2
Процессор не менее 4 ядер
Память не менее 16 ГБ ОЗУ (рекомендуется 32 ГБ)
Диск не менее 100 ГБ свободного места на SSD
Сеть порты 80 и 443 для пользователей; доступ к серверу модели
Доступ пользователь в группе docker

Состав служб: серверное приложение (api_server), фоновые обработчики (background), веб-сервер клиента, сервисы моделей (inference и indexing), база данных PostgreSQL, поисковый индекс OpenSearch, кэш Redis, объектное хранилище, обратный прокси nginx. Для проверки подписи добавляют сервис проверки подписи.

2. Получение дистрибутива

Дистрибутив содержит: образы контейнеров или файл их сборки, каталог deployment с файлами Docker Compose, шаблон настроек .env, файл THIRD_PARTY_NOTICES, файл контрольных сумм checksums.sha256.

  1. Скачайте архив дистрибутива [ЗАПОЛНИТЬ: адрес скачивания].
  2. Проверьте контрольную сумму: sha256sum -c checksums.sha256.
  3. Распакуйте архив в каталог /opt/papka.

3. Установка с помощью Docker Compose

  1. Перейдите в каталог deployment/docker_compose.
  2. Скопируйте шаблон: cp env.prod.template .env.
  3. Откройте .env и задайте:
    • пароль базы данных (POSTGRES_PASSWORD);
    • ключ шифрования учётных данных (ENCRYPTION_KEY_SECRET);
    • адрес сервиса (WEB_DOMAIN);
    • адрес сервера языковой модели.
  4. Запустите службы: docker compose -f docker-compose.prod.yml up -d.
  5. Дождитесь состояния «healthy» у всех служб: docker compose ps.

Миграции базы данных применяются при старте серверного приложения автоматически.

4. Первый вход

  1. Откройте адрес сервиса в браузере.
  2. Зарегистрируйте первого пользователя. Первый пользователь получает роль системного администратора.
  3. Системный администратор создаёт учётную запись администратора безопасности. Роли разделены: одно лицо не должно иметь обе.
  4. В разделе администрирования подключите языковую модель и источники документов.

5. Проверка установки

  1. Проверьте здоровье серверного приложения: запрос /health к службе api_server возвращает код 200.
  2. Загрузите тестовый документ и задайте по нему вопрос в чате.
  3. Проверьте журнал аудита: должна появиться запись о входе.

6. Обновление

Остановите службы, замените файлы дистрибутива на новую версию, сохраните .env, запустите службы командой docker compose up -d. Перед обновлением сделайте копию тома базы данных.

7. Удаление

docker compose down останавливает службы. Команда docker compose down -v удаляет также тома с данными. Выполняйте её только после копирования нужных данных.

8. Установка без выхода в сеть

Образы сохраняют командой docker save на компьютере с доступом в сеть и загружают на сервер командой docker load. Затем включают автономный режим в настройках. Пример файла настроек — docker-compose.airgap-test.yml в каталоге deployment.

Запуск и остановка

Запуск: docker compose up -d. Состояние: docker compose ps. Остановка: docker compose stop. Повторный запуск после остановки: docker compose start.

Использование

Порядок работы пользователя, роли и повседневные операции описаны в разделе «Руководство по эксплуатации».