README
Compose Generator
Easy to use cli to generate Docker Compose YAML configuration files.
Documentation
Please visit the documentation on compose-generator.com.
Usage
You can use the Compose Generator CLI by directly installing it on your Docker host system or by generating your compose file with the Compose Generator Docker container.
Install Compose Generator CLI
Install on Debian / Ubuntu / Raspbian
Install
$ sudo apt-get update
$ sudo apt-get install apt-transport-https ca-certificates curl \
gnupg-agent software-properties-common lsb-release
$ curl -fsSL https://repo.chillibits.com/artifactory/debian/gpg | \
sudo apt-key add -
$ sudo add-apt-repository "deb https://repo.chillibits.com/artifactory/debian \
$(lsb_release -cs) main"
$ sudo sudo apt-get update
$ sudo apt-get install compose-generator
Use
$ compose-generator
Install on Fedora
Install
$ sudo dnf -y install dnf-plugins-core
$ sudo dnf config-manager --add-repo \
https://repo.chillibits.com/artifactory/rpm/chillibits.repo
$ sudo dnf install compose-generator
Use
$ compose-generator
Install on CentOS
Install
$ sudo yum install -y yum-utils
$ sudo yum-config-manager --add-repo \
https://repo.chillibits.com/artifactory/rpm/chillibits.repo
$ sudo yum install compose-generator
Use
$ compose-generator
Install on Alpine
Install
$ apk update
$ sh -c "echo 'https://repo.chillibits.com/artifactory/alpine/$(cat \
/etc/os-release | grep VERSION_ID | cut -d "=" -f2 | cut -d "." \
-f1,2)/main'" >> /etc/apk/repositories
$ wget -O /etc/apk/keys/alpine.rsa.pub \
https://repo.chillibits.com/artifactory/alpine/alpine.rsa.pub
$ apk add compose-generator
If there occure any errors on the last step, please try the following instead
$ apk add compose-generator --allow-untrusted
Use
$ compose-generator
Windows
Install
Compose Generator gets distributed for Windows via the new Windows package manager called winget. In the future, winget will be available for download in the Microsoft Store. Currently, the easiest way to install winget is, to download it manually from GitHub. Visit the installation instruction from Microsoft.
As soon as the Windows package manager is installed on your Windows machine, you can open powershell and execute this installation command:
$ winget install ChilliBits.ComposeGenerator
After installing Compose Generator, you should restart your powershell instance to make it reload the available commands.
Use
$ compose-generator
QuickStart with Docker
Note for Windows users: This command does not work with Windows CMD command line. Please use Windows PowerShell instead.
$ docker run --rm -it -v ${pwd}:/cg/out chillibits/compose-generator
Supported host systems & file downloads
There are also downloadable packages available for all supported platforms:
| Platform | x86_64 / amd64 | i386 | armv5 | armv6 | armv7 | arm64 |
|---|---|---|---|---|---|---|
| Darwin / MacOS (tar.gz) | download | - | - | - | - | - |
| FreeBSD (tag.gz) | download | download | download | download | download | download |
| Alpine (apk) | download | download | download | download | download | download |
| CentOS (rpm) | download | download | download | download | download | download |
| Debian (deb) | download | download | download | download | download | download |
| Fedora (rpm) | download | download | download | download | download | download |
| Raspbian (deb) | download | download | - | download | download | download |
| Ubuntu (deb) | download | download | download | download | download | download |
| Windows Installer (exe) | download | download | - | - | - | - |
| Windows Portable (zip) | download | download | - | - | - | - |
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 one. Fork the repository, create the template and open a pr. 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.
© Marc Auberer 2021