Skip to main content

Setting Up Orkes Conductor

You can set up Orkes Conductor using one of the following options:

  • Developer Playground–Launch a browser-based sandbox for quick prototyping and testing.
  • Local Setup using Docker–Run a full Conductor stack locally using Docker containers.

Developer Playground

For quick testing, use the Orkes Developer Playground. This free sandbox environment lets you start building and running workflows instantly—no installation required.

Orkes Conductor—Local Setup​

Orkes Cloud is the fully managed enterprise version of Orkes Conductor. You can deploy dedicated Conductor clusters on your preferred cloud provider.

For local development and testing, Orkes provides Docker containers via the orkesio organization on DockerHub. These containers include all Orkes Conductor features and require an Orkes Cloud subscription.

note

The orkes-conductor-standalone container is ideal for local development and testing. It includes the full Orkes stack, with a persistent store, server, and system workers. To download it, you'll need an authorization token from the Orkes team.

To set up Conductor clusters locally:

Pre-requisites:

To download and run the container:

  1. Log in to DockerHub using your Orkes access credentials. When prompted for a password, use the access token provided by Orkes.
  2. Download and run the latest container build​​:
export orkes_access_key=<ACCESS_KEY_PROVIDED_BY_ORKES>
echo $orkes_access_key | docker login --username orkesdocker --password-stdin

# Create volumes for persistent stores
docker volume create postgres
docker volume create redis

# Download and start the container
docker run -i -p 8080:8080 -p 3000:5000 --mount source=redis,target=/redis \
--mount source=postgres,target=/pgdata orkesio/orkes-conductor-standalone:latest

The UI can be accessed at http://localhost:3000 and API docs at http://localhost:8080/swagger-ui/.