Docker-compose based installation
This setup contains a fully configured Apicurio-Studio package, already integrated with MySQL, Keycloak and Microcks. It contains a shell script which will configure the environment. Currently every application is routed to the host network without SSL support. This is a development version, do not use it in a production environment!
Here is the port mapping:
- 8090 for Keycloak
- 8091 for the API
- 8092 for the websockets
- 8093 for the UI
- 8900 for Microcks
The folder contains a bash and a powershell script to make the initialization. The script will create the configuration files based on your IP address. The scripts will create 3 files:
Using the bash script
You just have to run it with an argument which is your IP address:
chmod +x setup.sh ./setup.sh 192.168.0.1
Using the PowerShell script
You have to start PowerShell, and you have to setup script running:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine
After this step you will be able to run our script, the argument with your IP is mandatory:
After the successfull run of the setup script, a file called
.env will appear. This file contains the customisable properties of the environment. Every property is already filled in, so this is only for customisation. You can set your passwords, URL's, and the versions of the components of Apicurio-Studio. The default version is the
latest-release tagged container from dockerhub, but you can change this as you want. In the near future we will generate the passwords and the Microcks client-secret in the setup process dynamically.
If you want to change these settings (or the provided KeyCloak configuration) after you already started the stack, you have to remove the already existing docker volumes. The easiest way is to stop your running compose stack, and prune your volumes:
docker system prune --volumes
Starting the environment
When your configs are generated, you can start the whole stack with this command:
docker-compose -f docker-compose.keycloak.yml build docker-compose -f docker-compose.keycloak.yml -f docker-compose.microcks.yml -f docker-compose.apicurio.yml up
Configure users in Keycloak
The Keycloak instance is already configured, you don't have to create the realms manually.
At the first start there are no default users added to Keycloak. Please navigate to:
The default credentials for Keycloak are:
Select Apicurio realm and add a user to it. After this, you have to do this with Microcks too.
Login to Apicurio and Microcks