Installation and start-up

Thank you for choosing Orchesty for your project. The installation is simple, we can handle it in few steps.

What do we need?

To start and run Orchesty, we must have the Docker installed to ensure a virtualized environment. If you don't have any experience with Docker, we recommend going through its documentation.

Next, we'll need an executable binary make file. To install this binary, follow the instructions below:

Linux

Execute following command in terminal

apt install make

MacOS

Install homebrew with command through Terminal.

brew install make

Then create a virtual network interface.

sudo ifconfig lo0 alias 127.0.0.10 up

Skeleton download & Project initialization

The basis for the installation is Orchesty-skeleton, which is public on GitHub.

Installer

Run our Installer and follow the wizzard:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Orchesty/Installer/main/InstallScript.sh)"

Or if we want our tutorial codes:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Orchesty/Installer/main/InstallScript.sh)" -s tutorial

ZIP

Download and extract whole skeleton from:

https://github.com/Orchesty/orchesty-skeleton/archive/refs/heads/master.zip

Or if we want our tutorial codes:

https://github.com/Orchesty/orchesty-tutorial/archive/refs/heads/master.zip

Startup and login into Orchesty Admin

Using make init-dev command we start and download the Docker image, which sets up the database and starts all important services.

Orchesty Admin represents the user interface for design and control of processes, it's management, and related configurations. For more detailed information, we recommend visiting The introduction of Orchesty Admin.

Once installed, admin will be available at http://127.0.0.10. Create a new user before first logging in.

docker-compose exec backend bin/orchesty u:c

Now we can log into the UI. If you're starting with Orchesty, we recommend going through our tutorials.