Руководство по установке InsightStream для эксперта

Руководство по установке InsightStream для эксперта

Содержание

Контактная информация

В случае возникновения проблем или вопросов напишите нашему специалисту:

  • Email: shishkov@insightstream.ru
  • Контакт в Telegram: @walyoung
  • Рабочие часы: пн-пт с 10:30 до 20:00 (МСК)

Необходимые требования

Перед началом установки убедитесь, что ваша система соответствует следующим требованиям:

  • Операционная система: Linux
  • Минимум 4 ГБ оперативной памяти
  • Не менее 10 ГБ свободного места на диске, рекомендуется 15 ГБ
  • Стабильное подключение к интернету

До начала установки

1. Распаковка дистрибутива

  • Скачайте архив с дистрибутивом InsightStream по этой ссылке. Логин и пароль будут введены автоматически при переходе по этой уникальной ссылке.
  • Используйте любой архиватор для распаковки файлов
  • Выберите удобное место для размещения файлов (рекомендуется папка с коротким путем без кириллицы)

2. Установка Docker и Docker Compose

  • Docker является обязательным компонентом для работы InsightStream
  • Установка Docker в Linux:
    • Linux (Ubuntu): 
      sudo apt update
sudo apt install docker.io docker-compose
sudo systemctl enable --now docker
  • После установки проверьте работоспособность Docker с помощью команды: 
    docker --version
docker-compose --version

3. Проверка сетевых настроек Docker

  • Убедитесь, что в сети Docker не используются адреса из диапазона вашей локальной сети
  • Проверьте текущие настройки командой: 
    docker network ls
docker network inspect bridge
  • При необходимости измените настройки сети Docker в файле /etc/docker/daemon.json (Linux) или через Docker Desktop (Windows/macOS)

4. Проверка занятости портов

  • InsightStream использует следующие порты: 80, 3000, 5672, 6333, 8000, 8051, 15672
  • Проверьте, не заняты ли эти порты другими приложениями:
    • Linux: в терминале введите sudo lsof -i -P -n | grep "80\|3000\|5672\|6333\|8000\|8051\|15672"
  • Если порты заняты, остановите соответствующие службы на время тестирования InsightStream

5. Настройка брандмауэра

  • Убедитесь, что брандмауэр не блокирует указанные порты
  • Linux: 
    sudo ufw allow 80/tcp
sudo ufw allow 3000/tcp
sudo ufw allow 5672/tcp
sudo ufw allow 6333/tcp
sudo ufw allow 8000/tcp
sudo ufw allow 8051/tcp
sudo ufw allow 15672/tcp

6. Определение внешнего адреса

  • Определите IP-адрес или доменное имя, по которому компьютер будет доступен из сети
  • Для локальной сети можно использовать локальный IP-адрес компьютера:
    • Linux: введите ifconfig или ip addr show в терминале
  • Для доступа из интернета необходимо:
    • Иметь статический IP-адрес или настроенный DDNS-сервис
    • Настроить перенаправление портов на вашем маршрутизаторе
  • Запишите этот адрес – в дальнейшем он будет обозначаться как EXT_ADDR

7. Проверка доступа в интернет

  • Проверьте наличие доступа в интернет, если используется обычная версия InsightStream

Установка

1. Подготовка файлов

  • Распакуйте архив с дистрибутивом в выбранную директорию
  • Убедитесь, что в этой директории присутствуют следующие файлы:
    • docker-compose.yml
    • .env
    • Прочие файлы конфигурации

2. Настройка конфигурации

  • Откройте файл .env в любом текстовом редакторе (блокнот, VS Code, Notepad++ и т.д.)
  • Найдите строку с переменной BASE_URL
  • Замените значение этой переменной на http://EXT_ADDR (вместо EXT_ADDR используйте ваш реальный IP-адрес или доменное имя)
  • Пример: если ваш IP-адрес 192.168.1.100, то строка должна выглядеть так: BASE_URL=http://192.168.1.100
  • Сохраните изменения

3. Загрузка образов Docker

  • Откройте командную строку или терминал
  • Перейдите в директорию с распакованными файлами: 
    cd путь/к/директории/с/файлами
  • Выполните команду для загрузки необходимых Docker-образов: 
    docker compose pull
  • Дождитесь завершения загрузки всех образов (это может занять некоторое время в зависимости от скорости интернета)

4. Запуск системы

  • В той же директории выполните команду: 
    docker compose up -d
  • Флаг -d запускает контейнеры в фоновом режиме
  • Дождитесь запуска всех контейнеров
  • Проверьте статус запущенных контейнеров: 
    docker ps
  • Все контейнеры должны иметь статус "Up"

Создание индекса

1. Доступ к веб-интерфейсу

  • Откройте веб-браузер (Chrome, Firefox, Edge и т.д.)
  • В адресной строке введите: http://EXT_ADDR/indexui (замените EXT_ADDR на ваш реальный адрес)
  • Пример: http://192.168.1.100/indexui
  • Дождитесь загрузки страницы

2. Создание бота

  • На открывшейся странице заполните форму:
    • Ваш email: В этом поле можно использовать несуществующий адрес, например test@test.ru, никаких писем отправлено не будет. Этот адрес будет служить идентификатором созданного бота (далее AGENT_ID)
    • Пользовательская история: Можно взять один из готовых примеров или написать свой для описания роли бота
  • Убедитесь, что все обязательные поля заполнены

3. Загрузка файлов для индексации

  • В секции загрузки файлов нажмите кнопку "Выбрать файлы" или перетащите файлы в указанную область
  • Поддерживаемые форматы файлов: PDF, DOCX, TXT, HTML, с текстовым слоем, который можно скопировать из документа. Для тестирования рекомедуется загрузить один файл минимального размера и с минимальным количеством страниц для ускорения процесса индексации
  • После загрузки файла / файлов нажмите кнопку создания бота

4. Обработка индекса

  • Процесс создания индекса может занять от минуты до часа в зависимости от объема загруженных данных
  • Не закрывайте и не перезагружайте вкладку браузера и не выключайте компьютер до завершения процесса
  • После успешного создания под кнопкой появится ссылка для доступа к боту

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

1. Доступ к боту

  • В браузере введите адрес: http://EXT_ADDR/AGENT_ID
    • Замените EXT_ADDR на ваш реальный адрес
    • Замените AGENT_ID на email, который вы указали при создании бота
  • Пример: http://192.168.1.100/example@mail.com
  • Откроется страница с интерфейсом бота

2. Взаимодействие с ботом

  • Введите ваш вопрос, связанный с информацией в документе, в поле текстового ввода
  • Нажмите кнопку отправки запроса справа от текстового поля
  • Дождитесь ответа бота (обычно занимает от нескольких секунд до минуты)
  • Бот предоставит ответ на основе загруженных документов, с указанием источников информации

Удаление системы

1. Остановка контейнеров

  • Откройте командную строку или терминал
  • Перейдите в директорию с файлами InsightStream: 
    cd путь/к/директории/с/файлами
  • Выполните команду для остановки и удаления контейнеров: 
    docker compose down
  • Дождитесь полной остановки всех контейнеров

2. Удаление файлов

  • После остановки контейнеров вы можете удалить все файлы из директории установки
  • Linux: используйте команду rm -rf путь/к/директории
  • Обратите внимание: для удаления некоторых файлов могут потребоваться права администратора/суперпользователя
  • На Linux используйте команду sudo перед командами удаления

3. Очистка Docker

  • Для удаления образов Docker выполните: 
    # Удаление конкретного образа
docker image rm имя_образа

# Удаление неиспользуемых образов
docker image prune -a

# Полная очистка системы Docker (образы, контейнеры, тома)
docker system prune -a
  • Подтвердите удаление, когда система запросит подтверждение

Возможные проблемы и их решения

1. Не удается запустить Docker

  • Убедитесь, что служба Docker запущена
  • Проверьте, имеет ли ваш пользователь необходимые права
  • На Linux добавьте пользователя в группу docker: sudo usermod -aG docker $USER и перезагрузите систему

2. Конфликт портов

  • Если какие-то порты уже заняты, измените их в файле docker-compose.yml
  • Например, замените 80:80 на 8080:80 для использования порта 8080 вместо 80

3. Ошибка при создании индекса

  • Проверьте, что загруженные файлы соответствуют описанным условиям
  • Проверьте журналы Docker: docker compose logs

4. Нет доступа к веб-интерфейсу

  • Убедитесь, что контейнеры запущены: docker ps
  • Проверьте настройки брандмауэра
  • Убедитесь, что вы используете правильный адрес (EXT_ADDR)