Getting Started (WildFly, EAP, Vert.x, Tomcat)

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 10 zip
  2. Unpack the apiman 1.3.0.Final WildFly 10 overlay zip inside the wildfly directory

Run

  1. Start WildFly 10 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-1.3.0.Final
cd ~/apiman-1.3.0.Final
curl http://download.jboss.org/wildfly/10.1.0.Final/wildfly-10.1.0.Final.zip -o wildfly-10.1.0.Final.zip
curl http://downloads.jboss.org/apiman/1.3.0.Final/apiman-distro-wildfly10-1.3.0.Final-overlay.zip -o apiman-distro-wildfly10-1.3.0.Final-overlay.zip
unzip wildfly-10.1.0.Final.zip
unzip -o apiman-distro-wildfly10-1.3.0.Final-overlay.zip -d wildfly-10.1.0.Final
cd wildfly-10.1.0.Final
./bin/standalone.sh -c standalone-apiman.xml
                      

Download

Install

  1. Unpack the WildFly 10 zip
  2. Unpack the apiman 1.3.0.Final WildFly 10 overlay zip inside the wildfly directory
  3. Unpack the Vert.x Gateway zip

Run

  1. Start WildFly 10 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!
  3. Start the Vert.x Gateway using the Elasticsearch config:

    ./apiman-gateway.sh --conf configs/es-conf.json

Configure

  1. Add the Vert.x Gateway to the Apiman Manager as per the walkthrough.
  2. 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...

// Step 1
mkdir ~/apiman-1.3.0.Final
cd ~/apiman-1.3.0.Final
curl http://download.jboss.org/wildfly/10.1.0.Final/wildfly-10.1.0.Final.zip -o wildfly-10.1.0.Final.zip
curl http://downloads.jboss.org/apiman/1.3.0.Final/apiman-distro-wildfly10-1.3.0.Final-overlay.zip -o apiman-distro-wildfly10-1.3.0.Final-overlay.zip
unzip wildfly-10.1.0.Final.zip
unzip -o apiman-distro-wildfly10-1.3.0.Final-overlay.zip -d wildfly-10.1.0.Final
cd wildfly-10.1.0.Final
./bin/standalone.sh -c standalone-apiman.xml

// Step 2
cd ~/apiman-1.3.0.Final
curl http://downloads.jboss.org/apiman/1.3.0.Final/apiman-distro-vertx-1.3.0.Final.zip -o apiman-distro-vertx-1.3.0.Final.zip
cd apiman-distro-vertx-1.3.0.Final
./apiman-gateway.sh --conf=configs/conf-es.json

// Step 3
Add the gateway to the Manager.
                      

Download

Install

  1. Unpack the WildFly 9 zip
  2. Unpack the apiman 1.3.0.Final WildFly 9 overlay zip inside the wildfly directory

Run

  1. Start WildFly 9 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-1.3.0.Final
cd ~/apiman-1.3.0.Final
curl http://download.jboss.org/wildfly/9.0.2.Final/wildfly-9.0.2.Final.zip -o wildfly-9.0.2.Final.zip
curl http://downloads.jboss.org/apiman/1.3.0.Final/apiman-distro-wildfly9-1.3.0.Final-overlay.zip -o apiman-distro-wildfly9-1.3.0.Final-overlay.zip
unzip wildfly-9.0.2.Final.zip
unzip -o apiman-distro-wildfly9-1.3.0.Final-overlay.zip -d wildfly-9.0.2.Final
cd wildfly-9.0.2.Final
./bin/standalone.sh -c standalone-apiman.xml
                      

Download

Install

  1. Unpack the Apache Tomcat 8 zip
  2. Unpack the apiman 1.3.0.Final Tomcat 8 overlay zip inside the tomcat directory

Run

  1. Start Tomcat 8 using the default configuration
  2. Point your browser at the apiman UI and login with admin/admin123!
    We strongly recommend you change the admin password in tomcat-users.xml!

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-1.3.0.Final
cd ~/apiman-1.3.0.Final
curl http://apache.mirrors.tds.net/tomcat/tomcat-8/v8.0.33/bin/apache-tomcat-8.0.33.zip -o apache-tomcat-8.0.33.zip
curl http://downloads.jboss.org/apiman/1.3.0.Final/apiman-distro-tomcat8-1.3.0.Final-overlay.zip -o apiman-distro-tomcat8-1.3.0.Final-overlay.zip
unzip apache-tomcat-8.0.33.zip
unzip -o apiman-distro-tomcat8-1.3.0.Final-overlay.zip -d apache-tomcat-8.0.33
cd apache-tomcat-8.0.33
chmod 755 bin/catalina.sh
./bin/catalina.sh run
                      

Download

Install

  1. Unpack the EAP 7 zip
  2. Unpack the apiman 1.3.0.Final EAP 7 overlay zip inside the EAP directory

Run

  1. Start EAP 7 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.

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

Run

  • Use docker to run the "apiman WildFly 10" 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-wildfly10:1.3.0.Final
docker run -it -p 8080:8080 -p 8443:8443 apiman/on-wildfly10:1.3.0.Final
                      

Download

Run

  • Use docker to run the "apiman WildFly 9" 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-wildfly9:1.3.0.Final
docker run -it -p 8080:8080 -p 8443:8443 apiman/on-wildfly9:1.3.0.Final