Sparrow

<div align="center" > <img width="350" alt="img" src="https://github.com/WGrape/sparrow/assets/35942268/ab3ef3f3-8625-41df-99ed-50edde47a68e"> </div> <div align="center"> <p><a href="https://github.com/WGrape/sparrow">English</a> / <a href="./README.zh-CN.md">中文</a></p> <p><a href="#2-quick-start">Quick Start</a> / <a href="#3-more-documents">Documents</a> / <a href="https://www.ixigua.com/7350725273806963219">Videos</a></p> <p><a href="https://github.com/WGrape/sparrow/blob/main/.work/extra/doc/1.WHY_SPARROW_EN.md">What is sparrow and why should we use sparrow?</a></p> <p>A Docker tool for one-click startup of multiple services.</p> </div> <p align="center"> <a href="https://www.oscs1024.com/project/oscs/WGrape/sparrow?ref=badge_small" alt="OSCS Status"><img src="https://www.oscs1024.com/platform/badge/WGrape/sparrow.svg?size=small"/></a> <img src="https://img.shields.io/badge/dockerdesktop-4.10.0+-red.svg"> <img src="https://img.shields.io/badge/docker-18.01+-red.svg"> <img src="https://img.shields.io/badge/dockercompose-1.20.0+-red.svg"> <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/wgrape/sparrow"> <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg"></a> <a href="./README.zh-CN.md"><img src="https://img.shields.io/badge/doc-中文-green.svg"></a> </p>

1. Support services

Add a new service, please click here.

<!-- <img width="882" alt="image" src="https://github.com/WGrape/sparrow/assets/35942268/5bf35edb-7b5f-4407-86e8-f1fcc1815e03"> --> <!-- <img width="882" alt="image" src="https://github.com/WGrape/sparrow/assets/35942268/0294fc18-2714-466f-898a-61dac573c479"> --> <img width="880" alt="image" src="https://github.com/WGrape/sparrow/assets/35942268/52d3a44c-5b89-4847-996e-ebef00a4a107">

2. Quick start

Here is a quick usage example. You can check Usage Document for detailed tutorials.

<video src="https://github.com/WGrape/sparrow/assets/35942268/bc180f06-fedc-42d2-b21b-f7c7fa1b65ea" width="" height="" controls="controls"></video>

(1) Installation

You can use the following commands to install.

# 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 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, if you need to modify it later, you can directly edit the .env file.

3、If you need help, check the Q&A Document 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.

./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.

./sparrow startone {service_name}

(3) Stop

Stop all services in the entire environment

./sparrow stop

The same, if you only need to stop a specific service, you can use the following command.

./sparrow stopone {service_name}

(4) Restart

Restart all services in the entire environment

./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.

./sparrow updateone {service_name}

3. More documents

• 1.Project Background ：English / 中文
• 2.Usage Document ：English / 中文
• 3.Development Document ：English / 中文
• 4.How to contribute ：English / 中文
• 5.Q&A Document ：English / 中文

4. Contributions

During the use of the project, if you have any questions or suggestions, please submit issues or pull requests any time. About Contribution，please check How to Contribute document.

<img src="https://contrib.rocks/image?repo=wgrape/ngxway">

5. License

MIT, Copyright (c) 2013-present, Wgrape