#Как установить

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

Чтобы вы могли быстро и плавно развернуть решение для тикетов в вашей собственной среде NocoBase, мы предлагаем два способа восстановления. Пожалуйста, выберите наиболее подходящий для вас в зависимости от вашей версии пользователя и технического бэкграунда.

Перед началом убедитесь, что:

• У вас уже есть базовая рабочая среда NocoBase. По поводу установки основной системы, пожалуйста, обратитесь к более подробной официальной документации по установке.
• Версия NocoBase 2.0.0-beta.5 и выше.
• Вы уже загрузили соответствующие файлы системы тикетов:
  • Файл резервной копии: nocobase_tts_v2_backup_260302.nbdata — подходит для Способа 1.
  • SQL-файл: nocobase_tts_v2_sql_260302.zip — подходит для Способа 2.

Важные примечания:

• Данное решение создано на базе базы данных PostgreSQL 16, пожалуйста, убедитесь, что в вашей среде используется PostgreSQL 16.
• DB_UNDERSCORED не может быть true: пожалуйста, проверьте ваш файл docker-compose.yml и убедитесь, что переменная окружения DB_UNDERSCORED не установлена в значение true, иначе это приведет к конфликту с резервной копией решения и сбою восстановления.

#Способ 1: Восстановление с помощью менеджера резервного копирования (рекомендуется для пользователей версий Professional/Enterprise)

Этот способ осуществляется через встроенный в NocoBase плагин «Менеджер резервного копирования» (версии Professional/Enterprise) для восстановления в один клик, это самый простой вариант. Однако он предъявляет определенные требования к среде и версии пользователя.

#Основные особенности

• Преимущества:
  1. Удобство управления: можно выполнить в интерфейсе UI, позволяет полностью восстановить все конфигурации, включая плагины.
  2. Полное восстановление: позволяет восстановить все системные файлы, включая файлы шаблонов печати, файлы, загруженные в поля файлов в таблицах и т. д., обеспечивая целостность функционала.
• Ограничения:
  1. Только для версий Professional/Enterprise: «Менеджер резервного копирования» — это плагин корпоративного уровня, доступный только пользователям версий Professional/Enterprise.
  2. Строгие требования к среде: требуется, чтобы ваша среда базы данных (версия, кодировка, настройки чувствительности к регистру и т. д.) была высокосовместима со средой, в которой мы создавали резервную копию.
  3. Зависимость от плагинов: если решение содержит коммерческие плагины, которых нет в вашей локальной среде, восстановление не удастся.

#Шаги выполнения

Шаг 1: 【Настоятельно рекомендуется】 используйте образ full для запуска приложения

Чтобы избежать сбоев восстановления из-за отсутствия клиентов базы данных, мы настоятельно рекомендуем использовать Docker-образ версии full. Он содержит все необходимые сопутствующие программы, избавляя вас от необходимости дополнительной настройки.

Пример команды для загрузки образа:

docker pull nocobase/nocobase:beta-full

Затем используйте этот образ для запуска вашей службы NocoBase.

Примечание: Если вы не используете образ full, вам может потребоваться вручную установить клиент базы данных pg_dump внутри контейнера, что является трудоемким и нестабильным процессом.

Шаг 2: Включите плагин «Менеджер резервного копирования»

1. Войдите в вашу систему NocoBase.
2. Перейдите в Управление плагинами.
3. Найдите и включите плагин Менеджер резервного копирования.

Шаг 3: Восстановление из локального файла резервной копии

1. После включения плагина обновите страницу.
2. Перейдите в меню слева Системное управление -> Менеджер резервного копирования.
3. Нажмите кнопку Восстановить из локальной копии в правом верхнем углу.
4. Перетащите загруженный файл резервной копии в область загрузки.
5. Нажмите Отправить и терпеливо дождитесь завершения восстановления системой; этот процесс может занять от нескольких десятков секунд до нескольких минут.

#Примечания

• Совместимость базы данных: это самый важный момент данного способа. Версия, кодировка и настройки чувствительности к регистру вашей базы данных PostgreSQL должны соответствовать исходному файлу резервной копии. В частности, имя schema должно совпадать.
• Соответствие коммерческих плагинов: пожалуйста, убедитесь, что у вас есть и включены все коммерческие плагины, необходимые для решения, иначе восстановление будет прервано.

#Способ 2: Прямой импорт SQL-файла (универсальный, больше подходит для Community версии)

Этот способ восстанавливает данные путем прямого управления базой данных, минуя плагин «Менеджер резервного копирования», поэтому он не имеет ограничений по плагинам версий Professional/Enterprise.

#Основные особенности

• Преимущества:
  1. Нет ограничений по версии: подходит для всех пользователей NocoBase, включая Community версию.
  2. Высокая совместимость: не зависит от инструментов dump внутри приложения, работает до тех пор, пока есть подключение к базе данных.
  3. Высокая отказоустойчивость: если решение содержит коммерческие плагины, которых у вас нет, соответствующие функции не будут включены, но это не повлияет на нормальное использование других функций, и приложение сможет успешно запуститься.
• Ограничения:
  1. Требуются навыки работы с базой данных: пользователям необходимо обладать базовыми навыками работы с БД, например, знать, как выполнить .sql файл.
  2. Потеря системных файлов: этот способ приведет к потере всех системных файлов, включая файлы шаблонов печати, файлы, загруженные в поля файлов в таблицах и т. д.

#Шаги выполнения

Шаг 1: Подготовьте чистую базу данных

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

Шаг 2: Импортируйте .sql файл в базу данных

Получите загруженный файл базы данных (обычно в формате .sql) и импортируйте его содержимое в базу данных, подготовленную на предыдущем шаге. Существует несколько способов сделать это в зависимости от вашей среды:

• Вариант А: Через командную строку сервера (на примере Docker) Если вы используете Docker для установки NocoBase и базы данных, вы можете загрузить .sql файл на сервер и использовать команду docker exec для выполнения импорта. Предположим, что ваш контейнер PostgreSQL называется my-nocobase-db, а файл — ticket_system.sql:

  # Копирование sql-файла в контейнер
  docker cp ticket_system.sql my-nocobase-db:/tmp/
  # Вход в контейнер и выполнение команды импорта
  docker exec -it my-nocobase-db psql -U your_username -d your_database_name -f /tmp/ticket_system.sql

• Вариант Б: Через удаленный клиент базы данных Если порт вашей базы данных открыт, вы можете использовать любой графический клиент базы данных (например, DBeaver, Navicat, pgAdmin и т. д.) для подключения к БД, открыть новое окно запроса, вставить туда все содержимое .sql файла и выполнить его.

Шаг 3: Подключитесь к базе данных и запустите приложение

Настройте параметры запуска NocoBase (такие как переменные окружения DB_HOST, DB_PORT, DB_DATABASE, DB_USER, DB_PASSWORD и т. д.), чтобы они указывали на базу данных, в которую вы только что импортировали данные. Затем запустите службу NocoBase в обычном режиме.

#Примечания

• Права доступа к базе данных: этот способ требует наличия учетной записи и пароля с правами на прямое управление базой данных.
• Статус плагинов: после успешного импорта, хотя данные коммерческих плагинов в системе присутствуют, если вы не установили и не включили соответствующие плагины локально, связанные функции не будут отображаться и использоваться, но это не приведет к сбою приложения.

#Резюме и сравнение

Надеемся, что данное руководство поможет вам успешно развернуть систему тикетов. Если в процессе работы у вас возникнут какие-либо вопросы, пожалуйста, обращайтесь к нам в любое время!