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

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

Установка​

Для установки необходимо выполнить следующие шаги:

  • Создать директорию (например, Programs), в которую будет установлено ТехноДок:
    • Linux: sudo mkdir /opt/Programs && sudo chown $USER: /opt/Programs
    • Windows: mkdir "C:/Programs"
предупреждение

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

  • Распаковать архив с ТехноДок в созданную директорию:
    • Linux: unzip -d /opt/Programs/TechnoDoc [Путь до директории архивом ТехноДок]/TechnoDoc-[версия приложения].zip
    • Windows: unzip -d "C:/Programs/TechnoDoc" [Путь до директории с архивом ТехноДок]/TechnoDoc-[версия приложения].zip
  • Добавить право на запуск сервера и мигратора ТехноДок:
    • Для Linux:
      sudo chmod +x /opt/Programs/TechnoDoc/bin/Sms.TechnoDoc
      sudo chmod +x /opt/Programs/TechnoDoc/utils/DbMigrator/Sms.DbMigrator
    • Для Windows: выполнение команд не требуется
  • Запустить скрипт start, расположенный в директории scripts в корневой директори ТехноДок:
    • Для Linux: sh /opt/Programs/TechnoDoc/scripts/start.sh
    • Для Windows: start C:/Programs/TechnoDoc/scripts/start.bat
  • Открыть браузер и перейти по адресу http://localhost:8003.
  • В появившемся модальном окне Активация лицензии ввести лицензионный ключ и нажать кнопку Активировать. Лицензионный ключ для демо-лицензии может быть запрошен из модального окна. Долгосрочная лицензия может быть запрошена по адресу technodoc@sms-a.ru.
  • Авторизоваться в системе. Логин и пароль по умолчанию - admin.

Запуск в качестве сервиса​

Для запуска в качестве сервиса необходимо перейти в директорию scripts/service и выполнить соответствующий скрипт:
Для Linux (из терминала):

  • sh create.sh - для создания сервиса.
  • sh start.sh - для запуска сервиса.
  • sh stop.sh - для останова сервиса.
  • sh delete.sh - для удаления сервиса.

Для Windows (из командной строки с правами администратора):

  • create.bat - для создания сервиса.
  • start.bat - для запуска сервиса.
  • stop.bat - для останова сервиса.
  • delete.bat - для удаления сервиса.

Обновление​

ТехноДок поддерживает систему семантического версионирования и гарантирует обратную совместимость для новых версий внутри мажорного релиза. Например, БД и шаблоны отчетов созданные для версии 6.0.0 после процесса обновления будут совместимы с версией 6.2.3.

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

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

Шаги обновления​

Для обновления сервера выполните следующие действия:

  • Остановите ТехноДок:
    • Если ТехноДок запущен в терминале при помощи скрипта start.sh/start.bat, то закройте терминал или остановите процесс (CTRL+C).
    • Если ТехноДок запущен при помощи службы, то остановите службу technodoc-server/TechnoDocServer.
  • Сделайте бэкап текущей установки (директория установки) и БД ТехноДок.
  • Обновите файлы:
    • Если используете БД SQLite со стандартным путем установки, то удалите все директории кроме data/databases, файла data/technodoc.license и файла technodoc.settings.ini.
    • Если используете другой тип БД, то удалите все данные из директории установки кроме файла data/technodoc.license и файла technodoc.settings.ini.
    • Разархивируйте новую версию в директорию, где была установлена старая версия без замены файлов.
  • Обновите БД:
    • Перейдите в директорию utils/DbMigrator.
    • В файле appsettings.ini укажите настройки подключения к БД.
    • Запустите Sms.DbMigrator для обновления БД.
  • Запустите ТехноДок:
    • Если ТехноДок установлен в качестве службы, то запустите скрипт start.sh/start.bat из директории scripts/service.
    • Если ТехноДок запускается вручную, то запустите скрипт start.sh/start.bat из директории scripts.
  • Если ТехноДок интегрирован со SCADA системами (КАСКАД, Alpha, АСОКУ или WinCC OA), то скопируйте скрипты и панели из директории components в директории проекта SCADA системы и перезапустите проект.

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

Если необходимо выполнить обновление на новую мажорную версию(например, обновить ТехноДок с версии 6 на версию 7), то рекомендуется выполнить следующие шаги:

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