nb config

Управляет значениями конфигурации CLI по умолчанию. Поддерживаемые сейчас ключи в основном делятся на такие группы:

  • Сама CLI: locale, update.policy, license.pkg-url
  • Docker runtime: docker.network, docker.container-prefix
  • Внешние исполняемые файлы: bin.docker, bin.caddy, bin.git, bin.nginx, bin.pnpm, bin.yarn
  • Генерация proxy: proxy.nb-cli-root, proxy.upstream-host, proxy.nginx-driver, proxy.caddy-driver

Большинству проектов нужна только часть этих ключей. На практике чаще всего используются:

  • update.policy
  • docker.network
  • docker.container-prefix
  • 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.networknocobaseСеть по умолчанию для Docker-приложений, управляемых CLI
docker.container-prefixnbПрефикс по умолчанию для Docker-контейнеров, управляемых CLI
bin.dockerdockerПереопределяет путь к исполняемому файлу Docker
bin.caddycaddyПереопределяет путь к исполняемому файлу Caddy
bin.gitgitПереопределяет путь к исполняемому файлу Git
bin.nginxnginxПереопределяет путь к исполняемому файлу Nginx
bin.pnpmpnpmПереопределяет путь к исполняемому файлу pnpm
bin.yarnyarnПереопределяет путь к исполняемому файлу Yarn
proxy.nb-cli-rootкорень CLI, обычно домашний каталог текущего пользователяПереопределяет корневой путь, который видит сгенерированная proxy-конфигурация, когда proxy-процесс и CLI не видят один и тот же корень файловой системы
proxy.upstream-host127.0.0.1Переопределяет хост, который proxy использует для пересылки трафика обратно в приложение NocoBase
proxy.nginx-driverlocalДрайвер runtime по умолчанию для nb proxy nginx
proxy.caddy-driverlocalДрайвер runtime по умолчанию для nb 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 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.nginx и bin.caddy влияют только на драйвер local для nb proxy nginx и nb proxy caddy
  • bin.pnpm используется, когда командам нужно запускать pnpm напрямую, например при обновлении глобальной установки CLI, управляемой pnpm, через nb self update
  • proxy.nginx-driver и proxy.caddy-driver хранят драйвер по умолчанию для каждого provider
  • proxy.nb-cli-root и proxy.upstream-host — это расширенные proxy-override-настройки. Для большинства CLI-managed env типов local и docker достаточно значений по умолчанию
  • Если вам нужно только переключить активный proxy-драйвер, обычно понятнее использовать nb proxy nginx use или nb proxy caddy use, чем вручную менять ключ конфигурации

Связанные команды