#インストール方法

現在のバージョンはバックアップ・リストア形式でデプロイされます。今後のバージョンでは、既存のシステムにソリューションを統合しやすくするため、増分マイグレーション形式に変更される可能性があります。

CRM 2.0 ソリューションをお客様自身の NocoBase 環境に迅速かつスムーズにデプロイしていただくために、2 つのリストア方法を提供しています。ユーザーエディションと技術的な背景に合わせて、最適なものを選択してください。

開始する前に、以下を確認してください：

• すでに基礎となる 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：バックアップマネージャーを使用してリストア（プロフェッショナル/エンタープライズ版ユーザー推奨）

この方法は、NocoBase 内蔵の「バックアップマネージャー」（プロフェッショナル/エンタープライズ版）プラグインを使用してワンクリックでリストアを行うもので、操作が最も簡単です。ただし、環境とユーザーエディションに一定の要件があります。

#主な特徴

• メリット：
  1. 操作が便利：UI 画面で完結し、プラグインを含むすべての設定を完全にリストアできます。
  2. 完全なリストア：テンプレート印刷ファイルや、コレクション内のファイルフィールドでアップロードされたファイルなど、すべてのシステムファイルをリストア可能であり、機能の完全性を保証します。
• 制限事項：
  1. プロフェッショナル/エンタープライズ版限定：「バックアップマネージャー」はエンタープライズ向けプラグインであり、プロフェッショナル/エンタープライズ版ユーザーのみ利用可能です。
  2. 環境要件が厳格：データベース環境（バージョン、大文字小文字の区別設定など）が、バックアップ作成時の環境と高度に互換性がある必要があります。
  3. プラグインの依存関係：ソリューションにローカル環境にない商用プラグインが含まれている場合、リストアは失敗します。

#操作手順

ステップ 1：【強く推奨】 full イメージを使用してアプリケーションを起動する

データベースクライアントの欠如によるリストア失敗を避けるため、full バージョンの Docker イメージを使用することを強く推奨します。これには必要なすべての関連プログラムが内蔵されており、追加設定なしで使用できます。

イメージをプルするコマンド例：

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 ファイルを直接インポート（汎用、コミュニティ版に最適）

この方法は、データベースを直接操作してデータをリストアするため、「バックアップマネージャー」プラグインを経由せず、プロフェッショナル/エンタープライズ版プラグインの制限もありません。

#主な特徴

• メリット：
  1. エディション制限なし：コミュニティ版を含むすべての NocoBase ユーザーに適用されます。
  2. 高い互換性：アプリケーション内の dump ツールに依存せず、データベースに接続できれば操作可能です。
  3. 高い耐障害性：ソリューションに所有していない商用プラグインが含まれている場合、関連機能は有効になりませんが、他の機能の正常な使用には影響せず、アプリケーションは正常に起動できます。
• 制限事項：
  1. データベース操作能力が必要：.sql ファイルの実行方法など、基礎的なデータベース操作能力が必要です。
  2. システムファイルの紛失：この方法では、すべてのシステムファイルが失われます。これにはテンプレート印刷ファイルや、コレクション内のファイルフィールドでアップロードされたファイルなどが含まれます。

#操作手順

ステップ 1：クリーンなデータベースを準備する

インポートするデータのために、新しく空のデータベースを準備します。

ステップ 2：.sql ファイルをデータベースにインポートする

ダウンロードしたデータベースファイル（通常は .sql 形式）を取得し、その内容を前のステップで準備したデータベースにインポートします。実行方法は環境によって異なります：

• オプション A：サーバーのコマンドライン経由（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

• オプション B：リモートデータベースクライアント経由（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 システムの円滑なデプロイに役立つことを願っています。操作中に問題が発生した場合は、いつでもお気軽にお問い合わせください！