Docker Compose
Follow this guide to setup Docker Compose to run Activiti Cloud on your local computer in Docker VM.

Hardware Setup

You will need to allocate at least 4 CPU cores and 8 Gb of RAM for your Docker VM machine.

Software Setup

Before you start, the following packages must be installed:

Clone Activiti Cloud Examples

Open Bash command line terminal and run these commands to clone https://github.com/Activiti/activiti-cloud-examples into your local environment:
1
git clone https://github.com/Activiti/activiti-cloud-examples
2
cd activiti-cloud-examples/docker-compose
Copied!

Configure Your Environment

You need to edit .env file to configure DOCKER_IP property based on your OS and Docker VM type.
  • Use your local computer IP address for Docker for Desktop on Linux, Mac or Windows
  • Use docker-machine ip command if you use Docker Toolbox
  • Don't use 127.0.0.1 or localhost

How To Run Activity Cloud

Start Modeler

1
make modeler
Copied!
After starting Modeler, wait for the containers to start. You can check the status by running make ps and make logs command to make sure that the containers are ready.
To access modeler please open the url in your browser:
1
http://$DOCKER_IP/modeling
Copied!
You will be redirected to keycloak where you have to use credentials modeler/password

Start Application

1
make application
Copied!
You will need to use Postman to use Activiti Rest Apis
Start Postman and add to Postman collection Activiti v7 REST API.postman_collection.json located in https://github.com/Activiti/activiti-cloud-examples
Then at the top right choose manage environment then use your own ip in current value tab. Then use activiti as default environment. To start work execute getKeycloakToken hruser in Postman Keycloak collection. Then run startProcess in rb-my-app Postman collection.

Start All Services

1
make all
Copied!

Start all serices Using Docker Compose

1
docker-compose up
Copied!

Stop All Services

1
make stop
Copied!

Stop Application

1
make application/stop
Copied!

Stop Modeler

1
make modeler/stop
Copied!

Shutdown All Services

1
make down
Copied!

Shutdown All Services Using Docker Compose

1
docker-compose down
Copied!

Usefull commands

To see and follow logs in your terminal
1
make logs
Copied!
To see logs for one service only
1
make example-runtime-bundle/logs
Copied!
Quickly ssh to service pod
1
make example-runtime-bundle/ssh
Copied!
Other available actions
1
make help
Copied!

Common errors

  • Please be sure that you are located in docker-compose folder before running commands.
  • If something doesn't work with modeller first of all clear cookies or start in incognito window
  • If you are using nip.io address make sure that local firewall or company firewall doesn't block requiests
Last modified 3d ago