Getting Started with Membrane API Gateway

Quickly set up Membrane API Gateway using Java, Docker, or JBang.

Using Java

  1. Ensure Java 21 or newer is installed.
  2. Download the Membrane binary and unzip it: 
    unzip membrane-service-proxy-6.X.X.zip
  3. Run the Membrane API Gateway: 
    cd membrane-service-proxy-6.X.X
./membrane.sh
  4. Open http://localhost:2000 or use curl: 
    curl localhost:2000
  5. Review the configuration at conf/proxies.xml: 
    <api port="2000">
  <target url="https://api.predic8.de"/>
</api>

Note: If you encounter a Bad Gateway error, consider setting up a proxy server.

Using Docker

docker run -p 2000:2000 predic8/membrane

Access Membrane at http://localhost:2000 or via curl: 

curl http://localhost:2000

Explore more on Docker deployment.

Using JBang

  1. Install JBang.
  2. Prepare a proxies.xml configuration file.
  3. Run Membrane: 
    jbang org.membrane-soa:starter:6.0.3 -c "path/to/proxies.xml"

Note: Check the latest version on Maven Repository.

Next Steps

Explore Membrane further with these tutorials: