unrestricted 権限を持つ管理者として、システム設定 → ポータル管理を開きます。登録済みポータルを検索し、インストール状態で絞り込み、インストール、表示、アンインストールできます。
管理画面が扱うのはアプリに含まれるコードです。npm から新しいパッケージを取得するストアではありません。ソース追加後は Client/Server 登録と開発サービスの再起動が必要です。本番ではアプリを再ビルドしてデプロイします。
インストール
- 未インストールのポータルを探し、インストールを選びます。
- 依存関係の確認、必要な接続のマイグレーションと seed、リソースの起動を待ちます。
- インストール済みになってからポータルを開きます。
生成直後のポータルは未インストールです。必要な接続とドライバーを用意し、宣言された依存ポータルを先にインストールします。ソース生成やパッケージ登録だけでは有効になりません。
インストール中は利用できません。データベース処理が未完了、または起動に失敗した場合、インストール済みとして扱いません。
アンインストールと再インストール
アンインストールは入口を閉じ、登録されたリソースを停止します。業務データ、設定記録、マイグレーション履歴は保持されます。ソース、npm 依存関係、業務データベースを削除する操作ではありません。
インストール済みの別ポータルが依存している場合、先に依存元を処理します。システムは安全でないアンインストールを拒否します。確認前に、そのポータルを利用する業務が残っていないか確認してください。
再インストールは実行履歴に従って未実行のデータベース処理を行い、既存データを保持します。最初からやり直すために履歴ファイルを削除したり、実行済みマイグレーションを編集したりしないでください。
状態と失敗からの復旧
| 状態 | 意味と対応 |
|---|---|
| 未インストール | コードは登録済みだが利用不可 |
| インストール中/更新中 | 依存関係確認、データベース処理、起動の完了を待つ |
| インストール済み | 有効化済み。権限に従って利用できる |
| アンインストール中 | リソース停止の完了を待つ |
| 失敗 | 失敗段階とサーバーログを確認し、原因を修正して再試行 |
依存関係確認、データベース初期化、起動、停止で失敗することがあります。データベースでは接続設定、アカウント権限、マイグレーションと seed を確認します。起動や停止ではサービスとリソースの終了処理を確認します。start(onStop) で取得するリソースには終了処理を登録してください。
複数接続では処理の一部だけが完了している場合があります。再試行は接続ごとの履歴を使い、成功済み接続をまとめてロールバックすることは保証しません。アプリ再起動でも受け付け済みの未完了操作の復旧を試みます。失敗を飛ばすためにインストール状態を直接変更したり、履歴を削除したりしないでください。
別の管理者による変更が通知されたら、最新状態に更新してから操作を判断します。古い状態で送信を繰り返さないでください。
アプリと一緒に更新
ポータルは個別の実行バージョンを選択せず、アプリと一緒にビルド、リリース、更新されます。アプリ起動時または pnpm nocobase db apply 実行時、インストール済みポータルの未実行データベース処理を適用します。未インストールのポータルが自動インストールされることはありません。
起動時に実行する場合は、各接続のマイグレーションと seed に対応する autoRun を有効にします。明示的なデータベース計画を実行する場合は、必要な処理全体を含めます。更新に失敗したポータルは原因を解消するまで利用不可です。
アンインストール済みのポータルも、検証と再インストールのためにマイグレーションと seed の履歴ソースを保持します。リリース前に更新経路を検証して業務データをバックアップし、アプリのリリースとNocoBase の更新に従ってください。