wso2/wso2is repository overview

⁠About WSO2 Product Docker Images

WSO2 product Docker images available at DockerHub⁠ package General Availability (GA) versions of WSO2 products with no WSO2 Updates⁠.

For a production grade deployment of the desired WSO2 product-version, it is highly recommended to use the relevant Docker image which packages WSO2 Updates, available at WSO2 Private Docker Registry⁠.

⁠Supported tags and respective Dockerfile links

You may discover the supported image tags for this product profile, under the Tags⁠ tab.

The following are the image tags for different operating system platforms of the latest version of this product profile and their corresponding Dockerfiles.

• 7.3.0, latest (Dockerfile)⁠
• 7.3.0-alpine (Dockerfile)⁠

⁠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 Identity Server product repository⁠ and Docker resource usage issues at product Docker resource repository⁠

• Maintained by:
  WSO2 LLC.⁠

• Supported Docker versions:
  Docker v17.09.0 or above

⁠About WSO2 Identity Server

WSO2 Identity Server, a part of the WSO2 Identity Platform⁠, is a uniquely flexible, open source IAM product optimized for identity federation and single sign-on (SSO) with comprehensive support for adaptive and strong authentication. It helps identity administrators to federate identities, secure access to web/mobile applications and endpoints, and bridge versatile identity protocols across on-premise and cloud environments.

⁠How to use this image.

⁠Start an Identity Server profile instance

The following command starts a Linux Ubuntu-based Identity Server profile Docker image.

$ docker run -it -p 9443:9443 --name is wso2/wso2is:7.3.0

Here, port 9443 has been mapped to the corresponding Docker host (host machine on top of which containers are spawned) port.

⁠Accessing Console

To access the management console, use the Docker host IP and port 9443 as follows:

https://{DOCKER_HOST}:9443/console

⁠Container shell access and viewing server logs

Assuming you have started a Docker container instance of Identity Server profile as instructed in the previous section Start an Identity Server profile instance,

• The Identity Server log is available through Docker's container log:

$ docker logs is

• The Docker exec command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside the container you created:

$ docker exec -it is bash

⁠Pass arguments during server startup

⁠Running in debug mode

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

$ docker run -it -p 9443:9443 -p 5005:5005 --name another-is wso2/wso2is:7.3.0 -debug *:5005

Note: Passing arguments during server startup is not supported in Docker image with tag 5.6.0.

⁠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 carbon.xml is as follows:

• Stop the Identity Server profile container if it's already running.

In the Identity Server profile product distribution, carbon.xml configuration file can be found at {DISTRIBUTION_HOME}/conf. Copy the file to a suitable location of the host machine, referred to as {SOURCE_CONFIGS}/carbon.xml and increase the offset value under ports by 1.

• Grant read permission to other users for {SOURCE_CONFIGS}/carbon.xml.

$ chmod o+r {SOURCE_CONFIGS}/carbon.xml

• Run the image by mounting the file to the container as follows:

$ docker run -p 9444:9444 --volume {SOURCE_CONFIGS}/carbon.xml:{TARGET_CONFIGS}/carbon.xml wso2/wso2is:7.3.0

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

⁠Image Variants

Multiple product profile Docker images based on different base operating systems are available.

⁠wso2is:{version}

Ubuntu 24.04 LTS serves as the base Docker image. On top of this, Temurin OpenJDK 21 is installed, followed by the installation of WSO2 Identity Server.

⁠wso2is:{version}-alpine

Alpine 3.22 serves as the base Docker image. On top of this, Temurin OpenJDK 21 is installed, followed by the installation of WSO2 Identity Server.

WSO2 Identity Server has been installed on top of this Docker image.

⁠License

View license information⁠ 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.