Skip to main content
Version: 8.10 (unreleased)

Developer quickstart – Camunda 8 Run

note

Camunda 8 Run provides a lightweight, self-managed environment for local development and prototyping. It is not intended for production use.

For production deployments, install the Orchestration Cluster manually as a Java application. For detailed steps, see the manual installation guide.

Camunda 8 Run is a local distribution of Camunda 8 that bundles the Camunda 8 runtime, core services, startup scripts, and a launcher application for Windows, macOS, and Linux.

Camunda 8 Run enables you to run the Orchestration Cluster with minimal configuration. It is intended for developers who want to model BPMN diagrams, deploy them, and interact with running process instances in a simple environment.

Camunda 8 Run includes the following:

Camunda 8 Run also supports document storage and management with document handling.

note

For the latest list of supported relational databases and versions, see the RDBMS version support policy.

Pages in this section​

Step through the Camunda 8 Run guide via the following topics:

Common tasks​

If you are looking for a specific task from the previous single-page guide, use the links below.

Install and start Camunda 8 Run​

For prerequisites, local startup, and shutdown steps, see install and start Camunda 8 Run. For container-based local deployment, see the developer quickstart with Docker Compose.

Configuration options​

For CLI flags, startup overrides, TLS flags, and --config usage, see configure Camunda 8 Run.

Enable authentication and authorization​

For application.yaml examples that protect the API and enable authorization checks, see enable authentication and authorization.

Use Camunda APIs​

For local API endpoints, authentication expectations, and links to the canonical API docs, see use Camunda APIs.

Use built-in and custom connectors​

For local connector usage, custom connector placement, and connector secrets guidance, see use built-in and custom connectors.

Configure or switch secondary storage (H2 or Elasticsearch)​

For H2, external relational databases, Elasticsearch, and migration notes, see configure secondary storage in Camunda 8 Run.

Default: H2 (Camunda 8 Run)​

For the default H2 configuration and limitations, see default H2 in Camunda 8 Run.

External relational database options​

For PostgreSQL, MariaDB, MySQL, Oracle, and Microsoft SQL Server examples, see external relational database options.

Shut down Camunda 8 Run​

For local shutdown commands, see shut down Camunda 8 Run.

Next steps​