Getting Started with Membrane API Gateway

Choose one of the following options to run Membrane:

For other options like RPM, systemd or Windows service see Deployment

Using Java

Installation

  1. Ensure Java 21 or newer is installed.
  2. Download the latest Membrane API Gateway zip and unzip it: 
    unzip membrane-api-gateway-7.X.X.zip

Starting

  1. Execute in a terminal: 
    cd membrane-api-gateway-7.X.X
./membrane.sh
  2. Observe the log: 
    INFO 1 main Router:364 {} - Membrane API Gateway 7.0.1 up and running!

Testing 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