跳到主要内容

Buddy CLI

了解如何使用Buddy CLI,本文介绍CLI命令和可用的配置选项。

当您在安装Buddy自托管部署时,会自带安装命令行界面(CLI),使用它来管理和配置您的安装。

信息

所有命令都必须由root用户执行,在Debian、Ubuntu或macOS上使用sudo运行。

基本命令

  • buddy start – 启动应用
  • buddy stop – 停止应用
  • buddy restart – 重启应用
  • buddy configure – 配置应用
  • buddy feedback – 发送反馈给Buddy客服
  • buddy version – 显示CLI与自托管部署系统版本
  • buddy terms – 显示Buddy自托管部署软件许可协议

高级命令

buddy [--yes] [--full] backup – 创建应用程序备份。 使用--yes标志无需用户交互即可创建备份并删除旧备份。 使用 --full 标志在备份中包含缓存。
buddy [--yes] restore – 从备份中恢复应用程序。 使用--yes标志使系统用最新备份。
buddy clear-cache – 清除Docker缓存(docker prune)、文件系统和DinD磁盘内容。
buddy status – 显示应用程序及其组件状态
buddy diagnose – 在安装上运行诊断,显示解决发现问题的提示
buddy [--yes] update – 显示应用程序或CLI的新版本是否可用并提供安装说明。 使用--yes标志自动下载和应用可用更新。
buddy [--yes] uninstall – 卸载本地部署安装
buddy set – 通过CLI配置集成,运行命令以获取您可以配置内容的完整列表。
buddy fix-mysql – 修复MySQL问题,仅在提示时使用。
buddy install-worker – 安装工作器,工作器可减轻多个流水线并行运行的负载,可从官网查看详细内容。
提示

点击此处了解有关备份和恢复Buddy自托管部署的更多信息

提示

点击此处了解有关Buddy自托管部署工作器的更多信息

CLI配置选项

当您运行 buddy configure 时,CLI会显示下面列出的选项。要配置选项,请键入相应数字并按回车键进一步操作。

  1. 退出配置
  2. 定制域名 - 允许设置用于通过浏览器访问Buddy自托管部署的自定义域名
  3. 自定义域名SSL证书 - 允许为自定义域名设置有效的SSL证书
  4. 应用数据路径 - 允许将应用程序数据移动到不同的分区或磁盘
  5. IP & 端口 – 可设置:
    • 公网IP - 用于通过浏览器访问实例
    • 服务器IP - 应用绑定的IP;默认情况下,所有应用程序接口都绑定到该地址
    • HTTPS端口(默认443)
    • HTTP端口(默认80)
    • Git SSH端口(默认22)
  6. 重置工作区所有者密码 - 重置密码并提供电子邮件地址和一次性令牌以在重置后登录。
  7. 流水线并发执行限制 - 允许限制同时运行的流水线数量
  8. 流水线并行操作限制 - 允许限制在单个流水线中同时运行的操作数量
  9. 短信服务 - 允许将Amazon AWS发送的短信消息配置为通知
  10. 存储仓最大文件尺寸 - 允许设置使用Buddy内建Git时可以推送到存储仓文件的最大尺寸。
  11. HAProxy ciphers - 允许更改HAProxy密码以自定义连接客户端的安全策略。
  12. 应用内存管理 - 允许调整每个应用程序组件使用的内存量
  13. API请求限制 - 允许调整访问资源的速率限制,默认情况下,用户每15分钟可以向资源发出1000个请求。
  14. Telemetry – 允许启用/停用Telemetry
  15. 界面语言 - 可自由切换您的Buddy自托管部署系统语言界面(例如:中文界面/英文界面)
  16. 工作器令牌 - 生成令牌以供工作器使用

buddy set 命令参数列表

提示

运行 buddy set {集成名称} 以了解有关配置所选集成的更多信息。

参数描述
azureAzure集成
aws-roleAWS职能设置凭据
bitbucketBitbucket集成
cert自定义域名SSL证书
datapath应用数据路径
digitaloceanDigitalOcean集成
dockerhubDocker Hub集成
domain自定义域名
githubGitHub OAuth集成
githubappGitHub应用集成
githubenterpriseGitHub企业版集成
gitlabGitLab集成
gitlabenterpriseGitLab企业版集成
googleGoogle集成
haproxyHAProxy ciphers
herokuHeroku集成
ipsandports应用IP地址与端口
language应用语言
ldapLDAP集成
leLet's Encrypt 自定义域名SSL证书
license应用许可证
limits应用构建资源限制
netlifyNetlify集成
pinpointAWS Pinpoint集成(SMS)
pushbulletPushbullet集成
secret应用密钥
session应用会话密钥
shopifyShopify集成
slackSlack集成
smtp发送电子邮件
snsAWS SNS集成(SMS)
telegramTelegram集成
telemetry启用/停用 telemetry数据

limits参数选项列表

--repomaxsize value 存储库中文件的最大大小。默认值:0(无限制)
--executions value 一次同时运行的最大流水线数量。默认值:0(无限制)
--actions value 一次并行运行的最大操作数量。0(无限制)
--apiLimit value 每个用户每小时的最大API请求数量。0(无限制)
--reset 将所有选项的值重置为默认值。

如若遇到疑问,请联系技术支持:support@buddy.red