This guide explores downloading and installing the Apiman quickstarts.
The distribution consists of:
Apiman Manager (
Apiman Manager UI (
Apiman Developer Portal UI (
Apiman Gateway (
Apiman Gateway API (
Set up Keycloak IDM
In order to manage our users and provide login security we will use Keycloak.
For instructions, please refer to: Keycloak SSO Setup
We will assume you have not changed anything from the default Keycloak realm definition for the purposes of this guide . Please substitute your changes, where appropriate.
Installing Apiman on WildFly
Apiman can target WildFly as a runtime environment. In order to install Apiman you will need to download both WildFly and the Apiman overlay distribution.
Once both are downloaded, it’s a simple matter of unpacking both into the same location.
First you will need to download both WildFly and Apiman:
wget https://download.jboss.org/wildfly/23.0.2.Final/wildfly-23.0.2.Final.zip wget https://github.com/apiman/apiman/releases/download/3.2.0-SNAPSHOT/apiman-distro-wildfly-3.2.0-SNAPSHOT-overlay.zip
Run Apiman on WildFly
Ensure you have set
The Apiman overlay contains everything needed to run Apiman, including:
Apiman binaries (several WAR files)
Apiman-specific WildFly configuration (
Apiman RDBMS datasource (h2)
Drivers for some popular databases, including H2, PostgreSQL, and MySQL. See API Manager Database Configuration for more.
adminuser with password
export APIMAN_AUTH_URL=<Your keycloak URL> cd wildfly-23.0.2.Final ./bin/standalone.sh -c standalone-apiman.xml
Once Apiman is running, you should be able to log in to the API Manager by pointing your browser at the following URL:
Log in with credentials
We strongly advise that you immediately change the Keycloak admin user’s password, as well as the admin user found in the apiman realm!
You can do that by logging into your Keycloak console. If you followed this tutorial, it will be at localhost:8085/admin/
Installing using Docker
We have a variety of Docker images available with Apiman broken into its components. You can find them at: apiman/apiman-docker.
Refer to our Docker Compose quickstart guide for a full Docker setup that is already configured for you.