Skip to content

Debian 11 (bullseye) installation instructions

How to manually install the orchestrator-core and orchestrator-core-gui on Debian 11 (Bullseye) is described in the following steps.

Step 1 - Install dependencies

First make sure the debian install is up to date. Then install the following software dependencies:

  • PostgreSQL (version >=11)
  • Git
  • virtualenvwrapper
  • Node.js (version 14)
sudo apt update
sudo apt upgrade --yes
curl -sL | sudo bash -
sudo apt-get install --yes postgresql git virtualenvwrapper nodejs

Step 2 - Database setup

In step 1 the database server is already started as part of the apt installation procedure. If the database server was previously installed and stopped then start it again. Create the database with the following commands, use nwa as password:

sudo -u postgres createuser -sP nwa
sudo -u postgres createdb orchestrator-core -O nwa

For debug purposes, interact directly with the database by starting the PostgresSQL interactive terminal:

sudo -u postgres psql orchestrator-core

Step 3 - Install orchestrator

The minimal version of Python is 3.11. Before the orchestrator core and all its dependencies are installed, a Python virtual environment is created:

mkdir example-orchestrator
cd example-orchestrator
source /usr/share/virtualenvwrapper/
mkvirtualenv --python python3.11 example-orchestrator

Make sure that the just created Python virtual environment is active before installing the orchestrator-core:

pip install orchestrator-core

A next time in a new shell, be sure to activate the Python virtual environment again:

source /usr/share/virtualenvwrapper/
workon example-orchestrator

Step 4 - Init orchestrator:

Create a file with the following content:

from orchestrator import OrchestratorCore
from orchestrator.cli.main import app as core_cli
from orchestrator.settings import AppSettings

app = OrchestratorCore(base_settings=AppSettings())

if __name__ == "__main__":

Commit the just created to git:

git init --initial-branch main
git config --local ""
git config --local "Your Name"
git add
git commit -m "Initial commit"

Note that your local git must contain at least one commit because otherwise the db init below will fail.

Initialize the database and run all the database migrations:

PYTHONPATH=. python db init
PYTHONPATH=. python db upgrade heads

Step 5 - Install orchestrator client

Install the orchestrator client in the parent directory of the example-orchestrator:

cd ..
git clone

Install the Yarn package manager and use it to install the orchestrator client dependencies:

cd orchestrator-core-gui/
sudo npm install --global yarn
sudo npm install --global --save-dev npm-run-all
yarn install

Step 6 - Init orchestrator client:

Use the supplied environment variable defaults:

cp .env.local.example .env.local

And make the following changes to .env.local:

# change the existing REACT_APP_BACKEND_URL variable value into:
# and add the following:

The custom-example folder contains some SURF specific modules that can be used as an example. It must be linked to the folder custom in order for the app to start:

(cd src && ln -s custom-example custom)