nb config

Gère les valeurs de configuration par défaut de la CLI. Les clés actuellement prises en charge se regroupent principalement ainsi :

  • La CLI elle-même : locale, update.policy, license.pkg-url
  • Runtime Docker : docker.network, docker.container-prefix
  • Images officielles NocoBase : nb-image-registry, nb-image-variant
  • Exécutables externes : bin.docker, bin.caddy, bin.git, bin.nginx, bin.pnpm, bin.yarn
  • Génération de proxy : proxy.nb-cli-root, proxy.upstream-host, proxy.nginx-driver, proxy.caddy-driver

La plupart des projets n'ont besoin que de quelques-unes de ces clés. En pratique, les plus courantes sont :

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

Clés de configuration courantes

CléValeur par défautDescription
localerésolue selon les règles actuelles de la CLIRemplace la langue utilisée par la CLI
update.policypromptPolitique de mise à jour au démarrage : prompt, auto ou off
license.pkg-urlhttps://pkg.nocobase.com/Remplace l'URL de téléchargement des paquets d'extensions commerciales
docker.networknocobaseRéseau par défaut pour les applications Docker gérées par la CLI
docker.container-prefixnbPréfixe par défaut pour les conteneurs Docker gérés par la CLI
nb-image-registrydockerhubFamille de registry par défaut pour les images officielles NocoBase : dockerhub ou aliyun
nb-image-variantfullVariante de tag par défaut pour les images d'app officielles NocoBase : standard, no-nginx, full ou full-no-nginx
bin.dockerdockerRemplace le chemin de l'exécutable Docker
bin.caddycaddyRemplace le chemin de l'exécutable Caddy
bin.gitgitRemplace le chemin de l'exécutable Git
bin.nginxnginxRemplace le chemin de l'exécutable Nginx
bin.pnpmpnpmRemplace le chemin de l'exécutable pnpm
bin.yarnyarnRemplace le chemin de l'exécutable Yarn
proxy.nb-cli-rootracine de la CLI, généralement le répertoire personnel de l'utilisateur courantRemplace la racine visible par la configuration proxy générée lorsque le processus proxy et la CLI ne voient pas la même racine du système de fichiers
proxy.upstream-host127.0.0.1Remplace l'hôte utilisé par le proxy pour renvoyer le trafic vers l'application NocoBase
proxy.nginx-driverlocalDriver de runtime par défaut utilisé par nb proxy nginx
proxy.caddy-driverlocalDriver de runtime par défaut utilisé par nb proxy caddy

Utilisation

nb config <command>

Sous-commandes

CommandeDescription
nb config getLire la valeur effective d'une clé de configuration
nb config setDéfinir une clé de configuration
nb config deleteSupprimer une clé de configuration explicitement définie
nb config listLister les clés de configuration explicitement définies actuellement

Exemples

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

Notes

  • bin.nginx et bin.caddy n'affectent que le driver local de nb proxy nginx et nb proxy caddy
  • bin.pnpm est utilisé lorsque des commandes doivent exécuter pnpm directement, par exemple pour mettre à jour une installation globale de la CLI gérée par pnpm avec nb self update
  • nb-image-registry n'affecte que les valeurs par défaut des images officielles NocoBase utilisées par la CLI. dockerhub utilise l'image d'app nocobase/nocobase, tandis que aliyun utilise registry.cn-shanghai.aliyuncs.com/nocobase/nocobase
  • nb-image-variant n'affecte que les tags des images d'app officielles NocoBase. Avec la version 1.7.14, la CLI résout standard en 1.7.14, no-nginx en 1.7.14-no-nginx, full en 1.7.14-full et full-no-nginx en 1.7.14-full-no-nginx
  • Lorsque nb-image-registry=aliyun, la CLI bascule aussi les images de base de données intégrée par défaut vers les mirrors officiels Aliyun pour PostgreSQL, MySQL, MariaDB et Kingbase
  • proxy.nginx-driver et proxy.caddy-driver stockent le driver par défaut utilisé par chaque provider
  • proxy.nb-cli-root et proxy.upstream-host sont des surcharges proxy avancées. Pour la plupart des environnements local ou docker gérés par la CLI, les valeurs par défaut suffisent
  • Si tu veux simplement changer le driver proxy actif, nb proxy nginx use ou nb proxy caddy use est généralement plus clair que de modifier la clé de configuration manuellement

Commandes associées