nb config

CLI のデフォルト設定値を管理します。現在サポートされているキーは主に次のように分類されます。

  • CLI 自体: locale, update.policy, license.pkg-url
  • Docker ランタイム: docker.network, docker.container-prefix
  • NocoBase 公式イメージ: nb-image-registry, nb-image-variant
  • 外部実行ファイル: bin.docker, bin.caddy, bin.git, bin.nginx, bin.pnpm, bin.yarn
  • プロキシ生成: proxy.nb-cli-root, proxy.upstream-host, proxy.nginx-driver, proxy.caddy-driver

ほとんどのプロジェクトで必要になるのは、その一部だけです。実際によく使うのは次のキーです。

  • update.policy
  • docker.network
  • docker.container-prefix
  • nb-image-registry
  • nb-image-variant
  • bin.nginx または bin.caddy
  • proxy.nginx-driver または proxy.caddy-driver

よく使う設定キー

キーデフォルト説明
locale現在の CLI ルールに従って解決CLI が使用する言語を上書きします
update.policyprompt起動時の更新ポリシー: prompt, auto, off
license.pkg-urlhttps://pkg.nocobase.com/商用拡張パッケージのダウンロード URL を上書きします
docker.networknocobaseCLI 管理の Docker アプリで使用するデフォルトネットワーク
docker.container-prefixnbCLI 管理の Docker コンテナで使用するデフォルトプレフィックス
nb-image-registrydockerhubNocoBase 公式イメージで使用するデフォルトの registry 系統: dockerhub または aliyun
nb-image-variantfullNocoBase 公式アプリイメージで使用するデフォルトの tag バリアント: standard, no-nginx, full, full-no-nginx
bin.dockerdockerDocker 実行ファイルのパスを上書きします
bin.caddycaddyCaddy 実行ファイルのパスを上書きします
bin.gitgitGit 実行ファイルのパスを上書きします
bin.nginxnginxNginx 実行ファイルのパスを上書きします
bin.pnpmpnpmpnpm 実行ファイルのパスを上書きします
bin.yarnyarnYarn 実行ファイルのパスを上書きします
proxy.nb-cli-rootCLI ルート。通常は現在のユーザーのホームディレクトリプロキシプロセスと CLI が同じファイルシステムルートを見ていない場合に、生成されるプロキシ設定から見えるルートパスを上書きします
proxy.upstream-host127.0.0.1プロキシが NocoBase アプリへトラフィックを転送する際に使うホストを上書きします
proxy.nginx-driverlocalnb proxy nginx が使用するデフォルトランタイムドライバ
proxy.caddy-driverlocalnb proxy caddy が使用するデフォルトランタイムドライバ

使い方

nb config <command>

サブコマンド

コマンド説明
nb config get設定キーの実効値を読み取ります
nb config set設定キーを設定します
nb config delete明示的に設定された設定キーを削除します
nb config list現在明示的に設定されている設定キーを一覧表示します

nb config list
nb config get update.policy
nb config set update.policy auto
nb config get proxy.nb-cli-root
nb config set proxy.nb-cli-root /workspace
nb config set proxy.upstream-host host.docker.internal
nb config set proxy.nginx-driver docker
nb config set proxy.caddy-driver local
nb config get docker.network
nb config set docker.network nocobase
nb config get nb-image-registry
nb config set nb-image-registry aliyun
nb config set nb-image-variant full-no-nginx
nb config set bin.nginx /usr/sbin/nginx
nb config set bin.git /usr/bin/git
nb config set bin.pnpm /usr/local/bin/pnpm
nb config delete docker.container-prefix

注意

  • bin.nginxbin.caddy は、nb proxy nginx および nb proxy caddylocal ドライバにのみ影響します
  • bin.pnpm は、pnpm を直接実行する必要があるコマンドで使われます。たとえば pnpm 管理のグローバル CLI インストールを nb self update で更新する場合です
  • nb-image-registry は、CLI が使用する NocoBase 公式イメージのデフォルト値にのみ影響します。dockerhub はアプリイメージ nocobase/nocobase を使い、aliyunregistry.cn-shanghai.aliyuncs.com/nocobase/nocobase を使います
  • nb-image-variant は、NocoBase 公式アプリイメージの tag にのみ影響します。バージョン 1.7.14 の場合、CLI は standard1.7.14no-nginx1.7.14-no-nginxfull1.7.14-fullfull-no-nginx1.7.14-full-no-nginx に解決します
  • nb-image-registry=aliyun の場合、CLI は内蔵データベースのデフォルトイメージも PostgreSQL、MySQL、MariaDB、Kingbase の Aliyun 公式ミラーに切り替えます
  • proxy.nginx-driverproxy.caddy-driver は、それぞれの provider が使用するデフォルトドライバを保存します
  • proxy.nb-cli-rootproxy.upstream-host は高度なプロキシ上書き設定です。ほとんどの CLI 管理 local / docker env ではデフォルト値のままで十分です
  • アクティブなプロキシドライバを切り替えたいだけなら、設定キーを直接書き換えるより nb proxy nginx usenb proxy caddy use を使う方が通常は分かりやすいです

関連コマンド