nocobase-env-bootstrap について
nocobase-env-bootstrapは、NocoBaseの環境確認、インストール、起動、アップグレード、トラブルシューティングを支援するスキルです。アプリ環境も管理し、アップグレードやデータベース操作に確認手順を設け、後続スキル用のローカルCLI環境を初期化します。
主な機能
- 01ホスト環境と依存関係の確認
- 02Docker、create-nocobase-app、Gitでのインストール
- 03単一インスタンスのNocoBase起動
- 04CLIアプリ環境の初期化と管理
- 05事前・事後チェック付きアップグレード
- 06診断情報の収集と一般的な障害の調査
活用シーン
- 01NocoBaseの新規インストールと起動
- 02単一NocoBaseインスタンスのアップグレード
- 03CLIアプリ環境の追加や切り替え
- 04インストールや実行時の問題の診断
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ nocobase/ skills --skill nocobase-env-bootstrapインストール後、Claude Code で/nocobase-env-bootstrapを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlassets/docker-templates.mdinstall-templates.mdassets/docker-templates/docker-compose.external.mariadb.ymldocker-compose.external.mysql.ymldocker-compose.external.postgres.ymldocker-compose.mariadb.ymldocker-compose.mysql.ymldocker-compose.postgres.ymlassets/install-templates/create-app.command.template.txtgit.clone.command.template.txtgit.env.templatereferences/app-env-manage.mdinstall-runbook.mdmcp-call-examples.mdmcp-client-templates.mdmcp-powershell-helpers.mdmcp-runbook.mdmcp-tool-shapes.mdmcp-troubleshooting.mdpreflight-checklist.mdtroubleshooting.mdupgrade-runbook.mdusage-guide.mdscripts/cli-postcheck.ps1cli-postcheck.shcollect-diagnostics.ps1collect-diagnostics.shenv-manage.mjsinstall.mjs詳細
目標
環境チェック、インストール、ローカル CLI 環境のブートストラップ、アプリケーション環境の管理、単一インスタンスのアップグレード、頻発するトラブルシューティングを行い、ユーザーが NocoBase をゼロの状態からスムーズにセットアップして実行できるよう支援します。
対象範囲
- 可能な場合は、ホスト環境と必要な依存関係を自動的に検出します。
- Docker、create-nocobase-app、または Git を使用して NocoBase をインストールし、初期化します。
- 1 つの環境(ローカルマシンまたは単一サーバー)で NocoBase を起動します。
- インストール成功後、後続の CLI 優先スキルで使用するためのローカル
nocobase-ctl環境(local)を自動的にブートストラップします。 - スキル内のラッパースクリプトを通じて、後続のスキルで再利用できるアプリ環境管理アクション(
add、use、current、list)を提供します。 - 明示的な事前チェックと事後チェックを通じて、安全な単一インスタンスのアップグレードを実行します。
- 頻発するセットアップおよび実行時の問題を診断し、修正します。
対象外
- 環境をまたぐリリースワークフローは扱いません。
- 移行マネージャーや環境間のデータ昇格はオーケストレーションしません。
- ユーザーの明示的な確認なしに、データベースの削除やデータボリュームの削除など、元に戻せない破壊的な変更は行いません。
- 不明なエラーを隠しません。実行したコマンドと取得した失敗の兆候を必ずそのまま表示します。
- 外部データベース用の compose テンプレートが組み込みで存在すると想定しません。外部データベースが必要な場合は、ユーザーからデータベース接続情報を明示的に提供してもらいます。
入力契約
| 入力 | 必須 | デフォルト | 検証 | 確認の質問 |
|---|---|---|---|---|
mode | いいえ | quick | quick/standard/rescue のいずれか | 「クイックモード、標準モード、レスキューモードのどれを使用しますか?」 |
task | はい | ユーザーのテキストから推定 | preflight/install/upgrade/diagnose/app-manage のいずれか | 「preflight、install、upgrade、diagnose、app-manage のどれを実行しますか?」 |
install_method | install では任意、upgrade では任意 | install:docker、upgrade:auto | auto/docker/create-nocobase-app/git のいずれか | 「どのインストール方法を使用しますか?」 |
release_channel | install または upgrade | latest | latest/beta/alpha のいずれか | 「どのリリースチャンネルを使用しますか(Docker インストールで AI ビルド機能が必要な場合は、alpha を推奨します)?」 |
target_version | upgrade では任意 | なし | 空でないバージョンまたはイメージタグ | 「どのバージョンにアップグレードしますか?」 |
backup_confirmed | upgrade では必須 | false | アップグレード前に true である必要があります | 「データベースのバックアップは完了し、確認済みですか?」 |
upgrade_confirmed | dry-run でない upgrade では必須 | false | dry-run でないアップグレードの前に true である必要があります | 「解決されたアップグレード方法、バージョン、再起動計画を確認してください。」 |
restart_mode | upgrade では任意 | manual | manual/dev/start/pm2 のいずれか | 「アップグレード後、アプリをどのように再起動しますか?」 |
clean_retry | git による upgrade では任意 | false | ブール値(true/false) | 「git によるアップグレードが失敗した場合、クリーンリトライを有効にしますか?」 |
allow_dirty | git による upgrade では任意 | false | ブール値(true/false) | 「変更のある git ワークツリーでのアップグレードを許可しますか?」 |
target_dir | install/upgrade | 現在のディレクトリ | 書き込み可能なパス | 「プロジェクトをどこに作成または操作しますか?」 |
db_mode | install | Docker の場合は bundled、create/git の場合は existing | bundled/existing のいずれか | 「同梱データベースを使用しますか、それとも既存のデータベースに接続しますか?」 |
db_dialect | install | postgres | postgres/mysql/mariadb のいずれか | 「PostgreSQL、MySQL、MariaDB のどれを使用しますか?」 |
db_host | db_mode=existing の場合 | なし | 空でないホスト名 | 「どの DB ホストを使用しますか?」 |
db_port | db_mode=existing の場合 | 方言による(5432/3306) | 数値のポート | 「どの DB ポートを使用しますか?」 |
db_database | db_mode=existing の場合 | なし | 空でないデータベース名 | 「どの DB データベースを使用しますか?」 |
db_database_mode | db_mode=existing の場合 | existing | existing/create のいずれか | 「既存のデータベースを使用しますか、それとも先にデータベースを作成しますか?」 |
db_user | db_mode=existing の場合 | なし | 空でないユーザー名 | 「どの DB ユーザーを使用しますか?」 |
db_password | db_mode=existing の場合 | なし | 空でないパスワード | 「DB パスワードを入力してください。」 |
db_underscored | いいえ | false | ブール値(true/false) | 「ローカル DB で DB_UNDERSCORED を有効にしますか?」 |
port | いいえ | 13000 | 整数 1..65535 | 「どのアプリポートを使用しますか?」 |
network_profile | いいえ | online | online/restricted/offline のいずれか | 「このホストは外部インターネットに直接アクセスできますか?」 |
cli_env_name | いいえ | local | 空でないスラッグ | 「作成するローカルの nocobase-ctl 環境名を指定してください。」 |
cli_auth_mode | いいえ | oauth | oauth/token のいずれか | 「CLI 環境のブートストラップには、OAuth モード(デフォルト)とトークンモードのどちらを使用しますか?」 |
cli_token_env | いいえ | NOCOBASE_API_TOKEN | 有効な環境変数名 | 「トークンモードで使用する場合、API トークンを格納する環境変数を指定してください。」 |
app_env_action | task=app-manage の場合のみ | current | add/use/current/list のいずれか | 「実行するアプリ環境アクションを指定してください:add、use、current、list のいずれですか?」 |
app_env_name | 条件付き | なし | app_env_action=add/use では必須 | 「使用する環境名を指定してください。」 |
app_base_url | 条件付き | なし | app_env_action=add では必須。有効な HTTP/HTTPS URL | 「環境の追加に使用するアプリケーション URL を指定してください。」 |
app_scope | いいえ | project | project/global のいずれか | 「この環境アクションでは、プロジェクトスコープとグローバルスコープのどちらを使用しますか?」 |
app_token | 条件付き | なし | app_env_action=add で、リモート URL にトークンモードを使用する場合は必須 | 「トークンモードでリモート環境を追加するための API トークンを入力してください。」 |
| ユーザーが「お任せします」と言った場合のデフォルトの動作: |
mode=quicktask=installinstall_method=dockerrelease_channel=latest(Docker のインストールでは、ユーザーがチャネルを指定していない場合も、チャネルの確認が行われます)db_mode=bundleddb_dialect=postgresdb_database_mode=existingdb_underscored=falseport=13000network_profile=onlinecli_env_name=localcli_auth_mode=oauthcli_token_env=NOCOBASE_API_TOKEN
必須の確認ゲート
- 確認ラウンドの上限:
2 - 1 ラウンドあたりの質問数の上限:
3 - 選択した
taskに必要な入力がすべて解決するまで、変更を伴う操作(install/upgrade)を実行しないでください。 - Docker のリリースチャネル確認ゲートはインストール時に必須です。
task=installかつinstall_method=dockerで、ユーザーがrelease_channelを明示していない場合は、インストール前に短い質問を 1 つしてください。- 「Docker のデフォルトは
latestですが、現在の AI 構築機能はalphaの方が充実しています。今すぐalphaをインストールしますか?」 - 受け付ける値:
alpha/latest/beta。 - ユーザーが安定性または本番環境での使用を明示した場合は、
latestを選択してください。 - チャネル決定の根拠を
user_explicit、clarified、またはdefault_fallbackとして記録してください。 - アップグレードゲートは必須です。
- アップグレードコマンドを実行する前に、
backup_confirmedがtrueである必要があります。 - アップグレードでは、
install_methodのデフォルトはautoです。ユーザーが指定しない場合は、マーカーやプロジェクトファイルから方法を判定してください。 - ドライランではないアップグレードコマンドを実行する前に、
upgrade_confirmedがtrueである必要があります。 target_versionが現在のバージョンより低い場合は停止してください(ダウングレードはサポートされていません)。install_method=gitの場合、allow_dirty=trueでなければ、変更のあるワークツリーでは処理を停止してください。task=app-manageの場合:app_env_action=addの場合は、app_env_nameとapp_base_urlが必須です。- インストールでは DB ポリシーが必須です。
dockerのデフォルトはdb_mode=bundledです。- ユーザーが Docker の経路で DB 接続情報を指定した場合は、
db_mode=existingに切り替えてください。 create-nocobase-appとgitでは、常にdb_mode=existingと PostgreSQL/MySQL/MariaDB の準備が必要です。db_mode=existingの場合は、db_database_modeの決定が必要です。existing:既存のデータベースに直接接続し、検証します。create:データベースを先に作成してから接続し、検証します。これにより、初回接続の失敗が繰り返されるのを防ぎます。- DB ホストがローカル(
localhost、127.0.0.1、::1、host.docker.internal)の場合は、db_underscoredの希望を確認してください。ユーザーが指定しない場合のデフォルトはfalseです。 - 既存モードで DB が存在しない、または接続できない場合は停止し、公式のインストールリンクを提示してください。
- PostgreSQL:
https://www.postgresql.org/download/ - MySQL のインストール資料:
https://dev.mysql.com/doc/en/installing.html - MySQL のダウンロード:
https://dev.mysql.com/downloads/mysql - MariaDB のダウンロード:
https://mariadb.org/download/ - アプリ環境の認証モード規則は必須です。
- 追加モードのデフォルトは
oauthです(明示的な認証モードの指定がなく、トークン引数が指定されている場合を除きます)。 - oauth モードでは、依存プラグイン一式
@nocobase/plugin-api-doc+@nocobase/plugin-idp-oauthと、対話形式でのenv authが必要です。 - トークンモードのローカル URL(厳密):ホストが
localhost、127.0.0.1、::1、*.localhost、またはhost.docker.internalの場合、トークンは必須ですが、env-manageが自動取得します(プレースホルダートークンは使用しないでください)。 - トークンモードのリモート URL:トークンはユーザーが手動で指定する必要があります(
app_tokenまたはトークン環境変数)。 - インストールフローでは、必ず最後の段階で CLI 環境のブートストラップ(
node ./scripts/env-manage.mjs add ...)を実行してください。 env updateを実行する前に、認証モードに応じて CLI 依存プラグインが有効になっていることを確認してください。- oauth:
@nocobase/plugin-api-doc+@nocobase/plugin-idp-oauth - token:
@nocobase/plugin-api-doc+@nocobase/plugin-api-keys - トークンモードを使用し、CLI のブートストラップ時に
cli_token_envが設定されていない場合は、まずトークンの自動生成を試みてください。自動取得に失敗した場合にのみ、ユーザーに手動での指定を求めてください。 - 必須の入力が不足している、または曖昧な場合は停止し、短い確認質問を 1 つしてください。
- 必須のパスが無効、または書き込み不可の場合は停止し、処理を続ける前に有効で書き込み可能なパスを求めてください。
ワークフロー
- リクエストを解析し、意図を正規化します。
- 意図が不明確な場合は、
taskを選択するための短い質問を 1 つだけしてください。 - 最初のラウンドの質問は 5 つ以内にしてください。
- Docker のインストールでは、次の優先順位に従って
release_channelを決定してください。 - ユーザーが明示した入力 > Docker のチャネル確認への回答 > デフォルトのフォールバック
latest。
- インストール/アップグレードの前に、事前チェックゲートを実行します。
- インストール/アップグレードでは、基本チェックのみを実行します。
- Windows:
powershell -File scripts/preflight.ps1 -InstallMethod <install_method> -DbMode <db_mode> -DbDialect <db_dialect> -DbHost <db_host> -DbPort <db_port> -DbDatabase <db_database> -DbDatabaseMode <db_database_mode> -DbUser <db_user> -DbPassword <db_password>を実行します。 - Linux/macOS:環境変数に
DB_HOST/DB_PORT/DB_DATABASE/DB_USER/DB_PASSWORDを設定して、bash scripts/preflight.sh <port> <install_method> <db_mode> <db_dialect> <db_database_mode>を実行します。 - 検出事項を
fail、warn、passに分類します。 - 依存関係/ランタイム/パス/ネットワークに関する阻害要因は、即時の阻害要因として扱います。
- モードに応じて実行します。
quick:質問を最小限に抑えた、Docker 優先の手順です。quick+ Docker インストール:ユーザーがチャネルを指定していない場合、必須の Docker チャネル確認を行い、alphaを推奨します。standard:ユーザーがインストール方法とデータベースの方言を選択します。rescue:診断情報を収集し(Windows ではpowershell -File scripts/collect-diagnostics.ps1、Linux/macOS ではbash scripts/collect-diagnostics.sh)、検出事項をトラブルシューティング項目に対応付けてから、最小限で安全な修正を優先して適用します。- インストール実行ポリシー:
- ローカルのスクリプトとテンプレートのみを使用します。
- Docker の手順では
assets/docker-templates/を使用します。 - create-app/git の手順では
assets/install-templates/を使用します。 - 実行中に、インストールコマンドの例を探すためにウェブページを検索しないでください。
- タスク固有の手順書を実行します。
- インストールの場合:インストール手順書に従います。
- インストールコマンドの実行には、ローカルスクリプトを使用します。
- Windows:
powershell -File scripts/install.ps1 --method <install_method> --target-dir <target_dir> --release-channel <release_channel> --db-mode <db_mode> --db-dialect <db_dialect> --db-host <db_host> --db-port <db_port> --db-database <db_database> --db-database-mode <db_database_mode> --db-user <db_user> --db-password <db_password> --db-underscored <db_underscored> --project-name <project_name> - Linux/macOS:
bash scripts/install.sh --method <install_method> --target-dir <target_dir> --release-channel <release_channel> --db-mode <db_mode> --db-dialect <db_dialect> --db-host <db_host> --db-port <db_port> --db-database <db_database> --db-database-mode <db_database_mode> --db-user <db_user> --db-password <db_password> --db-underscored <db_underscored> --project-name <project_name> - アップグレードの場合:アップグレード手順書に従い、ローカルスクリプトを実行します。
- Windows:
powershell -File scripts/upgrade.ps1 --method <install_method|auto> --target-dir <target_dir> --backup-confirmed true --confirm-upgrade true --target-version <target_version> --restart-mode <restart_mode> --clean-retry <clean_retry> --allow-dirty <allow_dirty> - Linux/macOS:
bash scripts/upgrade.sh --method <install_method|auto> --target-dir <target_dir> --backup-confirmed true --confirm-upgrade true --target-version <target_version> --restart-mode <restart_mode> --clean-retry <clean_retry> --allow-dirty <allow_dirty> - 診断の場合:トラブルシューティングナレッジベースに従います。
- アプリ環境の管理(
task=app-manage)の場合:アプリ環境の管理に従います。
- インストール後のチェックゲートを実行し、CLI 環境をブートストラップします。
- サービスの利用可能性、ログイン手順、基本的なプラグイン/ランタイムの健全性、エラーログを確認します。
- インストールでは、アプリの起動とログイン準備の完了をもって、インストールのコアフローが完了します。
- CLI ランタイムを更新する前に、CLI 依存プラグインバンドルが有効になっていることを確認します。
- oauth(デフォルト):
@nocobase/plugin-api-doc+@nocobase/plugin-idp-oauth - token:
@nocobase/plugin-api-doc+@nocobase/plugin-api-keys - 推奨される有効化方法:
- oauth:
Use $nocobase-plugin-manage enable @nocobase/plugin-api-doc @nocobase/plugin-idp-oauth - token:
Use $nocobase-plugin-manage enable @nocobase/plugin-api-doc @nocobase/plugin-api-keys - プラグインの状態を変更した場合は、
node ./scripts/run-ctl.mjs -- env update ...の前にアプリを再起動します。 - インストール/アップグレードの最終段階として、必ず CLI のブートストラップを実行します。
- Windows:
powershell -File scripts/cli-postcheck.ps1 -Port <port> -EnvName <cli_env_name> -AuthMode <cli_auth_mode> -TokenEnv <cli_token_env> -Scope project -BaseDir <target_dir> - Linux/macOS:
AUTH_MODE=<cli_auth_mode> bash scripts/cli-postcheck.sh <port> <cli_env_name> <cli_token_env> project <target_dir> - CLI ブートストラップの対象コマンド:
node ./scripts/env-manage.mjs add --name <cli_env_name> --url http://localhost:<port>/api --auth-mode <cli_auth_mode> --scope project --base-dir <target_dir>- 環境の追加に成功したら、後続コマンドを実行できるようにランタイムを更新します。
node ./scripts/run-ctl.mjs -- env update -e <cli_env_name> -s project- 直ちに値を読み戻し(
node ./scripts/env-manage.mjs current --scope project --base-dir <target_dir>)、期待値と実際の値を記載します。
- 出力を報告します。
- 実行したコマンドの一覧を記載します。
- コマンド出力から成功/失敗を示す証拠を記載します。
- インストールフローでは、
release_channel_sourceの証拠(user_explicit/clarified/default_fallback)を記載します。 - すべての書き込み操作(例:
.env、compose ファイル、ランタイム設定)について、書き込み直後に読み戻して検証し、期待値と実際の値を報告します。 - CLI ブートストラップの証拠として、以下を記載します。
cli_env_namebase_urlscopeauth_modeenv_update_statustask=app-manageの場合は、アプリ環境操作の証拠として以下を記載します。app_env_actioncurrent_env_namecurrent_base_urlis_localauth_mode(追加時)token_mode(追加時)installの成功時には、初回ログイン用の認証情報を記載します。- root の認証情報が明示的にカスタマイズされていない場合は、デフォルトの
[email protected]/admin123を示し、パスワードの変更を促します。 - カスタマイズされている場合は、設定済みのログインアカウントとパスワードの参照元を示します。
- 次に行うことを明確に1つ示します。
参照資料の読み込みガイド
| 参照資料 | 使用する場面 | 備考 |
|---|---|---|
| assets/docker-templates.md | docker インストール | ローカルテンプレートの選択とリリースチャネルの対応付け |
| assets/install-templates.md | create-app/git インストール | ローカルのコマンド/環境テンプレートの対応付けとチャネルのデフォルト |
| references/preflight-checklist.md | インストール/アップグレードの前 | 依存関係、パス、ネットワーク、ポートの確認 |
| references/install-runbook.md | インストールと初回起動 | docker/create-app/git の実行ガイド |
| references/app-env-manage.md | task=app-manage | oauth/token の認証モードポリシーに基づく追加/使用/現在値/一覧の仕様 |
| references/upgrade-runbook.md | 単一インスタンスのアップグレード | 事前チェック、実行、事後チェック、ロールバックのガイダンス |
| references/troubleshooting.md | 診断と復旧 | 発生頻度の高い問題の判断表 |
安全ゲート
影響の大きい操作:
- 実行中のサービスのバージョン変更
- ランタイム環境変数の変更
- 本番環境に近いサービスの再起動
- Compose サービスの置き換えまたは削除
安全ルール:
- アップグレード操作の前に、明示的な確認を必須とします。
- アップグレードの前に、バックアップの確認を必須とします。
- ドライランではないアップグレードスクリプトの実行前に、
--confirm-upgrade trueを必須とします。 - 破壊的な削除コマンドを自動実行しないでください。
- コマンドが失敗した場合は処理を停止し、次の操作に進む前に失敗時の出力を正確に提示します。
確認テンプレート:
- 「実行内容を確認してください:
{{target}}に対して、{{install_method}}を使用して{{task}}を実行します。影響:ランタイムが再起動し、サービスを一時的に利用できなくなる可能性があります。続行する場合はconfirmと返信してください。」
検証チェックリスト
- 事前チェックが完了し、未解決のブロッキングエラーがゼロであること。
- 既存のプロジェクトファイルで
APP_KEYが弱い場合は事前チェックが失敗し、新規インストール対象については、ローカルインストールスクリプトの生成前に限り、APP_KEYが未設定でも処理を保留できること。 - Docker のインストール時にチャネルが明示されていない場合、確認を求め、
alphaを推奨すること。 - ユーザーが明示的に選択したチャネルを、再確認せずに使用すること。
- 既存の DB モードでは、必須の DB フィールドが欠落している場合、またはエンドポイントに到達できない場合に失敗すること。
- PostgreSQL/MySQL/MariaDB が利用できない場合、
create-nocobase-app/gitの事前チェックが失敗すること。 - インストール方法とリリースチャネルが明示的に確認されるか、デフォルト設定されること。
- インストールコマンドが記録され、再現可能であること。
- インストールの主要な成功判定が、アプリの起動とログイン準備完了に基づくこと。
- CLI の最終段階がインストール/アップグレード時に実行され、スキル内の環境変数ヘルパー(
node ./scripts/env-manage.mjs add ...)を使用してローカル環境を正常に作成/更新すること。 task=app-manageがnode ./scripts/env-manage.mjs ...を通じてadd/use/current/listをサポートすること。- アプリ環境変数の追加で認証モードのルールが正しく適用されること(メタデータ/認証フローを使用するデフォルトの
oauth、ローカルとリモートで異なるトークンポリシーを維持するトークンモード)。 env updateによる接続確認が成功しない限り、アプリ環境変数の追加を成功と見なさないこと。- ブートストラップ環境の CLI ランタイム更新(
node ./scripts/run-ctl.mjs -- env update ...)が成功すること。 - ランタイム更新が
swagger:get404 または API ドキュメントの無効化によって失敗した場合、スキルがプラグインの有効化手順を適用して再試行すること。 - OAuth フローでは、OAuth メタデータ/認証を検証する前に
@nocobase/plugin-idp-oauthが有効であることを確認すること。 - トークン取得フローでは、トークンを生成/提供する前に
@nocobase/plugin-api-keysが有効であることを確認すること。 - 読み戻しによって、想定される環境名/ベース URL/スコープと、現在選択されている環境が確認できること。
- アップグレード手順にバックアップの確認が含まれていること。
- アップグレード手順に、計画の読み戻し後にスクリプトレベルの確認ゲート(
--confirm-upgrade true)が含まれていること。 - 事後チェックでアプリへの到達性とログインページを確認すること。
- トラブルシューティングの出力に、根本原因の仮説と具体的な修正手順が含まれていること。
- 結果の要約に、完了項目、保留項目、次のアクション項目が含まれていること。
- 書き込み操作のすべてに、直後の読み戻しによる証拠が含まれていること。
最小テストシナリオ
- Docker が利用できるクリーンなホストにクイックインストールし、CLI のローカル環境ブートストラップが自動的に実行されます。
- Docker と Node が不足している状態での事前チェック。
APP_KEYが未設定、またはプレースホルダーのような値の場合は事前チェックが失敗し、ランダムなキーを設定した後に成功します。- 重大な問題がある場合、インストールの事前チェックで処理がブロックされます。
idp-oauthが不足している場合、CLI ブートストラップのデフォルトの oauth パスが失敗し、依存関係の自動有効化とログインの修正後に成功します。- トークンが不足している場合、CLI ブートストラップのトークンモードが失敗し、トークンの自動生成/手動設定の修正後に成功します。
- アップグレード方法が自動検出され、バックアップとアップグレード計画が確認され、事後チェックが成功します。
Environment mismatchを診断し、実行可能な手順を提示します。- ポートの競合が原因の起動失敗を診断し、修正コマンドを提示します。
- ファイルのアクセス許可拒否(
EACCES)が原因の起動失敗を診断し、具体的なアクセス許可/アクセス権の修正手順を提示します。 - Docker のインストールがオフラインモードで成功し、外部ドキュメントを参照せずにローカルの compose テンプレートを使用します。
- ユーザーが DB の入力値を指定した場合、Docker のインストールで
db_mode=existingに自動で切り替わります。 - DB が利用できない場合、create/git の事前チェックが失敗し、PostgreSQL/MySQL/MariaDB の公式インストールリンクを返します。
- DB エンドポイントの確認と認証プローブが成功した場合、create/git の事前チェックが成功します。
- oauth モードで
task=app-manageを実行すると、メタデータ/認証フローを検証し、env updateを実行します。接続が完全に成功した場合に限り、現在の環境情報を返します。 - トークンモードでリモート URL を指定し、トークンが不足している場合、
task=app-manageは明確なトークン必須エラーで失敗します。 - 明示的なチャネル指定なしで Docker をインストールする場合、確認を求め、ユーザーが選択すると
release_channel_source=clarifiedを記録します。 - Docker のインストールでチャネルが明示的に指定されている場合、ユーザーの選択を維持し、
release_channel_source=user_explicitを記録します。
出力契約
最終回答には、次の内容を含める必要があります。
- 選択したモードとタスク
- 使用した入力値(方法、チャネル、ディレクトリ、ポート)
release_channel_source(user_explicit/clarified/default_fallback)- 事前チェックの概要(
fail/warn/pass) - 実行したアクション
- 検証結果
- CLI ブートストラップの結果(
cli_env_name、base_url、scope、env_update_status) - 未解決のリスク
- 推奨される次のアクション
install タスクでは、recommended next action に次の内容を含める必要があります。
- ログイン URL
- 初回ログイン用のアカウントとパスワード
- パスワード変更のリマインダー
参考資料
-
使用ガイド:インストール、CLI の初期設定、アプリ環境の管理、アップグレード、診断のワークフローを解説するガイドです。
-
Docker テンプレート:ローカル優先の Compose テンプレートの選択方法と、リリースチャネルの対応付けです。
-
インストールテンプレート:create-app/git 用のローカルコマンドテンプレートと、チャネル対応付けのオーバーライドです。
-
事前チェックリスト:変更を伴う操作の前に使用してください。
-
インストール手順書:インストールと起動のフローで使用してください。
-
アプリ環境の管理:アプリ環境の追加/使用/現在の環境の確認/一覧表示の操作と、OAuth/トークンのポリシーで使用してください。
-
アップグレード手順書:単一インスタンスを安全にアップグレードする際に使用してください。
-
トラブルシューティング KB:頻度の高い障害への対応に使用してください。
-
NocoBase Docker インストール:Docker インストールの主要なリファレンスです。[検証済み:2026-04-08]
-
NocoBase Docker アップグレード:Docker アップグレードの制約と手順です。[検証済み:2026-04-08]
-
NocoBase create-nocobase-app インストール:create-app の初期設定手順です。[検証済み:2026-04-08]
-
NocoBase Git インストール:ソースコードからのインストール手順です。[検証済み:2026-04-08]
-
NocoBase 環境変数:実行時環境の設定リファレンスです。[検証済み:2026-04-08]
-
Docker インストールドキュメント:依存関係が不足している場合の Docker セットアップガイドです。[検証済み:2026-04-08]
-
Node.js ダウンロード:Node.js のインストールリファレンスです。[検証済み:2026-04-08]
-
Git インストール:Git のインストールリファレンスです。[検証済み:2026-04-08]
-
Yarn Classic インストール:Yarn 1.x のインストールリファレンスです。[検証済み:2026-04-08]
-
PostgreSQL ダウンロード:PostgreSQL のインストールガイドとパッケージです。[検証済み:2026-04-15]
-
MySQL インストールドキュメント:MySQL 公式のインストールドキュメントです。[検証済み:2026-04-15]
-
MySQL ダウンロード:MySQL 公式のダウンロードページです。[検証済み:2026-04-15]
-
MariaDB ダウンロード:MariaDB 公式のダウンロードページです。[検証済み:2026-04-16]