Web Application Deployment

Membrane API Gateway can be installed as a Web App providing the following benefits:

An Application Server can startup and shutdown Membrane Service Proxy as needed.
The Service Proxy runs in the same VM as the Servlet Container or application server.
Deployment fits production in a data center.

Building the Service Proxy war and installing it into Tomcat (or any J2EE-compatible web server) requires the following steps:

1. Get the WAR

To quickly get started, download the war from the Maven repository and skip to the step 2. To customize it, continue here:

i. Checkout the Membrane Source Code

Checkout the source code from the following location:

https://github.com/membrane/service-proxy/

ii. Building the War

Excecute the following command from the directory where you checked out the sourcecode.

mvn package -DskipTests

The war will be build in war/target/.

2. Deploying the War in Tomcat

Copy the service-proxy-4.0.7.war into the Tomcat webapp directory located at

[tomcatDir]\webapps

Restart Tomcat. To test the router open .../admin in your browser. (Where "..." is the host and port your web server is listening on as well as the context root of the web application, for example http://localhost:8080/service-proxy-war-4.0.7/admin.)

More details on how to configure Membrane can be found in /WEB-INF/web.xml within the WAR.

Configuring Proxy Services

The Service Proxy is configured by the proxies.xml file. It is located in the WEB-INF directory of the war file. To open the archive simply rename it into a zip file (e.g. membrane.zip). The documentation of these files can be found here.