Getting Started

Welcome! This page will guide you through all that is necessary to set up Orchestrator.

Before we get started...

You need a bit of technical knowledge to execute this tutorial. Check out the Necessary Knowledge page to ensure you have the required knowledge.

You need the following to run Orchestrator:

Git (or the Github CLI)
Docker
Docker Compose (typically comes with Docker installs)

To ensure you have all requirements, run the following commands in a terminal window:

git version
docker --version
docker compose version

Depending on the version of the various softwares, the response will vary. As long as no responses say anything along the lines of 'not found', you should be fine.

Tutorial

Get the source code

Start by opening a new terminal window, going to a desired folder, and running the following:

git clone https://github.com/invopen/orchestrator.git

This will download the latest source code from Github. You'll then want to open that folder in your terminal with:

cd orchestrator

Modify configuration

Check out the Config Builder for a more interactive way to create a config.

When you have a config, simply bring it to the root of the code and name the file deploy.yml.

Start the container

Simply run:

docker compose up