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

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

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

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

• У вас уже есть базовая среда выполнения NocoBase. Информацию об установке основной системы см. в более подробной официальной документации по установке.
• Версия NocoBase v2.1.0-beta.2 и выше
• Вы уже скачали соответствующие файлы системы CRM:
  • Файл резервной копии: nocobase_crm_v2_backup_260223.nbdata - подходит для Способа 1
  • SQL-файл: nocobase_crm_v2_sql_260223.zip - подходит для Способа 2

Важное примечание:

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

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

Этот способ предполагает восстановление в один клик через встроенный в NocoBase плагин "Менеджер резервного копирования" (версии Pro/Enterprise), что является самой простой операцией. Однако он предъявляет определенные требования к среде и версии пользователя.

#Основные характеристики

• Преимущества:
  1. Удобство работы: выполняется в интерфейсе UI, позволяет полностью восстановить все конфигурации, включая плагины.
  2. Полное восстановление: позволяет восстановить все системные файлы, включая файлы шаблонов печати, файлы, загруженные в поля файлов в коллекциях и т. д., обеспечивая целостность функций.
• Ограничения:
  1. Только для версий Pro/Enterprise: «Менеджер резервного копирования» — это плагин корпоративного уровня, доступный только пользователям версий Pro/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)

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

#Основные характеристики

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

#Шаги операции

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

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

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

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

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

  # Скопируйте sql-файл внутрь контейнера
  docker cp nocobase_crm_v2_sql_260223.sql my-nocobase-db:/tmp/
  # Войдите в контейнер и выполните команду импорта
  docker exec -it my-nocobase-db psql -U nocobase -d nocobase -f /tmp/nocobase_crm_v2_sql_260223.sql

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

  1. Нажмите правой кнопкой мыши на целевую базу данных
  2. Выберите «Выполнить SQL-файл» или «Выполнить SQL-скрипт»
  3. Выберите скачанный файл .sql и выполните его

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

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

#Примечания

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

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

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