Getting Started with Membrane API Gateway

Pick one of the following ways to run Membrane:

Using Java

Installation

1. Ensure Java 21 or newer is installed.
2. Download the latestMembrane API Gateway and unzip it:

   unzip membrane-api-gateway-7.X.X.zip

Start Membrane

1. Run the following commands in a terminal:

   cd membrane-api-gateway-7.X.X
   ./membrane.sh

2. You should see a log output similar to:

   INFO 1 main Router:364 {} - Membrane API Gateway 7.0.1 up and running!

Test the Installation

1. Open http://localhost:2000 in a browser or use curl:

   curl localhost:2000

2. Continue with the tutorial

Using Docker

1. Download a sample apis.yaml configuration:

   curl -O https://raw.githubusercontent.com/membrane/api-gateway/refs/heads/master/distribution/router/conf/apis.yaml

2. Start a container:

   Linux / macOS

   docker run -it -p 2000:2000 -v $(pwd)/apis.yaml:/conf/config.yaml predic8/membrane

   Windows PowerShell

   docker run -it -p 2000:2000 -v "${PWD}\apis.yaml:/conf/config.yaml" predic8/membrane

   Windows CMD

   set PWD=%cd%
   docker run -it -p 2000:2000 -v %PWD%\apis.yaml:/conf/config.yaml predic8/membrane:latest

3. Open http://localhost:2000 or use curl:

   curl localhost:2000

4. Continue with the tutorial

Troubleshooting

• Bad Gateway: If you see a 502 Bad Gateway error, ensure the backend is running or set up a proxy server.
• Port already in use: If port 2000 is taken, stop the conflicting service or change the port.
• Docker volume issues: If changes to apis.yaml don't apply, verify the volume mapping path.