Get/Install Orkes Conductor
Use Conductor Playground
Playground is the easiest way to get started on Orkes Conductor.
Using Playground requires authorization keys which you can generate quickly by following the steps below:
- Login to https://play.orkes.io/ - you can bookmark this URL for easy access.
- Navigate to Applications from the left menu.
- Click Create Application button to create a new application and provide a name.
- Open the newly created application and enable Worker, Metadata API, and Application API permissions.
- Click Create Access Key to create the KEY and SECRET. A dialog box opens with the newly generated Key and Secret.
Important: Copy and store the Key and Secret in a safe location, as it is never displayed again.
Setup environment variables
export KEY=<Your KEY>
export SECRET=<Your SECRET>
You can generate another pair for your testing if you lose access to your key/secret pair.
Install and Run Locally
Docker should be installed.
Run the following command on the Unix, Linux or Mac OSX to download the container and start.
curl https://raw.githubusercontent.com/orkes-io/orkes-conductor-community/main/scripts/run_local.sh | sh
Alternatively, you can also run the container command explicitly:
docker run --init -p 8080:8080 -p 1234:5000 --mount source=redis,target=/redis \
--mount source=postgres,target=/pgdata orkesio/orkes-conductor-community-standalone:latest
Note the target folders for Redis and Postgres data. You can empty these if you want to reset your local installation.
Setup environment variables
Install & Run Orkes Enterprise Edition Locally
Orkes publishes containers to DockerHub under orkesio organization.
Orkes Cloud Build for Local Development and Testing
Available to the users of Orkes Cloud, with all the Orkes cloud features on your local machine. Requires subscription to Orkes Cloud.
Orkes publishes orkes-conductor-standalone docker container that can be used for local development and testing.
The container is self-contained with the full Orkes development stack that contains a persistent store, Orkes server, and system workers.
The standalone container is only meant for local development and is not suitable for running any production workload.
orkes-conductor-standalone is available to the Orkes Customers and needs an authorization token to download the container.
Obtaining Authorization Token
Please reach out to your Orkes contact to obtain the token.
Download and Run the Container
Log in to the Docker Hub using Orkes Access Account. When prompted for the password, use the access token provided by the Orkes team.
- If you do not have an access token (or have lost it), please contact email@example.com to issue a new one.
- Standard security measures should be used within the organization when storing and distributing the access token.
Download and Run the Latest Container Build
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
Access Conductor UI
Navigate to http://localhost:3000.
Access Swagger API Documentation