启动服务前，需进行一些必要配置，详见下方 配置文件必要配置 和 证书文件

如果环境未安装 docker，请参考文档搭建 Docker 完成安装

此外还需参考文档 安装 Docker 并配置镜像加速源, 使用 Docker 镜像源加速镜像下载

cnbcool/orange-runner: https://hub.docker.com/r/cnbcool/orange-runner

启动方式：

docker run \
  -d \
  --rm \
  --network host \
  --privileged \
  --name orange-runner \
  -v /data/orange-ci:/data/orange-ci:rshared \
  -v /etc/orange-ci:/etc/orange-ci:rw \
  -v /etc/docker:/etc/docker:ro \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /data/orange-runner/logs:/data/orange-runner/logs \
  -v $(which docker):/usr/bin/docker \
  -v /usr/libexec/docker/cli-plugins:/usr/libexec/docker/cli-plugins \
  -v /sys/fs/cgroup:/sys/fs/cgroup \
  cnbcool/orange-runner:latest

下载地址：https://cnb.cool/cnb/cool/orange-runner-doc/-/releases

1. 安装和启动服务

# 从 release 附件下载指定版本安装包
wget https://cnb.cool/cnb/cool/orange-runner-doc/-/releases/download/v1.0.1/orange-runner-1.0.1-linux-amd64.tar.gz
# 解压安装包，得到 orange-runner 可执行文件
tar -xvzf orange-runner-1.0.1-linux-amd64.tar.gz
# 将 orange-runner 复制到 /usr/local/bin
cp orange-runner /usr/local/bin
# 安装 service
orange-runner install
# 启动服务
orange-runner start

2. 重启服务

# 重启服务
orange-runner restart

3. 升级服务

# 停止服务
orange-runner stop
# 从 release 附件下载安装包
wget https://cnb.cool/cnb/cool/orange-runner-doc/-/releases/download/v1.0.1/orange-runner-1.0.1-linux-amd64.tar.gz
# 解压安装包，得到 orange-runner 可执行文件
tar -xvzf orange-runner-1.0.1-linux-amd64.tar.gz
# 将 orange-runner 复制到 /usr/local/bin
cp orange-runner /usr/local/bin
# 启动服务
orange-runner start

4. 停止并卸载服务

# 停止服务
orange-runner stop
# 卸载 service
orange-runner uninstall
# 删除全局命令
rm /usr/local/bin/orange-runner

5. 查看服务状态和日志

# 查询 service 运行状态
orange-runner status
# 查看日志
tail -f /data/orange-runner/logs/app.log

# 从 release 附件下载指定版本安装包
wget https://cnb.cool/cnb/cool/orange-runner-doc/-/releases/download/v1.0.1/orange-runner-1.0.1-darwin-amd64.tar.gz
# 解压安装包，得到 orange-runner 可执行文件
tar -xvzf orange-runner-1.0.1-darwin-amd64.tar.gz
# 将 orange-runner 复制到 /usr/local
cp orange-runner /usr/local
# 安装 service
orange-runner install
# 启动服务
orange-runner start

重启、卸载、升级、查看日志、停止服务等操作与 linux 类似

其中配置文件相关目录需额外准备：https://docs.cnb.cool/zh/paas/system-runner.html#pei-zhi-Mac-gou-jian-ji

下载并解压安装包，下载路径：https://cnb.cool/cnb/cool/orange-runner-doc/-/releases

假如安装包所在目录为 C:\orange-runner\orange-runner.exe

1. 安装并启动服务

以管理员身份打开 powershell。

# cd 到 orange-runner.exe 所在目录
cd C:\orange-runner
# 安装服务
.\orange-runner.exe install
# 启动服务
.\orange-runner.exe start

2. 重启服务

# cd 到 orange-runner.exe 所在目录
cd C:\orange-runner
# 重启服务
.\orange-runner.exe restart

3. 升级服务

# cd 到 orange-runner.exe 所在目录
cd C:\orange-runner
# 停止服务
.\orange-runner.exe stop
# 从 release 附件下载安装包，解压安装包，得到 orange-runner.exe 可执行文件，覆盖旧的 exe 文件
# 启动服务
.\orange-runner.exe start

4. 停止并卸载服务

# cd 到 orange-runner.exe 所在目录
cd C:\orange-runner
# 停止服务
.\orange-runner.exe stop
# 卸载 service
.\orange-runner.exe uninstall
# 删除 exe 文件
Remove-Item -Path .\orange-runner.exe

5. 查看服务状态和日志

# cd 到 orange-runner.exe 所在目录
cd C:\orange-runner
# 查询 service 运行状态
.\orange-runner.exe status
# 查看日志
Get-Content 'C:\data\orange-runner\logs\app.log' -Wait -Tail 10

• windows: C:\etc\orange-ci\runner-config.json
• mac: /etc/orange-ci/runner-config.json
• linux: /etc/orange-ci/runner-config.json

windows/mac 如不需要支持 rsync 和 docker，需要增加如下配置

{
  "disableRsync": true,
  "useDocker": false
}

如果不需要启用 TLS 认证（注意仅测试用时可增加如下配置）：

{
  "disableTls": true
}

1、证书所在目录：

• windows: C:\etc\orange-ci
• mac: /etc/orange-ci
• linux: /etc/orange-ci

2、证书文件：

• /etc/orange-ci/orange-runner.key
• /etc/orange-ci/orange-runner.crt
• /etc/orange-ci/orange-ca.pem

3、配置客户端证书的主题（Subject）和签发者（Issuer）通用名称，默认为：

• MASTER_CERT_CN: master.orange-ci.org
• CA_CERT_CN: orange-ci.org

可通过环境变量（MASTER_CERT_CN、CA_CERT_CN）修改默认值