Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/compose-generator/compose-generator
🐳 Easy to use cli tool to generate Docker Compose configurations
https://github.com/compose-generator/compose-generator
cli docker docker-compose generator go golang yaml
Last synced: 6 days ago
JSON representation
🐳 Easy to use cli tool to generate Docker Compose configurations
- Host: GitHub
- URL: https://github.com/compose-generator/compose-generator
- Owner: compose-generator
- License: apache-2.0
- Created: 2021-01-19T23:59:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T02:14:13.000Z (21 days ago)
- Last Synced: 2024-11-01T09:33:28.741Z (12 days ago)
- Topics: cli, docker, docker-compose, generator, go, golang, yaml
- Language: Go
- Homepage: https://compose-generator.com
- Size: 18.7 MB
- Stars: 202
- Watchers: 4
- Forks: 23
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Compose Generator
Easy to use cli tool to generate Docker Compose configurations blazingly fast.
---
**Please visit the documentation on [compose-generator.com](https://www.compose-generator.com).**
If Compose Generator helps you, please consider a GitHub star! ⭐
### Install Compose Generator
To install Compose Generator on your system, please visit the [installation section](https://www.compose-generator.com/install/linux/) in the documentation. Compose Generator is available for the latest versions of Alpine, CentOS, Debian, Fedora, Raspbian, Ubuntu and Windows. If you want to install Compose Generator manually by downloading a package file, please take a look at the table below.
After installing, you can use Compose Generator in the terminal like this:
```sh
$ compose-generator []
```
## QuickStart with Docker
**For Linux:**
```sh
$ docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):/cg/out chillibits/compose-generator []
```
**For Windows:**
```sh
$ docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -v ${pwd}:/cg/out chillibits/compose-generator []
```
*Note: This command does not work with Windows CMD command line. Please use Windows Terminal or PowerShell instead.*
## Supported host systems & file downloads
There are downloadable packages available for all supported platforms:
| **Platform** | **amd64** | **i386** | **armv5** | **armv6** | **armv7** | **arm64** |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| **Darwin / MacOS (tar.gz)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_darwin_amd64.tar.gz) | - | - | - | - | - |
| **Alpine (apk)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_amd64.apk) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_386.apk) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv5.apk) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv6.apk) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv7.apk) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_arm64.apk) |
| **CentOS (rpm)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_amd64.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_386.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv5.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv6.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv7.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_arm64.rpm) |
| **Debian (deb)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_amd64.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_386.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv5.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv6.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv7.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_arm64.deb) |
| **Fedora (rpm)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_amd64.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_386.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv5.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv6.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv7.rpm) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_arm64.rpm) |
| **Raspbian (deb)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_amd64.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_386.deb) | - | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv6.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv7.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_arm64.deb) |
| **Ubuntu (deb)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_amd64.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_386.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv5.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv6.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_armv7.deb) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_arm64.deb) |
| **Windows Installer (msi)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_x64_setup.msi) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_x86_setup.msi) | - | - | - | - |
| **Windows Portable (zip)** | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_windows_amd64.zip) | [download](https://github.com/compose-generator/compose-generator/releases/latest/download/compose-generator_windows_386.zip) | - | - | - | - |
## Contribute by providing predefined templates
If you miss a predefined template and you want to create one for the public, please read the [instructions to create a template](./predefined-services/README.md). Fork the repository, create the template and open a pr against the `release/v1.10.x` branch.
The community is thankful for every predefined template!
## Contribute otherwise to the project
If you want to contribute to this project, please ensure you comply with the [contribution guidelines](CONTRIBUTING.md).
© Marc Auberer 2021-2022