Skip to main content
Deployment options: WSO2 Cloud

Setting Up

This guide provides detailed instructions for deploying the API Platform Event Gateway in production environments. Choose the infrastructure option that matches your environment.

Quick Start

If you're just getting started, see the Getting Started guide for a quick setup.

Setup Instructions​

Prerequisites​

  • cURL installed
  • unzip installed
  • A Docker-compatible container runtime such as:
    • Docker Desktop (Windows / macOS)
    • Rancher Desktop (Windows / macOS)
    • Colima (macOS)
    • Docker Engine + Compose plugin (Linux)

Ensure docker and docker compose commands are available:

docker --version
docker compose version

Step 1: Download the Gateway​

Run this command in your terminal to download the gateway:

curl -sLO https://github.com/wso2/api-platform/releases/download/event-gateway/v0.8.0/wso2apip-event-gateway-0.8.0.zip && \
unzip wso2apip-event-gateway-0.8.0.zip

Step 2: Configure the Gateway​

Run this command to create wso2apip-event-gateway-0.8.0/configs/keys.env with the required environment variables:

cat > wso2apip-event-gateway-0.8.0/configs/keys.env << 'ENVFILE'
MOESIF_KEY=<your-moesif-key>
GATEWAY_CONTROLPLANE_HOST=connect.bijira.dev
GATEWAY_REGISTRATION_TOKEN=<your-gateway-token>
ENVFILE

Step 3: Start the Gateway​

  1. Navigate to the gateway folder:

    cd wso2apip-event-gateway-0.8.0

  2. Run this command to start the gateway using the configs/keys.env file created in Step 2:

    docker compose --env-file configs/keys.env up

To run in detached mode (background):

docker compose --env-file configs/keys.env up -d

Step 4: Verify the Gateway​

Check that the gateway is running:

docker compose ps

Stopping the Gateway​

To stop the gateway:

docker compose down

What's Next?​

TroubleshootingCommon issues and solutions