Docker - API-Manager Wso2am

| 1 min read

Week Of: 2022-09-18



Wso2am is one of the most usable and configurable open-source API management system.
Here, in a few click you can load your own system for the system trial as well as fast API testing.

Docker Build

docker pull wso2/wso2am:4.1.0

Docker run

docker run -it -p 8280:8280 -p 8243:8243 -p 9443:9443 --name api-manager wso2/wso2am:4.1.0

Running in debug mode

To start a Docker container instance of the API Manager in debug mode (assuming 5005 to be the remote debugging port), use the following command:

docker run -it -p 8280:8280 -p 8243:8243 -p 9443:9443 -p 5005:5005 --name another-api-manager wso2/wso2am:4.1.0 -debug *:5005

How to update configurations

Configurations would lie on the Docker host machine and they can be volume mounted to the container. As an example, the steps required to change the port offset using deployment.toml is as follows:

  • Stop the API Manager container if it's already running.

In the API Manager product distribution, deployment.toml configuration file can be found at {DISTRIBUTION_HOME}/repository/conf.

Copy the file to a suitable location of the host machine, referred to as {SOURCE_CONFIGS}/deployment.toml and change the offset value ([server]->offset) to 1.

  • Grant read permission to other users for {SOURCE_CONFIGS}/deployment.toml.
chmod o+r {SOURCE_CONFIGS}/deployment.toml
  • Run the image by mounting the file to the container as follows:
docker run -p 9444:9444 --volume {SOURCE_CONFIGS}/deployment.toml:{TARGET_CONFIGS}/deployment.toml wso2/wso2am:4.1.0

Here, {TARGET_CONFIGS} refers to /home/wso2carbon/wso2am-4.1.0/repository/conf folder of the container.

Accessing management console

jmx, logs, ports and other Linux dists