Skip to content

Quick Start

Compose Generator offers several different methods to use it and it depends on your context and intention, what we can recommend you to do.

Setup Compose Generator

I want to use it for development

Compose Generator makes developing and especially testing much more seamless. Get started by choosing of the following options:

I have Docker already installed

Perfect! One thing less to care about ... Let's continue by installing Compose Generator:

Use it as Docker Container without installing

Please refer to the guide on how to use Compose Generator with Docker.

Install it on your development machine (recommended)

If you use Windows on your development machine, please refer to the guide on how to install Compose Generator on Windows and if you work with Linux, you can visit the guide on how to install Compose Generator on Linux.

Install it on your development machine via NPM

If you have already installed NPM on your development machine, you can install Compose Generator via NPM. The only thing NPM does, is to unpack the binary for your platform and architecture to the binaries directory of your system. Compose Generator will post-install predefined service templates and other essential files.

I haven't got Docker yet

No problem. Some commands of Compose Generator can even by used without having Docker installed, although it is recommended to have Docker installed.

Install it on your development machine

If you use Windows on your development machine, please refer to the guide on how to install Compose Generator on Windows and if you work with Linux, you can visit the guide on how to install Compose Generator on Linux.

Install it on your development machine via NPM

If you have already installed NPM on your development machine, you can install Compose Generator via NPM. The only thing NPM does, is to unpack the binary for your platform and architecture to the binaries directory of your system. Compose Generator will post-install predefined service templates and other essential files.

As Docker is required for most of the task, Compose Generator covers, you should have Docker installed before using it. Compose Generator offers a simple command to install both - Docker and Docker Compose - at once.

I want to use it in production

Compose Generator can also be used to generate production ready Docker Compose configurations. To use it in a production environment we have two options: One-time use or more frequent usage.

Use it as Docker Container without installing (recommended for one-time use)

Please refer to the guide on how to use Compose Generator with Docker.

Install it on your development machine (recommended when using more frequently)

Installing Compose Generator with the native package manager is recommended due to the enhanced ability to udate to newer versions and to integrate in potentially existing devops workflows.

If you use Windows on your development machine, please refer to the guide on how to install Compose Generator on Windows and if you work with Linux, you can visit the guide on how to insatll Compose Generator on Linux.

Generate your first Docker Compose Configuration

I want to start from scratch

To be extended ...

I already have project(s) to deploy by building images on the host system

To be extended ...

I already have project(s) to deploy by pulling remote images

To be extended ...