Skip to main content

Configure

Choose a Docker Compose configuration​

We provide the following Docker Compose configurations:

ComponentDescription
docker-compose.ymlDefault lightweight development configuration.
docker-compose-full.ymlFull development configuration.
docker-compose-try.ymlDefault try configuration.
docker-compose-try-full.ymlFull try configuration.

To start a specific configuration, run one of the following commands:

  • Default lightweight development configuration:
docker compose up -d
  • Full development configuration:
docker compose -f docker-compose-full.yaml up -d

To stop all containers and remove associated data, run one of the following commands:

  • Default lightweight development configuration:
docker compose down -v
  • Full development configuration:
docker compose -f docker-compose-full.yaml down -v

Serendipity components​

ComponentURLDescription
PWAhttps://serendipity.localhostManage Accounts and Contacts. Access the PWA with hey@rob-ferguson.me / secret.
Identity Servicehttps://serendipity-identity-service.localhost/adminManage users, applications, roles, and groups. Access the Identity Service with temp-admin / secret.

External dependencies​

ComponentURLDescription
pgadminhttps://serendipity.localhost/pgadminpgAdmin is a free, open-source graphical management tool for PostgreSQL databases.

Camunda components​

Access components​

Once the containers are running, you can access the components in your browser.

Use the following default credentials for the web interfaces:

  • Username: demo
  • Password: demo

Orchestration cluster​

The Orchestration cluster provides process automation capabilities.

ComponentURLDescription
Operatehttp://localhost:8080/operateMonitor and troubleshoot process instances.
Tasklisthttp://localhost:8080/tasklistComplete user tasks in running process instances.
Orchestration Cluster Adminhttp://localhost:8080/adminManage users and permissions in the lightweight configuration.
Orchestration Cluster REST APIhttp://localhost:8080/v2REST API for process automation.
Swagger UIhttp://localhost:8080/swaggerSwagger UI.

Management and modelling components​

The following components are available in the full configuration only:

ComponentURLDescription
Consolehttp://localhost:8087Manage clusters and component configurations.
Optimizehttp://localhost:8083Analyze and improve process performance.
Management Identityhttp://localhost:8084Manage users for Console, Optimize, and Web Modeler.
Web Modelerhttp://localhost:8070Model BPMN processes, DMN decisions, and forms.

External dependencies​

ComponentURLDescription
Elasticsearchhttp://localhost:9200Used by the Orchestration cluster for secondary storage, and by Optimize in the full configuration.
Keycloakhttp://localhost:18080/auth/OIDC provider for Management Identity. Access Keycloak with admin / admin.
PostgreSQLhttp://localhost:5432Database for Management Identity and Web Modeler.

Authentication​

  • Web UI: Log in to Operate, Tasklist, Console, Optimize, and Web Modeler with demo / demo.
  • APIs: Authentication for the Orchestration Cluster REST API has been disabled (i.e., set to 'unprotected API mode' in the Orchestration cluster's application.yaml).

Importing a ZIP File into the Web Modeler​

There are two ways to load a packaged process application (.zip file) into the Web Modeler:

Option 1: Import via URL

This method lets you import directly from a publicly hosted .zip file.

Host your .zip file at a publicly accessible URL (e.g., on GitHub). Form the import URL like this:

<Web Modeler host>/import/resources?source=<raw zip file URL>

For example:

http://localhost:8070/import/resources?source=https://raw.githubusercontent.com/Robinyo/serendipity/refs/heads/main/backend/services/camunda/case-management/case-management.zip

Open that URL in your browser — Web Modeler will present the resources for import. If the .zip contains at least one BPMN file, Web Modeler will automatically treat the contents as a process application and group them accordingly.

Limits to keep in mind:

  • Max .zip size: 10 MB
  • Max files in the archive: 100
  • Max size per individual file: 3 MB

Option 2: Upload Files Manually

If you already have the .zip downloaded and extracted locally:

  • Create a new Process Application in Web Modeler.
  • Inside the process application, click Create new > Upload files.
  • Select the extracted files from your computer and click Upload.
  • Delete the auto-generated empty BPMN diagram if it's not needed.
tip

The "Upload files" method does not accept .zip files directly — you need to extract the contents first and upload the individual files.