Back to Nocobase

nb config

docs/docs/cn/api/cli/config/index.md

2.1.102.5 KB
Original Source

nb config

管理 CLI 默认配置。当前支持的配置项大致分成这几类:

  • CLI 自身:localeupdate.policylicense.pkg-url
  • Docker 运行:docker.networkdocker.container-prefix
  • 外部可执行文件:bin.dockerbin.caddybin.gitbin.nginxbin.yarn
  • 代理生成:proxy.nb-cli-rootproxy.upstream-hostproxy.nginx-driverproxy.caddy-driver

常用配置项

配置项默认值说明
locale按 CLI 当前规则解析覆盖 CLI 使用的语言
update.policyprompt启动时更新策略:promptautooff
license.pkg-urlhttps://pkg.nocobase.com/覆盖商业扩展包下载地址
docker.networknocobaseCLI 管理的 Docker 应用默认网络
docker.container-prefixnbCLI 管理的 Docker 容器默认前缀
bin.dockerdocker覆盖 Docker 可执行文件路径
bin.caddycaddy覆盖 Caddy 可执行文件路径
bin.gitgit覆盖 Git 可执行文件路径
bin.nginxnginx覆盖 Nginx 可执行文件路径
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 默认使用的运行方式

用法

bash
nb config <command>

子命令

命令说明
nb config get读取某个配置项的生效值
nb config set设置某个配置项
nb config delete删除某个显式配置项
nb config list列出当前显式设置过的配置项

示例

bash
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 delete docker.container-prefix

相关命令