English / 中文

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.

2. Quick start

For detailed tutorials, check the Usage Document.

demo.mp4

# Install
git clone https://github.com/WGrape/sparrow.git
cd sparrow
bash _install.sh

# Start / Stop / Restart all services
./sparrow start
./sparrow stop
./sparrow restart

# Operate a single service
./sparrow startone {service_name}
./sparrow stopone {service_name}

# Start web dashboard
./sparrow web

# Enter container
./sparrow enter
./sparrow enter {service_name}

For full usage details (configuration, update, monitor, Q&A, etc.), see the Usage Document.

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.

5. License

MIT, Copyright (c) 2013-present, Wgrape