2.USAGE_ZH.md

使用教程

一、介绍

如果访问慢，可以查看Gitee镜像仓库。

sparrow是基于Docker一键启动多个服务环境的容器化编排工具。

二、环境依赖

本项目完全依赖于Docker环境，所以一定要先安装并启动Docker。

三、安装和更新

此项目提供了开发版本和Release版本两种不同的安装方式，二者的区别如下，请根据需求的不同自行选择。

• 开发版本 ：项目以高频率的速度更新，所以功能和特性一定是最新的！但是无法避免的会出现些bug，不能保证100%稳定
• Release版本 ：项目在某个时间下发布的一个经过多级测试，且稳定运行一段时间后的版本，在这里查看各个Release版本

1、开发版本

(1) 安装

如果是首次安装，使用如下命令快速完成安装。

# 获取项目
git clone https://github.com/WGrape/sparrow.git
cd sparrow

# 执行安装脚本
bash _install.sh

# 查看使用帮助
./sparrow --help

(2) 更新

在安装后，如果需要更新至最新的开发版本，执行以下命令开始更新。

bash _update.sh

2、Release版本

(1) 安装

如果需要特定版本的Release包，请点击这里下载，然后执行以下操作

cd sparrow

# 执行安装脚本
bash _install.sh

# 查看使用帮助
./sparrow --help

(2) 更新

需要注意的是，Release包不支持更新 ！所以在安装完特定版本的Release包后，请不要执行bash _update.sh命令。

四、快速使用

1、启动

使用如下命令启动整个环境中的所有服务。当然这个所有服务是可定义的，它由根目录下/.env文件中配置的ENABLE_SERVICE_LIST数组变量控制。

./sparrow start

(1) 启动某一个服务

如果只需要启动某一个服务，使用如下命令即可，传递的service就是在docker-compose.yml配置文件中的services列表中某一个服务的名称，如phpfpm/nginx/mysql/redis等

./sparrow startone {service_name}

(2) 测试是否启动成功

使用如下命令，会自动在Chrome中打开对应的网页，如果每一个网页都可以成功打开，则说明安装成功

bash .work/test/run.sh

2、停止

停止整个环境中的所有服务

./sparrow stop

3、重启

重启整个环境中的所有服务

./sparrow restart

4、更新

当镜像内容需要修改以支持新的需求时，就需要对服务进行更新，其实就是对镜像进行更新

(1) 更新一个服务

./sparrow updateone {service}

(2) 使用示例

当我们需要把Go版本调整为1.17.0（默认为1.21.1）时，使用如下步骤完成

1. 先修改官方镜像 ：把/.env文件中的IMAGE_OFFICIAL_GO_VERSION=1.21.1修改为IMAGE_OFFICIAL_GO_VERSION=1.17.0
2. 再修改basic镜像 ：把/.env文件中的IMAGE_BASIC_GO_VERSION=1.21.1修改为IMAGE_BASIC_GO_VERSION=1.17.0
3. 最后更新go服务 ：执行./sparrow updateone go

更多使用讲解，请参考How to update a service文档

5、监控

如果需要查看sparrow的运行状态和所运行服务的容器信息，使用如下命令即可

./sparrow status