nb config

Verwaltet die Standard-Konfigurationswerte der CLI. Die aktuell unterstützten Schlüssel lassen sich grob in diese Gruppen einteilen:

  • CLI selbst: locale, update.policy, license.pkg-url
  • Docker-Runtime: docker.network, docker.container-prefix
  • Externe ausführbare Dateien: bin.docker, bin.caddy, bin.git, bin.nginx, bin.pnpm, bin.yarn
  • Proxy-Erzeugung: proxy.nb-cli-root, proxy.upstream-host, proxy.nginx-driver, proxy.caddy-driver

Die meisten Projekte brauchen nur wenige dieser Schlüssel. In der Praxis werden am häufigsten diese verwendet:

  • update.policy
  • docker.network
  • docker.container-prefix
  • bin.nginx oder bin.caddy
  • proxy.nginx-driver oder proxy.caddy-driver

Häufige Konfigurationsschlüssel

SchlüsselStandardwertBeschreibung
localewird nach den aktuellen CLI-Regeln aufgelöstÜberschreibt die von der CLI verwendete Sprache
update.policypromptUpdate-Richtlinie beim Start: prompt, auto oder off
license.pkg-urlhttps://pkg.nocobase.com/Überschreibt die Download-URL für kommerzielle Erweiterungspakete
docker.networknocobaseStandardnetzwerk für CLI-verwaltete Docker-Anwendungen
docker.container-prefixnbStandardpräfix für CLI-verwaltete Docker-Container
bin.dockerdockerÜberschreibt den Pfad zur Docker-Binärdatei
bin.caddycaddyÜberschreibt den Pfad zur Caddy-Binärdatei
bin.gitgitÜberschreibt den Pfad zur Git-Binärdatei
bin.nginxnginxÜberschreibt den Pfad zur Nginx-Binärdatei
bin.pnpmpnpmÜberschreibt den Pfad zur pnpm-Binärdatei
bin.yarnyarnÜberschreibt den Pfad zur Yarn-Binärdatei
proxy.nb-cli-rootCLI-Root, normalerweise das Home-Verzeichnis des aktuellen BenutzersOrdnet den .nocobase-Pfad auf den Root-Pfad ab, den der Proxy-Prozess tatsächlich sieht
proxy.upstream-host127.0.0.1Überschreibt die Host-Adresse, die der Proxy für die Rückleitung zur NocoBase-Anwendung verwendet
proxy.nginx-driverlocalStandard-Driver für nb proxy nginx
proxy.caddy-driverlocalStandard-Driver für nb proxy caddy

Verwendung

nb config <command>

Unterbefehle

BefehlBeschreibung
nb config getEffektiven Wert eines Konfigurationsschlüssels lesen
nb config setEinen Konfigurationsschlüssel setzen
nb config deleteEinen explizit gesetzten Konfigurationsschlüssel löschen
nb config listDerzeit explizit gesetzte Konfigurationsschlüssel auflisten

Beispiele

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 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

Hinweise

  • bin.nginx und bin.caddy wirken sich nur auf den local-Driver von nb proxy nginx und nb proxy caddy aus
  • bin.pnpm wird verwendet, wenn Befehle pnpm direkt ausführen müssen, etwa beim Aktualisieren einer von pnpm verwalteten globalen CLI-Installation mit nb self update
  • proxy.nginx-driver und proxy.caddy-driver speichern den Standard-Driver des jeweiligen Providers
  • proxy.nb-cli-root und proxy.upstream-host sind erweiterte Proxy-Overrides. Für die meisten CLI-verwalteten local- oder docker-Envs reichen die Standardwerte aus
  • Wenn du nur den aktiven Proxy-Driver umschalten möchtest, ist nb proxy nginx use oder nb proxy caddy use in der Regel klarer als das manuelle Setzen des Konfigurationsschlüssels

Verwandte Befehle