Skip to content

Latest commit

 

History

History
119 lines (80 loc) · 5.16 KB

README.zh-CN.md

File metadata and controls

119 lines (80 loc) · 5.16 KB
img

English / 中文

快速开始 / 文档教程 / 视频教程

什么是sparrow?为什么要使用sparrow?

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

GitHub release (latest by date)

1. 支持的服务列表

添加一个新的服务,请点击这里

image

2. 快速开始

下面是快速使用的简单例子,请点击使用文档查看更多详细教程。

demo.mp4

(1) 安装

使用如下命令快速完成安装。

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

# 执行安装脚本
bash _install.sh

在安装成功后,项目根目录下会自动生成一个.env配置文件,它是sparrow的唯一且统一的配置入口,可以查看它的示例文件,在这里你可以修改服务版本、容器命名空间等。

1、如果使用./sparrow xxx命令时出现语法错误,请尝试使用bash运行bash ./sparrow xxx

2、在安装过程中会提示输入DOCKERHUB_REPO,用于配置自己的sparrow镜像的远程仓库。它的默认值是docker.io/lvsid,如果以后需要修改,直接修改/.env配置文件即可

3、如需要帮助,请查看 常见问题

(2) 启动

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

./sparrow start

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

./sparrow startone {service_name}

(3) 停止

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

./sparrow stop

同样的如果只需要停止某一个服务,使用如下命令即可

./sparrow stopone {service_name}

(4) 重启

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

./sparrow restart

(5) 更新一个服务

当某个服务需要更新时,如其镜像内容需要修改,就需要对服务(镜像)进行更新,在自行修改完后,使用如下命令更新

./sparrow updateone {service_name}

3. 更多文档

4. 贡献

在使用项目的过程中,如果您有任何的问题和建议可以随时在 Issues 中提问,或者在 Pull Requests 中提交代码。关于代码贡献等,请参考 如何贡献 文档

5. 开源许可证

MIT, Copyright (c) 2013-present, Wgrape