wso2/wso2am-universal-gw

About WSO2 Universal Gateway

WSO2 Universal Gateway is responsible for handling and managing API runtime traffic within the WSO2 API Manager architecture.

It acts as the execution layer where APIs are deployed and exposed to clients, enforcing security, throttling, routing, and mediation policies.

As part of a distributed API management setup, the Universal Gateway works alongside the Control Plane and Traffic Manager to provide a scalable, high-performance API runtime.

Built on a modern, lightweight architecture, it is optimized for high throughput and low latency.

About WSO2 Docker Images

WSO2 provides Docker images on https://hub.docker.com/u/wso2/ for multiple products. These images contain General Availability (GA) versions without WSO2 Updates.

For production deployments, it is recommended to use updated images from the WSO2 Private Docker Registry, which include WSO2 Updates.

About WSO2 Universal Gateway Docker Images

WSO2 Universal Gateway Docker images are built for running the API runtime (data plane) component of WSO2 API Manager in containerized environments.

They support multiple base OS variants and are designed for development, testing, and deployment of API-driven architectures.

Supported Tags

• 4.7.0
  https://github.com/wso2/docker-apim/blob/v4.7.0.1/dockerfiles/ubuntu/apim-universal-gw/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.7.0.1/dockerfiles/alpine/apim-universal-gw/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.7.0.1/dockerfiles/rocky/apim-universal-gw/Dockerfile

• 4.6.0
  https://github.com/wso2/docker-apim/blob/v4.6.0.5/dockerfiles/ubuntu/apim-universal-gw/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.6.0.5/dockerfiles/alpine/apim-universal-gw/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.6.0.5/dockerfiles/rocky/apim-universal-gw/Dockerfile

• 4.5.0
  https://github.com/wso2/docker-apim/blob/v4.5.0.1/dockerfiles/ubuntu/apim-universal-gw/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.5.0.1/dockerfiles/alpine/apim-universal-gw/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.5.0.1/dockerfiles/rocky/apim-universal-gw/Dockerfile

Start a WSO2 Universal Gateway instance:

bash
docker run -it -p 8243:8243 \
  --name api-universal-gw wso2/wso2am-universal-gw:4.7.0

By default, port 8243 is exposed. You can map additional ports as needed.

Logs & Shell Access

• View logs:

  bash
  docker logs api-universal-gw
  

• Access container shell:

  bash
  docker exec -it api-universal-gw bash
  

Debug Mode

Run the container with remote debugging enabled (port 5005):

bash
docker run -it -p 8243:8243 -p 5005:5005 \
  --name api-universal-gw-debug \
  wso2/wso2am-universal-gw:4.7.0 -debug *:5005

Configuration Override

You can override Universal Gateway configurations by mounting files from the host.

Example: Update deployment.toml

1. Copy the config file from the product: {DISTRIBUTION_HOME}/repository/conf/deployment.toml

2. Update required values (e.g., set port offset):

   toml
   [server]
   offset = 1
   

3. Grant read permission:

   bash
   chmod o+r {SOURCE_CONFIGS}/deployment.toml
   

4. Run the container with the mounted config:

   bash
   docker run -p 8244:8244 \
     --volume {SOURCE_CONFIGS}/deployment.toml:{TARGET_CONFIGS}/deployment.toml \
     wso2/wso2am-universal-gw:4.7.0
   

{TARGET_CONFIGS} refers to: /home/wso2carbon/wso2am-universal-gw-4.7.0/repository/conf

Image Variants

WSO2 Universal Gateway Docker images are available with different base operating systems.

Each image includes a pre-installed WSO2 Universal Gateway distribution on top of the respective base OS.

Quick reference

• Where to get help: Docker Community Forums, Docker Community Slack, Stack Overflow or mail to WSO2 Developer mailing list

• Where to file issues: Product specific issues at WSO2 API Manager product https://github.com/wso2/api-manager/issues and Docker resource usage issues at WSO2 API Manager product Docker resource https://github.com/wso2/docker-apim/issues

• Maintained by: WSO2 LLC.

• Supported Docker versions: Docker v17.09.0 or above

License

View https://github.com/wso2/product-apim/blob/master/gateway/LICENSE.txt for the software contained in this image.

As with all Docker images, these are likely to contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.