Инструкция по установке программного обеспечения

1. Общие сведения

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

Программа состоит из серверной части и веб-интерфейса. Серверная часть устанавливается на сервер по этой инструкции. Графический процессор не нужен: все вычисления, включая распознавание речи, выполняются на центральном процессоре, драйверы NVIDIA, CUDA Toolkit и графический процессор для работы не нужны. Устанавливать программы на устройство пользователя не нужно: пользователь работает с программой через веб-браузер по адресу сервера.

По этой инструкции развёрнут экземпляр, который предоставлен для экспертной проверки. Сведения о доступе к нему приведены в документе «Сведения об экземпляре программного обеспечения и доступе к нему».

2. Комплект поставки

Комплект поставки — архив исходных текстов и файлов развёртывания transcriptic-<версия>.tar.gz. Его предоставляет правообладатель. Основные каталоги архива:

Все компоненты собираются в образы Docker при установке. Нейросетевые модели (около 1,2 ГБ) скачиваются автоматически при первом запуске.

3. Требования к серверу

3.1. Аппаратные требования

3.2. Программные требования

Docker ставится скриптом установки (раздел 4.2).

4. Установка

Все команды выполняются в терминале сервера.

4.1. Распаковка комплекта поставки

sudo mkdir -p /opt/transcriptic
sudo tar -xzf transcriptic-<версия>.tar.gz -C /opt/transcriptic
cd /opt/transcriptic

4.2. Подготовка сервера

sudo bash deploy/single-node/scripts/setup-host.sh

Скрипт:

1. устанавливает базовые пакеты;
2. выводит сведения о процессоре и памяти и предупреждает, если их меньше рекомендуемого;
3. устанавливает Docker Engine и Docker Compose (из репозитория Docker, а при его недоступности — из репозитория Ubuntu) и даёт пользователю, запустившему скрипт, право запускать Docker; после этого нужно перелогиниться;
4. настраивает межсетевой экран ufw: открыты только порты 22, 80, 443 и 8096.

Если Docker Hub с сервера недоступен или работает медленно, укажите зеркало:

sudo DOCKER_REGISTRY_MIRROR=https://mirror.gcr.io bash deploy/single-node/scripts/setup-host.sh

4.3. Настройка

cd deploy/single-node
bash scripts/init-env.sh

Скрипт создаёт файл настроек .env (доступ только владельцу) и генерирует пароли базы данных, внутренний ключ сервисов, ключ API и пароль администратора. Пароль администратора выводится на экран. Число потоков распознавания (ASR_CPU_THREADS, WHISPER_LIVE_THREADS, WHISPER_LIVE_MAX_CLIENTS) скрипт подбирает по числу ядер и объёму памяти сервера.

Затем откройте .env в текстовом редакторе (например, nano .env) и задайте параметры:

Пароли и ключи, сгенерированные скриптом, менять не требуется.

4.4. Первый запуск

docker compose up -d --build

Первая сборка образов занимает 20–40 минут, все образы вместе занимают около 16 ГБ. При первом запуске:

• создаётся база данных: схема, справочники, служебная роль сервисов с правами только на данные и учётная запись администратора из .env;
• до запуска сервисов распознавания скачиваются нейросетевые модели (около 1,2 ГБ): Whisper small, модели определения речи и говорящих, модель разделения музыки demucs;
• HTTPS-шлюз запускается с временным сертификатом и примерно через минуту получает сертификат Let's Encrypt.

Если перехватчик писем Mailpit нужен вместо почтового ящика, задайте в .env SMTP_HOST=mailpit, SMTP_PORT=1025, SMTP_SECURE=false, SMTP_USER=any, SMTP_PASS=any, MAILPIT_UI_AUTH=<логин>:<пароль> и запустите:

docker compose --profile mailpit up -d

Письма будут видны по адресу https://<DOMAIN>/mailpit/.

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

5.1. Состояние контейнеров

docker compose ps

Все сервисы должны быть в состоянии running (у postgres — healthy). Сервисы files-init и models-init завершаются после первого запуска, это нормально.

Готовность сервиса распознавания:

docker compose logs transcribe | grep -m1 "Running on"

5.2. Функциональная проверка

6. Учётные записи

Создание учётной записи с заданным балансом (пароль генерируется и выводится на экран):

bash scripts/db.sh add-user user@example.ru --minutes 600

Учётная запись администратора:

bash scripts/db.sh add-user admin2@example.ru --admin

7. Обслуживание

7.1. Журналы

docker compose logs -f <сервис>

Журналы каждого контейнера хранятся средствами Docker (до 5 файлов по 50 МБ).

7.2. Резервное копирование и восстановление базы данных

bash scripts/db.sh backup
bash scripts/db.sh restore backups/transcriptic-<время>.sql.gz

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

Распакуйте новый комплект поставки поверх каталога /opt/transcriptic и выполните:

cd /opt/transcriptic/deploy/single-node
docker compose up -d --build

Пересобираются только изменившиеся компоненты. База данных и файлы пользователей сохраняются.

7.4. Остановка и запуск

docker compose stop
docker compose start

8. Удаление

Остановка и удаление контейнеров с сохранением данных:

docker compose down

Полное удаление вместе с базой данных, файлами пользователей и моделями:

docker compose down --volumes --rmi all
sudo rm -rf /opt/transcriptic

9. Типовые проблемы

10. Техническая поддержка

Электронная почта: transcriptic@yandex.ru. Телефон: +7 (928) 980-00-89.