• 简体中文

      • 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/覆盖商业扩展包下载地址
      docker.networknocobaseCLI 管理的 Docker 应用默认网络
      docker.container-prefixnbCLI 管理的 Docker 容器默认前缀
      nb-image-registrydockerhub官方 NocoBase 镜像默认使用的仓库体系：dockerhub 或 aliyun
      nb-image-variantfull官方 NocoBase 应用镜像默认使用的标签变体：standard、no-nginx、full 或 full-no-nginx
      bin.dockerdocker覆盖 Docker 可执行文件路径
      bin.caddycaddy覆盖 Caddy 可执行文件路径
      bin.gitgit覆盖 Git 可执行文件路径
      bin.nginxnginx覆盖 Nginx 可执行文件路径
      bin.pnpmpnpm覆盖 pnpm 可执行文件路径
      bin.yarnyarn覆盖 Yarn 可执行文件路径
      proxy.nb-cli-rootCLI root（通常是当前用户 Home 目录）把 .nocobase 路径映射到代理进程实际看到的根目录
      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.pnpm 会在命令需要直接运行 pnpm 时使用，比如 nb self update 更新由 pnpm 管理的全局 CLI 安装
      • nb-image-registry 只影响 CLI 为官方 NocoBase 镜像推导出来的默认值。dockerhub 对应应用镜像仓库 nocobase/nocobase，aliyun 对应 registry.cn-shanghai.aliyuncs.com/nocobase/nocobase
      • nb-image-variant 只影响官方 NocoBase 应用镜像的 tag。以版本 1.7.14 为例，standard 对应 1.7.14，no-nginx 对应 1.7.14-no-nginx，full 对应 1.7.14-full，full-no-nginx 对应 1.7.14-full-no-nginx
      • 当 nb-image-registry=aliyun 时，CLI 也会把内置 PostgreSQL、MySQL、MariaDB 和 Kingbase 的默认数据库镜像切到阿里云官方镜像地址

      相关命令