Getting Started (WildFly, Docker)

One easy way to get started with Apiman is to simply download WildFly and the Apiman overlay. Unpack them both into the same location and you're off and running. You'll obviously also need to have Java installed - we currently require at least version 8.

Download

Install

  1. Unpack the WildFly zip
  2. Unpack the Apiman 2.0.0.Final WildFly overlay zip inside the wildfly directory

Run

  1. Start WildFly using the "standalone-apiman.xml" configuration
  2. Point your browser at the Apiman UI and login with admin/admin123!
    We strongly recommend you change the admin password(s) by logging in to keycloak!

Configure

The Apiman distribution comes pre-configured with everything you should need to get started. Please see the User Guide for information about how to change apiman configuration options if you require more customization.

Or simply try this...

mkdir ~/apiman-2.0.0.Final
cd ~/apiman-2.0.0.Final
curl -L https://download.jboss.org/wildfly/20.0.1.Final/wildfly-20.0.1.Final.zip -o wildfly-20.0.1.Final.zip
curl -L https://github.com/apiman/apiman/releases/download/2.0.0.Final/apiman-distro-wildfly-2.0.0.Final-overlay.zip -o apiman-distro-wildfly-2.0.0.Final-overlay.zip
unzip wildfly-20.0.1.Final.zip
unzip -o apiman-distro-wildfly-2.0.0.Final-overlay.zip -d wildfly-20.0.1.Final
cd wildfly-20.0.1.Final
./bin/standalone.sh -c standalone-apiman.xml
                      

Getting Started (Docker)

If you prefer to get started by using the Apiman docker images, that's cool too! Skip all the steps above and follow the instructions in this section instead.

Download

  • Use docker to pull the "Apiman WildFly" docker image: apiman/on-wildfly

Run

  • Use docker to run the "Apiman WildFly" docker image
  • Point your browser at the apiman UI and login with admin/admin123!
    We strongly recommend you change the admin password(s) by logging in to keycloak!

Configure

The Apiman distribution comes pre-configured with everything you should need to get started. Please see the User Guide for information about how to change Apiman configuration options if you require more customization.

More Info

For more information on Apiman docker support, including how to extend the image for your own uses, click here!

Or simply try this...

docker pull apiman/on-wildfly:2.0.0.Final
docker run -it -p 8080:8080 -p 8443:8443 apiman/on-wildfly:2.0.0.Final