Перейти к основному содержимому

Установка и обновление

Содержание​

Системные требования​

Сервер​

  • Процессор: 64-разрядный с тактовой частотой 1 ГГц или выше.
  • Свободное место на жестком диске: не менее 1 ГБ.
  • Оперативная память: не менее 2 ГБ.
  • Операционная система:
    • Windows:
      • Windows 10 и выше.
      • Windows Server 2012 (с расширенными обновлениями безопасности) и выше.
    • Linux:
      • Debian 12 и выше.
      • Ubuntu 20.04 и выше.
      • Fedora 39 и выше.
      • Производные от них.

СУБД​

  • SQLite 3 (используется по умолчанию).
  • PostgreSQL 11 и выше.
  • MariaDB 10.3 и выше.

Клиент​

  • Браузер на основе Chromium последней версии: Google Chrome, Microsoft Edge, Яндекс Браузер и т.д.
  • Браузер Mozilla Firefox последней версии.

Установка​

  • Создайте директорию, например, SMS-Automation.
  • Распакуйте архив ТехноДок в созданную директорию.
  • Выполните скрипты ниже в зависимости от операционной системы.

Linux​

sudo mkdir -p /opt/SMS-Automation/TechnoDoc \
&& sudo unzip "[Путь до архива ТехноДок]" -d "/opt/SMS-Automation/TechnoDoc" \
&& sudo chown -R $USER: /opt/SMS-Automation/TechnoDoc

Windows​

mkdir -p "C:\Program Files\SMS-Automation\TechnoDoc" && tar -xf [Путь до архива ТехноДок] -C "C:\Program Files\SMS-Automation\TechnoDoc"

Запуск​

Запуск сервера приложений из терминала​

  • Перейдите в директорию scripts.
  • Выполните скрипт run.

Linux​

cd /opt/SMS-Automation/TechnoDoc/scripts && sh run.sh

Windows​

cd "C:\Program Files\SMS-Automation\TechnoDoc\scripts" && start "run.bat"

Запуск сервера приложений в виде сервиса​

  • Перейдите в директорию scripts/service.
  • Выполните скрипт create.
  • Выполните скрипт start.
  • Для останова сервиса необходимо выполнить скрипт stop.
  • Для удаления сервиса необходимо выполнить скрипт delete.

Linux​

предупреждение

Для создания и запуска сервиса требуется наличие прав суперпользователя.

# Перейти в директорию "scripts/service"
cd /opt/SMS-Automation/TechnoDoc/scripts/service

# Выполнить скрипт "create"
sh create.sh

# Выполнить скрипт "start"
sh start.sh

Windows​

предупреждение

Для создания и запуска сервиса требуется наличие прав администратора.

rem Перейти в директорию "scripts/service"
cd "C:\Program Files\SMS-Automation\TechnoDoc\scripts\service"

rem Выполнить скрипт "create"
create.bat

rem Выполнить скрипт "start"
start.bat

Запуск клиента​

  • Откройте в браузере страницу http://127.0.0.1:8003.
  • Введите лицензионный ключ и нажмите кнопку Активировать.
    • Демо-лицензию можно получить, нажав на кнопку Запросить демо-лицензию.
    • Долгосрочную лицензию можно запросить по адресу technodoc@sms-a.ru.
  • Введите логин/пароль - admin/admin и нажмите кнопку Войти.

Обновление​

предупреждение
  • Перед обновлением рекомендуется создать резервную копию рабочей директории и БД ТехноДок.
  • Совместимость между мажорными релизами не гарантируется.
  • В случае интеграции c SCADA необходимо обновить файлы ТехноДок в проекте SCADA на новые версии файлов из директории components. Перезапуск проекта не требуется.

Обновление на минорную версию​

Для обновления на минорную версию (например, с 7.1.0 на 7.2.5) выполните следующие шаги:

  • Остановите сервер текущей версии ТехноДок.
  • Распакуйте новую версию ТехноДок в директорию, отличную от той, в которой установлена и запущена текущая версия ТехноДок.
  • Скопируйте директорию data, в которой установлена текущая версия ТехноДок, в директорию, куда была распакована новая версия ТехноДок с опцией замены файлов.

Следующие шаги выполняются из директории новой версии ТехноДок:

  • Перейдите в директорию scripts.
  • Выполните скрипт run-migrator.
  • Запустите сервер ТехноДок согласно разделу Запуск.

Обновление проекта КАСКАД 3​

  • В проекте КАСКАД обновите файлы в директориях components/kaskad/panels и components/kaskad/scripts из дистрибутива ТехноДок /components/Kaskad.
  • Перезапустите менеджер technodoc.ctl и менеджер, отвечающий за UI проекта, если ТехноДок открывается из панели проекта КАСКАД.
  • Проверьте доступность настроенного внешнего соединения ТехноДок с проектом КАСКАД в разделе Внешние соединения.

Обновление на мажорную версию​

предупреждение
  • Мы не гарантируем полную совместимость шаблонов и отчетов между мажорными версиями.
  • Встроенный механизм миграции старается поддерживать совместимость, но для всех сценариев это не работает.
  • При обновлении может потребоваться ручная доработка отчетов.
  • Если вы столкнулись с проблемой перехода на новую мажорную версию, пожалуйста, свяжитесь с нами по электронной почте: technodoc@sms-a.ru. Мы предоставим инструкции и поможем провести обновление в индивидуальном порядке.

Для обновления на мажорную версию (например, с 7.2.0 на 8.1.1) выполните следующие шаги:

  • Выполните шаги из раздела Обновление на минорную версию, но не запускайте ТехноДок (последний пункт).
  • Перейдите в папку bin.
  • Запустите ТехноДок из терминала, добавив аргумент content-database-update
    • Linux: ./Sms.TechnoDoc content-database-update
    • Windows: Sms.TechnoDoc.exe content-database-update
  • ТехноДок запустит процесс обновления существующих шаблонов отчетов и экземпляров отчетов.
  • После завершения обновления в консоли появится сообщение Сервер ... успешно запущен. После этого можно закрыть терминал.
  • Запустите ТехноДок согласно разделу Запуск.
  • Проверьте работоспособность отчетов. При необходимости поправьте формулы параметров и верстку в шаблонах отчетов.

Интеграция с СУБД​

ТехноДок может использовать различные СУБД для хранения данных. Для настройки СУБД необходимо выполнить следующие шаги:

  • Остановите сервер ТехноДок.
  • Откройте файл application.conf.
  • Раскомментируйте ключи Type и ConnectionString в секции [Database:Connections:Primary] необходимой СУБД.
  • Укажите имя пользователя, пароль и имя базы данных в строке соединения с СУБД (ключ ConnectionString).
  • Сохраните изменения в файле application.conf.
  • Запустите скрипт run-migrator, расположенный в директории scripts.
    • Для СУБД MariaDB перед выполнением скрипта run-migrator необходимо добавить настройку sql-mode="ANSI_QUOTES" в секцию [mysqld] конфигурационного файла my.cnf и перезапустить сервер MariaDB.
    • После успешного завершения выполнения скрипта run-migrator должна быть создана БД.
  • Запустите сервер ТехноДок согласно разделу Запуск.

Удаление​

  • Остановите сервер ТехноДок.
  • Удалите директорию, в которую был распакован архив ТехноДок.
  • Если ТехноДок был запущен в качестве сервиса, то необходимо удалить сервис при помощи скрипта delete.
  • Если ТехноДок был интегрирован с внешними СУБД, то необходимо вручную удалить БД ТехноДок.