Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wgrape/sparrow
强烈推荐🔥🔥🔥 🦜麻雀虽小五脏俱全🦜 🏄🏻♂️ 享受环境一切顺利的快乐🏄🏻♂️ 🌍所有环境统一规范管理🌍📦超强环境打包管理器📦🔨 一键快速启动多个服务环境的容器化编排工具 🔨 / A Docker tool for one-click startup of multiple services.
https://github.com/wgrape/sparrow
deployment development docker docker-compose docker-container docker-image dockerfile dockerhub etcd golang jupyter kafka mysql nginx php postgres prometheus python redis zookeeper
Last synced: 6 days ago
JSON representation
强烈推荐🔥🔥🔥 🦜麻雀虽小五脏俱全🦜 🏄🏻♂️ 享受环境一切顺利的快乐🏄🏻♂️ 🌍所有环境统一规范管理🌍📦超强环境打包管理器📦🔨 一键快速启动多个服务环境的容器化编排工具 🔨 / A Docker tool for one-click startup of multiple services.
- Host: GitHub
- URL: https://github.com/wgrape/sparrow
- Owner: WGrape
- License: mit
- Created: 2023-06-29T02:07:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-21T09:25:27.000Z (4 months ago)
- Last Synced: 2024-10-22T15:59:28.921Z (14 days ago)
- Topics: deployment, development, docker, docker-compose, docker-container, docker-image, dockerfile, dockerhub, etcd, golang, jupyter, kafka, mysql, nginx, php, postgres, prometheus, python, redis, zookeeper
- Language: Shell
- Homepage:
- Size: 313 KB
- Stars: 97
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Quick Start / Documents / Videos
What is sparrow and why should we use sparrow?
A Docker tool for one-click startup of multiple services.
## 1. Support services
Add a new service, please [click here](https://github.com/WGrape/sparrow/issues/4).
## 2. Quick start
> Here is a quick usage example. You can check [Usage Document](.work/extra/doc/2.USAGE_EN.md) for detailed tutorials.
### (1) Installation
You can use the following commands to install.
```bash
# get project
git clone https://github.com/WGrape/sparrow.git
cd sparrow
# install
bash _install.sh
```
After successful installation, a ```.env``` file will be automatically generated in the project's root directory, it's the config entry for Sparrow, you can modify service versions, container namespace, and more. Refer to the [.env.template](./.env.template) file.
> 1、If you encounter some syntax errors while using the ```./sparrow xxx``` command, please try to run with bash ```bash ./sparrow xxx``` command.
>
> 2、When install, you will be prompted to enter ```DOCKERHUB_REPO```, which is used to configure the remote repository for your Sparrow images. It's default value is [docker.io/lvsid](https://hub.docker.com/repositories/lvsid), if you need to modify it later, you can directly edit the ```.env``` file.
>
> 3、If you need help, check the [Q&A Document](.work/extra/doc/5.QA_EN.md) for more help.
### (2) Start
Use the following command to start all services in the entire environment. Of course, this ```all services``` can be defined and is controlled by the ```ENABLE_SERVICE_LIST``` array variable configured in the ```/.env``` file in the root directory.
```bash
./sparrow start
```
If you only need to start a specific service, you can use the following command. The ```service``` passed in is the name of a service in the ```services``` list in the ```docker-compose.yml``` configuration file, such as ```phpfpm/nginx/mysql/redis```, etc.
```bash
./sparrow startone {service_name}
```
### (3) Stop
Stop all services in the entire environment
```bash
./sparrow stop
```
The same, if you only need to stop a specific service, you can use the following command.
```bash
./sparrow stopone {service_name}
```
### (4) Restart
Restart all services in the entire environment
```bash
./sparrow restart
```
### (5) Update a Service
When a service needs to be updated, such as when its image content needs to be modified, the service (image) needs to be updated after making the modifications. After modifying it manually, use the following command to update it.
```bash
./sparrow updateone {service_name}
```
## 3. More documents
- 1.Project Background ：[English](.work/extra/doc/1.WHY_SPARROW_EN.md) / [中文](.work/extra/doc/1.WHY_SPARROW_ZH.md)
- 2.Usage Document ：[English](.work/extra/doc/2.USAGE_EN.md) / [中文](.work/extra/doc/2.USAGE_ZH.md)
- 3.Development Document ：[English](.work/extra/doc/3.DEVELOPMENT_EN.md) / [中文](.work/extra/doc/3.DEVELOPMENT_ZH.md)
- 4.How to contribute ：[English](.work/extra/doc/4.HOW_TO_CONTRIBUTE_EN.md) / [中文](.work/extra/doc/4.HOW_TO_CONTRIBUTE_ZH.md)
- 5.Q&A Document ：[English](.work/extra/doc/5.QA_EN.md) / [中文](.work/extra/doc/5.QA_ZH.md)
## 4. Contributions
During the use of the project, if you have any questions or suggestions, please submit [issues](https://github.com/WGrape/ngxway/issues/new) or [pull requests](https://github.com/WGrape/ngxway/pulls) any time. About Contribution，please check [How to Contribute](./.work/extra/doc/4.HOW_TO_CONTRIBUTE_EN.md) document.
## 5. License
[MIT](https://opensource.org/licenses/MIT), Copyright (c) 2013-present, [Wgrape](https://github.com/WGrape/)