{"id":15567582,"url":"https://github.com/wgrape/sparrow","last_synced_at":"2025-06-30T19:03:38.020Z","repository":{"id":220265916,"uuid":"659985741","full_name":"WGrape/sparrow","owner":"WGrape","description":"强烈推荐🔥🔥🔥 🦜麻雀虽小五脏俱全🦜  🏄🏻‍♂️ 享受环境一切顺利的快乐🏄🏻‍♂️ 🌍所有环境统一规范管理🌍📦超强环境打包管理器📦🔨 一键快速启动多个服务环境的容器化编排工具 🔨 / A Docker tool for one-click startup of multiple services.","archived":false,"fork":false,"pushed_at":"2024-07-21T09:25:27.000Z","size":320,"stargazers_count":101,"open_issues_count":2,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-30T19:02:17.314Z","etag":null,"topics":["deployment","development","docker","docker-compose","docker-container","docker-image","dockerfile","dockerhub","etcd","golang","jupyter","kafka","mysql","nginx","php","postgres","prometheus","python","redis","zookeeper"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WGrape.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-29T02:07:06.000Z","updated_at":"2025-04-08T21:11:26.000Z","dependencies_parsed_at":"2024-07-21T09:33:33.666Z","dependency_job_id":"381def32-3fe2-40e9-93dd-6a6e23d81435","html_url":"https://github.com/WGrape/sparrow","commit_stats":{"total_commits":128,"total_committers":2,"mean_commits":64.0,"dds":0.0546875,"last_synced_commit":"4d273e1aef0b160050df9138578c7078198b2c79"},"previous_names":["wgrape/sparrow"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/WGrape/sparrow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fsparrow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fsparrow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fsparrow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fsparrow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WGrape","download_url":"https://codeload.github.com/WGrape/sparrow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WGrape%2Fsparrow/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262834665,"owners_count":23371847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deployment","development","docker","docker-compose","docker-container","docker-image","dockerfile","dockerhub","etcd","golang","jupyter","kafka","mysql","nginx","php","postgres","prometheus","python","redis","zookeeper"],"created_at":"2024-10-02T17:11:53.269Z","updated_at":"2025-06-30T19:03:37.986Z","avatar_url":"https://github.com/WGrape.png","language":"Shell","readme":"\u003cdiv align=\"center\" \u003e\n    \u003cimg width=\"350\" alt=\"img\" src=\"https://github.com/WGrape/sparrow/assets/35942268/ab3ef3f3-8625-41df-99ed-50edde47a68e\"\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003cp\u003e\u003ca href=\"https://github.com/WGrape/sparrow\"\u003eEnglish\u003c/a\u003e / \u003ca href=\"./README.zh-CN.md\"\u003e中文\u003c/a\u003e\u003c/p\u003e\n    \u003cp\u003e\u003ca href=\"#2-quick-start\"\u003eQuick Start\u003c/a\u003e / \u003ca href=\"#3-more-documents\"\u003eDocuments\u003c/a\u003e / \u003ca href=\"https://www.ixigua.com/7350725273806963219\"\u003eVideos\u003c/a\u003e\u003c/p\u003e\n    \u003cp\u003e\u003ca href=\"https://github.com/WGrape/sparrow/blob/main/.work/extra/doc/1.WHY_SPARROW_EN.md\"\u003eWhat is sparrow and why should we use sparrow?\u003c/a\u003e\u003c/p\u003e\n    \u003cp\u003eA Docker tool for one-click startup of multiple services.\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.oscs1024.com/project/oscs/WGrape/sparrow?ref=badge_small\" alt=\"OSCS Status\"\u003e\u003cimg src=\"https://www.oscs1024.com/platform/badge/WGrape/sparrow.svg?size=small\"/\u003e\u003c/a\u003e\n    \u003cimg src=\"https://img.shields.io/badge/dockerdesktop-4.10.0+-red.svg\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/docker-18.01+-red.svg\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/dockercompose-1.20.0+-red.svg\"\u003e\n    \u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/wgrape/sparrow\"\u003e\n    \u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-green.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"./README.zh-CN.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/doc-中文-green.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## 1. Support services\n\nAdd a new service, please [click  here](https://github.com/WGrape/sparrow/issues/4).\n\n\u003c!-- \u003cimg width=\"882\" alt=\"image\" src=\"https://github.com/WGrape/sparrow/assets/35942268/5bf35edb-7b5f-4407-86e8-f1fcc1815e03\"\u003e --\u003e\n\n\u003c!-- \u003cimg width=\"882\" alt=\"image\" src=\"https://github.com/WGrape/sparrow/assets/35942268/0294fc18-2714-466f-898a-61dac573c479\"\u003e --\u003e\n\n\u003cimg width=\"880\" alt=\"image\" src=\"https://github.com/WGrape/sparrow/assets/35942268/52d3a44c-5b89-4847-996e-ebef00a4a107\"\u003e\n\n## 2. Quick start\n\n\u003e Here is a quick usage example. You can check [Usage Document](.work/extra/doc/2.USAGE_EN.md) for detailed tutorials.\n\n\u003cvideo src=\"https://github.com/WGrape/sparrow/assets/35942268/bc180f06-fedc-42d2-b21b-f7c7fa1b65ea\" width=\"\" height=\"\" controls=\"controls\"\u003e\u003c/video\u003e\n\n### (1) Installation\n\nYou can use the following commands to install.\n\n```bash\n# get project\ngit clone https://github.com/WGrape/sparrow.git\ncd sparrow\n\n# install\nbash _install.sh\n```\n\nAfter 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. \n\n\u003e 1、If you encounter some syntax errors while using the ```./sparrow xxx``` command, please try to run with bash ```bash ./sparrow xxx``` command. \n\u003e\n\u003e 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.\n\u003e\n\u003e 3、If you need help, check the [Q\u0026A Document](.work/extra/doc/5.QA_EN.md) for more help. \n\n### (2) Start\n\nUse 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.\n\n```bash\n./sparrow start\n```\n\nIf 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.\n\n```bash\n./sparrow startone {service_name}\n```\n\n### (3) Stop\n\nStop all services in the entire environment\n\n```bash\n./sparrow stop\n```\n\nThe same, if you only need to stop a specific service, you can use the following command.\n\n```bash\n./sparrow stopone {service_name}\n```\n\n### (4) Restart\n\nRestart all services in the entire environment\n\n```bash\n./sparrow restart\n```\n\n### (5) Update a Service\n\nWhen 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.\n\n```bash\n./sparrow updateone {service_name}\n```\n\n## 3. More documents\n\n- 1.Project Background ：[English](.work/extra/doc/1.WHY_SPARROW_EN.md) / [中文](.work/extra/doc/1.WHY_SPARROW_ZH.md)\n- 2.Usage Document ：[English](.work/extra/doc/2.USAGE_EN.md) / [中文](.work/extra/doc/2.USAGE_ZH.md)\n- 3.Development Document ：[English](.work/extra/doc/3.DEVELOPMENT_EN.md) / [中文](.work/extra/doc/3.DEVELOPMENT_ZH.md)\n- 4.How to contribute ：[English](.work/extra/doc/4.HOW_TO_CONTRIBUTE_EN.md) / [中文](.work/extra/doc/4.HOW_TO_CONTRIBUTE_ZH.md)\n- 5.Q\u0026A Document ：[English](.work/extra/doc/5.QA_EN.md) / [中文](.work/extra/doc/5.QA_ZH.md)\n\n## 4. Contributions\nDuring 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.\n\n\u003cimg src=\"https://contrib.rocks/image?repo=wgrape/ngxway\"\u003e\n\n## 5. License\n\n[MIT](https://opensource.org/licenses/MIT), Copyright (c) 2013-present, [Wgrape](https://github.com/WGrape/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwgrape%2Fsparrow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwgrape%2Fsparrow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwgrape%2Fsparrow/lists"}