For AI agents: the complete documentation index is available at llms.txt; every page is also available as Markdown by appending .md to its URL.
Skip to main content

With Docker Compose

This guide shows you how to install and run Microcks using Docker Compose.

Docker Compose is a tool for easily testing and running multi-container applications. Microcks offers a simple way to set up the minimal required containers to have a functional environment on your local computer.

Usage​

To get started, make sure you have Docker installed on your system.

In your terminal, issue the following commands:

  1. Clone this repository.
git clone https://github.com/microcks/microcks.git --depth 10
  1. Change to the install folder
cd microcks/install/docker-compose
  1. Spin up the containers
docker compose up -d

This will start the required containers and set up a simple environment for you to use.

Open a new browser tab and point to the http://localhost:8080 endpoint. This will redirect you to the Keycloak sign-in page for login. Use the following default credentials to log in to the application:

  • Username: admin
  • Password: microcks123

You will be redirected to the main dashboard page.

Enabling Asynchronous API features​

The docker-compose.yml file does not, by default, support Microcks' asynchronous API features. However, if you feel your local machine has enough resources to afford it, you can enable them using a slightly different command line.

In your terminal, use the following command instead:

docker compose -f docker-compose.yml -f async-addon.yml up -d

Docker compose is now launching additional containers, namely zookeeper, kafka and the microcks-async-minion. The above command should produce the following output:

Creating network "docker-compose_default" with the default driver
Creating microcks-zookeeper       ... done
Creating microcks-db              ... done
Creating microcks-sso             ... done
Creating microcks-postman-runtime ... done
Creating microcks                 ... done
Creating microcks-kafka           ... done
Creating microcks-async-minion    ... done

You may want to check our blog post for a detailed walkthrough on starting Async features on docker-compose.

If you're feeling lucky regarding your machine, you can even add the Kafdrop utility to visualize and troubleshoot Kafka messages with this command:

docker compose -f docker-compose.yml -f async-addon.yml -f kafdrop-addon.yml up -d

Development mode​

A development-oriented mode, without the Keycloak service, is also available thanks to:

docker compose -f docker-compose-devmode.yml up -d

This configuration enabled Asynchronous API features in a very lightweight mode using Red Panda broker instead of a full-blown Apache Kafka distribution.

Wrap-up​

You just installed Microcks on your local machine using Docker Compose and terminal commands. Congrats! 🎉

You have discovered that Microcks provides a bunch of default profiles to use different capabilities of Microcks depending on your working situation. Advanced profiles use local configuration files mounted from the /config directory. You can refer to the Application Configuration Reference to get the full list of configuration options.