Skip to content

Install WSO2 Identity Server

Prerequisites

Before installing any WSO2 Identity Server, it is necessary to have the appropriate prerequisite software installed on your system. Verify that the computer has the supported operating system and development platforms before starting the installation.

System requirements

Note

The below recommendations can change based on the expected concurrency & performance.

CPU

4 vCPUs (x86_64 Architecture)

Memory

4 GB RAM

Disk

~ 10 GB disk space, excluding space allocated for log files and databases.

Environment compatibility

Operating Systems/ Databases/ Userstores

  • WSO2 Identity Server requires an Oracle JDK 11 or JDK 17 compliant JDK. This will run on most common platforms that support Java 11 or Java 17. .
  • All WSO2 Carbon-based products are generally compatible with most common DBMSs. The embedded H2 database is suitable for development and testing. For enterprise production environments we recommend an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, MS SQL, etc. .
  • WSO2 Identity Server supports using any of the following as a user store :
    • RDBMS
    • An LDAP such as OpenLDAP
    • Active Directory
    • Custom Userstores

Note

  • WSO2 does not recommend using the H2 database as a user store in production environments. However, you can use the H2 database for development purposes if necessary.

  • For environments that WSO2 products are tested with, see Environment Compatibility .
  • If you have difficulty setting up any WSO2 product in a specific platform or database, contact WSO2.

Required applications

The following applications are required for running the product and its samples or for building from the source code.

Note

The applications marked with an asterisk * are mandatory.

Required applications to run the product

These applications are mandatory and are required to run the binary distribution of the WSO2 product. The binary distribution contains the binary files for both MS Windows and Linux-based operating systems.

Application

Purpose

Version

Java SE Development Kit (JDK)*

  • Oracle JDK 11

  • OpenJDK 11

Web Browser*

  • To access the product's Console, the Web Browser must be JavaScript enabled to take full advantage of the console.

Note: On Windows Server 2003, you must not go below the medium security level in Internet Explorer 6.x.



Required applications to run samples and build from source

These applications are required for building the product from the source distribution, and compiling and running product samples.

Warning

If you are installing by downloading and extracting the binary distribution (as recommended for most users) instead of building from the source code, you do not need to install Maven.

Application


Purpose Version Download Links

Apache Maven

  • To build the product from the source distribution (NOTE: both JDK and Apache Maven are required).

3.0.x or later

Apache Maven

Install on different platforms

This section of the guide helps you to install WSO2 Identity Server on different operating systems.

Install on Linux or OS X

Follow the instructions below to install WSO2 Identity Server on Linux or Mac OS X.

Install the required applications

  1. Log in to the command line (Terminal on Mac).

  2. Ensure that your system meets the Installation Prerequisites. Java Development Kit (JDK) is essential to run the product.

Install WSO2 Identity Server

  1. Download the latest version of WSO2 Identity Server.
  2. Extract the archive file to a dedicated directory for WSO2 Identity Server, which will hereafter be referred to as <IS_HOME>.

Set up JAVA_HOME

You must set your JAVA_HOME environment variable to point to the directory where the Java Development Kit (JDK) is installed on the computer.

Setting JAVA_HOME is a standard practice when you are using Java-based programs. You may not need to do this manually depending on your Java installer, as this variable is usually set by the Java installer itself. This guide is provided in case the JAVA_HOME variable has not been set or is incorrectly set on your machine.

Info

Environment variables are global system variables accessible by all the processes running in the operating system.

  1. In your home directory, open the BASHRC file (.bash_profile file on Mac) using a text editor such as vi, emacs, pico, or mcedit.
  2. Assuming you have JDK 11.0.14 in your system, add the following two lines at the bottom of the file (Replace /usr/java/jdk-11.0.14 with the path of your JDK installation). directory where the JDK is installed.

    export JAVA_HOME=/usr/java/jdk-11.0.14
    export PATH=${JAVA_HOME}/bin:${PATH}
    
    export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-11.0.14/Contents/Home
    
  3. Save the file.

    Info

    If you are not familiar with text editors in a Linux SSH session, run the cat >> .bashrc. command on a terminal, paste the string from the clipboard, and press Ctrl+D.

  4. To verify that the JAVA_HOME variable is set correctly, execute the following command:

    echo $JAVA_HOME
    
    which java
    

    If the above command gives you a path like /usr/bin/java, then it is a symbolic link to the real location. To get the real location, run the following:

    ls -l `which java`
    
  5. The system returns the JDK installation path.

Set system properties

If you need to set additional system properties when the server starts, you can take the following approaches:

  • Set the properties from a script : Setting your system properties in the startup script is ideal, because it ensures that you set the properties every time you start the server. To avoid having to modify the script each time you upgrade, create your own startup script that wraps the WSO2 startup script and add the properties you want to set, rather than editing the WSO2 startup script directly.

  • Set the properties from an external registry : If you want to access properties from an external registry, you could create Java code that reads the properties at runtime from that registry. Be sure to store sensitive data such as username and password to connect to the registry in a properties file instead of in the Java code and secure the properties file with the cipher tool.

You are now ready to run the product.

Install on Windows

Follow the instructions below to install the WSO2 Identity Server on Windows.

Install the required applications

  1. Ensure that your system meets the requirements specified in the Installation Prerequisites. Java Development Kit (JDK) is essential to run the product.
  2. Ensure that the PATH environment variable is set to C:\Windows\System32, because the findstr Windows.exe file is stored in this path.

Install WSO2 Identity Server

  1. Download the latest version of WSO2 Identity Server.
  2. Extract the archive file to a dedicated directory for WSO2 Identity Server, which will hereafter be referred to as <IS_HOME>.

  3. Set the CARBON_HOME environment variable by pointing it to the directory where you download the WSO2 Identity Server. For more information on how to do this, see here.

Set up JAVA_HOME

You must set your JAVA_HOME environment variable to point to the directory where the Java Development Kit (JDK) is installed on the computer. Typically, the JDK is installed in a directory under C:/Program Files/Java, such as C:/Program Files/Java/jdk-11.0.14 . If you have multiple versions installed, choose the latest one, which you can find by sorting by date.

Note

Environment variables are global system variables accessible by all the processes running under the operating system. You can define an environment variable as a system variable, which applies to all users, or as a user variable, which applies only to the user who is currently logged in.

You set up JAVA_HOME using the System Properties, as described below. Alternatively, if you just want to set JAVA_HOME temporarily for the current command prompt window, set it at the command prompt.

Set up JAVA_HOME using the system properties
  1. Right-click on My Computer icon on the desktop and choose Properties.

  2. In the System Properties window, click the Advanced, and then click Environment Variables.

  3. Click New under System variables (for all users) or under User variables (just for the user who is currently logged in).

  4. Enter the following information:

    Field Description Value
    Variable name Variable used to define the Java home. JAVA_HOME
    Variable value The installation path of the Java Development Kit. c:/Program Files/Java

The JAVA_HOME variable is now set and will apply to any subsequent command prompt windows you open. If you have existing command prompt windows running, you must close and reopen them for the JAVA_HOME variable to take effect, or manually set the JAVA_HOME variable in those command prompt windows as described in the next section.

To verify that the JAVA_HOME variable is set correctly, open a command window (from the Start menu, click Run, and then type CMD and click Enter ) and execute the following command.

set JAVA_HOME

The system returns the JDK installation path. You are now ready to run the product.

Set JAVA_HOME temporarily using the Windows command prompt (CMD)

You can temporarily set the JAVA_HOME environment variable within a Windows command prompt window (CMD). This is useful when you have an existing command prompt window running and you do not want to restart it.

  1. In the command prompt window, enter the following command where <JDK_INSTALLATION_PATH> is the JDK installation directory and press Enter.

    Format

    set JAVA_HOME=<JDK_INSTALLATION_PATH>
    


    Example

    set JAVA_HOME=c:/Program Files/java/jdk-11.0.14
    

    The JAVA_HOME variable is now set for the current CMD session only.

  2. To verify that the JAVA_HOME variable is set correctly, execute the following command:

    set JAVA_HOME
    
  3. The system returns the JDK installation path.

Set system properties

If you need to set additional system properties when the server starts, you can take the following approaches:

  • Set the properties from a script : Setting your system properties in the startup script is ideal, because it ensures that you set the properties every time you start the server. To avoid having to modify the script each time you upgrade, create your own startup script that wraps the WSO2 startup script and add the properties you want to set, rather than editing the WSO2 startup script directly.

  • Set the properties from an external registry : If you want to access properties from an external registry, you could create Java code that reads the properties at runtime from that registry. Be sure to store sensitive data such as username and password to connect to the registry in a properties file instead of in the Java code and secure the properties file with the cipher tool.

You are now ready to run the product.

Install as a Linux Service

WSO2 Carbon and any Carbon-based product can be run as a Linux service as described in the following sections:

Prerequisites

Install JDK and set up the JAVA_HOME environment variable. For more information, see Installation Prerequisites.

Set up CARBON_HOME

Extract the WSO2 product that you want to run as a Linux service and set the environment variable CARBON_HOME to the extracted product directory location.

Run the product as a Linux service

  1. To run the product as a service, create a startup script and add it to the boot sequence. The basic structure of the startup script has three parts (i.e., start, stop, and restart) as follows:

    #!/bin/bash
    
    case "$1″ in
    start)
       echo "Starting Service"
    ;;
    stop)
       echo "Stopping Service"
    ;;
    restart)
       echo "Restarting Service"
    ;;
    *)
       echo $"Usage: $0 {start|stop|restart}"
    exit 1
    esac
    
    Example startup script written for WSO2 Identity Server 5.9.0
    #! /bin/sh
    ### BEGIN INIT INFO
    # Provides:          wso2is
    # Required-Start:    $all
    # Required-Stop:
    # Default-Start:     2 3 4 5
    # Default-Stop:
    # Short-Description: starts the wso2 identity server
    ### END INIT INFO
    export JAVA_HOME="/usr/lib/jvm/jdk-11.0.14"
    
    startcmd='/opt/WSO2/wso2is-5.9.0/bin/wso2server.sh start > /dev/null &'
    restartcmd='/opt/WSO2/wso2is-5.9.0/bin/wso2server.sh restart > /dev/null &'
    stopcmd='/opt/WSO2/wso2is-5.9.0/bin/wso2server.sh stop > /dev/null &'
    
    case "$1" in
    start)
    echo "Starting WSO2 Identity Server ..."
    su -c "${startcmd}" user1
    ;;
    restart)
    echo "Re-starting WSO2 Identity Server ..."
    su -c "${restartcmd}" user1
    ;;
    stop)
    echo "Stopping WSO2 Identity Server ..."
    su -c "${stopcmd}" user1
    ;;
    *)
    echo "Usage: $0 {start|stop|restart}"
    exit 1
    esac
    

    In the above script, the server is started as a user by the name user1 rather than the root user. For example, su -c "${startcmd}" user1

  2. Add the script to /etc/init.d/ directory.

    Note

    If you want to keep the scripts in a location other than /etc/init.d/ folder, you can add a symbolic link to the script in /etc/init.d/ and keep the actual script in a separate location. Say your script name is identityserver and it is in /opt/WSO2/ folder, then the commands for adding a link to /etc/init.d/ is as follows:

    • Make your script executable: sudo chmod a+x /opt/WSO2/identityserver

    • Add a link to /etc/init.d/ : sudo ln -snf /opt/WSO2/identityserver /etc/init.d/identityserver

  3. Install the startup script to respective runlevels using the command update-rc.d.

    For example, give the following command for the sample script shown in step1:

    sudo update-rc.d identityserver  defaults 
    

    The defaults option in the above command makes the service start in runlevels 2,3,4 and 5 and stop in runlevels 0,1 and 6.

    Note

    Runlevel is a mode of operation in Linux (or any Unix-style operating system). There are several runlevels in a Linux server and each of these runlevels is represented by a single-digit integer. Each runlevel designates a different system configuration and allows access to a different combination of processes.

  4. You can now start, stop and restart the server using service <service name> {start|stop|restart} command.

Install as a Windows Service

Any Java-based application, including WSO2 Carbon and Carbon-based products, can be run as a Windows service by using a bridging tool such as Yet Another Java Service Wrapper (YAJSW).

Info

As YAJSW is distributed under the LGPL license and WSO2 is distributed under the Apache2 license, these two cannot be packed together in a distribution. However, any end-user or customer can freely combine components under these two licenses as long as the combined work is not distributed. The following instructions will guide you on the process of using YAJSW to install the WSO2 Identity Server as a Windows Service.

Follow the instructions in the sections below to set it up.

Prerequisites

  • Install JDK and set up the JAVA_HOME environment variable. For more information, see Installation Prerequisites.

  • Download and install a service wrapper library for running WSO2 Identity Server as a Windows service. WSO2 recommends Yet Another Java Service Wrapper (YAJSW) version 13.03, and several WSO2 products provide a default wrapper.conf file in their <PRODUCT_HOME>/bin/yajsw/ directory. The following instructions describe how to set up this file.

Set up the YAJSW wrapper configuration file

The wrapper.conf file is used for wrapping Java Applications by YAJSW. The wrapper.conf file found in the <IS_HOME>/bin/yajsw/ directory holds the minimal configuration for running a WSO2 product as a Windows Service.

Copy the wrapper.conf file found in the <IS_HOME>/bin/yajsw/ directory and paste it into the <YAJSW_HOME>/conf/ directory. A sample wrapper.conf file that is packed with the WSO2 product is given below.

Note

If you wish to set additional properties from an external registry at runtime, store sensitive information like usernames and passwords for connecting to the registry in a properties file, and secure it with the cipher tool.

Sample wrapper.conf file
#********************************************************************
# working directory
#********************************************************************
wrapper.working.dir=${carbon_home}/
# Java Main class.
# YAJSW: default is "org.rzo.yajsw.app.WrapperJVMMain"
# DO NOT SET THIS PROPERTY UNLESS YOU HAVE YOUR OWN IMPLEMENTATION
# wrapper.java.mainclass=
#********************************************************************
# tmp folder
# yajsw creates temporary files named in_.. out_.. err_.. jna..
# per default these are placed in jna.tmpdir.
# jna.tmpdir is set in setenv batch file to <yajsw>/tmp
#********************************************************************
wrapper.tmp.path = ${jna_tmpdir}
#********************************************************************
# Application main class or native executable
# One of the following properties MUST be defined
#********************************************************************
# Java Application main class
wrapper.java.app.mainclass=org.wso2.carbon.bootstrap.Bootstrap
# Log Level for console output.  (See docs for log levels)
wrapper.console.loglevel=INFO
# Log file to use for wrapper output logging.
wrapper.logfile=${wrapper_home}\/log\/wrapper.log
# Format of output for the log file.  (See docs for formats)
#wrapper.logfile.format=LPTM
# Log Level for log file output.  (See docs for log levels)
#wrapper.logfile.loglevel=INFO
# Maximum size that the log file will be allowed to grow to before
#  the log is rolled. Size is specified in bytes.  The default value
#  of 0, disables log rolling by size.  May abbreviate with the 'k' (kB) or
#  'm' (mB) suffix.  For example: 10m = 10 megabytes.
# If wrapper.logfile does not contain the string ROLLNUM it will be automatically added as suffix of the file name
wrapper.logfile.maxsize=10m
# Maximum number of rolled log files which will be allowed before old
#  files are deleted.  The default value of 0 implies no limit.
wrapper.logfile.maxfiles=10
# Title to use when running as a console
wrapper.console.title=WSO2 Carbon
#********************************************************************
# Wrapper Windows Service and Posix Daemon Properties
#********************************************************************
# Name of the service
wrapper.ntservice.name=WSO2CARBON
# Display name of the service
wrapper.ntservice.displayname=WSO2 Carbon
# Description of the service
wrapper.ntservice.description=Carbon Kernel
#********************************************************************
# Wrapper System Tray Properties
#********************************************************************
# enable system tray
wrapper.tray = true
# TCP/IP port. If none is defined multicast discovery is used to find the port
# Set the port in case multicast is not possible.
wrapper.tray.port = 15002
#********************************************************************
# Exit Code Properties
# Restart on non zero exit code
#********************************************************************
wrapper.on_exit.0=SHUTDOWN
wrapper.on_exit.default=RESTART
#********************************************************************
# Trigger actions on console output
#********************************************************************
# On Exception show message in system tray
wrapper.filter.trigger.0=Exception
wrapper.filter.script.0=${wrapper_home}/scripts/trayMessage.gv
wrapper.filter.script.0.args=Exception
#********************************************************************
# genConfig: further Properties generated by genConfig
#********************************************************************
placeHolderSoGenPropsComeHere=
wrapper.java.command = java
wrapper.java.classpath.1 = ${carbon_home}/bin/*.jar
wrapper.java.classpath.2 = ${carbon_home}/lib/commons-lang-*.jar
wrapper.java.classpath.3 = ${carbon_home}/lib/*.jar
wrapper.app.parameter.1 = org.wso2.carbon.bootstrap.Bootstrap
wrapper.app.parameter.2 = RUN
wrapper.java.additional.1 = -Xbootclasspath/a:${carbon_home}/lib/xboot/*.jar
wrapper.java.additional.2 = -Xms256m
wrapper.java.additional.3 = -Xmx1024m
wrapper.java.additional.4 = -XX:+HeapDumpOnOutOfMemoryError
wrapper.java.additional.5 = -XX:HeapDumpPath=${carbon_home}/repository/logs/heap-dump.hprof
wrapper.java.additional.6 = -Dcom.sun.management.jmxremote
wrapper.java.additional.7 = -Dcarbon.registry.root=\/
wrapper.java.additional.8 = -Dcarbon.home=${carbon_home}
wrapper.java.additional.9 = -Dwso2.server.standalone=true
wrapper.java.additional.10 = -Djava.command=${java_home}/bin/java
wrapper.java.additional.11 = -Djava.io.tmpdir=${carbon_home}/tmp
wrapper.java.additional.12 = -Dcatalina.base=${carbon_home}/lib/tomcat
wrapper.java.additional.13 = -Djava.util.logging.config.file=${carbon_home}/repository/conf/etc/logging-bridge.properties
wrapper.java.additional.14 = -Dcarbon.config.dir.path=${carbon_home}/repository/conf
wrapper.java.additional.15 = -Dcarbon.logs.path=${carbon_home}/repository/logs
wrapper.java.additional.16 = -Dcomponents.repo=${carbon_home}/repository/components/plugins
wrapper.java.additional.17 = -Dconf.location=${carbon_home}/repository/conf
wrapper.java.additional.18 = -Dcom.atomikos.icatch.file=${carbon_home}/lib/transactions.properties
wrapper.java.additional.19 = -Dcom.atomikos.icatch.hide_init_file_path=true
wrapper.java.additional.20 = -Dorg.apache.jasper.runtime.BodyContentImpl.LIMIT_BUFFER=true
wrapper.java.additional.21 = -Dcom.sun.jndi.ldap.connect.pool.authentication=simple
wrapper.java.additional.22 = -Dcom.sun.jndi.ldap.connect.pool.timeout=3000
wrapper.java.additional.23 = -Dorg.terracotta.quartz.skipUpdateCheck=true
wrapper.java.additional.24 = -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=false
wrapper.java.additional.25 = -Dfile.encoding=UTF8
wrapper.java.additional.26 = -DworkerNode=false
wrapper.java.additional.27 = -Dhttpclient.hostnameVerifier=DefaultAndLocalhost
wrapper.java.additional.28 = -Dcarbon.new.config.dir.path=${carbon_home}/repository/resources/conf

Set up carbon_home

Extract the Carbon-based product that you want to run as a Windows service, and then set the Windows environment variable carbon_home to the directory from which you extracted the product. For example, if you want to run WSO2 Identity Server as a Windows service, you would set carbon_home to the extracted wso2is-7.0.0 directory.

Run the product in console mode

You will now verify that YAJSW is configured correctly for running the Carbon-based product as a Windows service.

  1. Open a Windows command prompt and go to the <YAJSW_HOME>/bat/ directory. For example:

    cd C:\Documents and Settings\yajsw_home\bat
    
  2. Start the wrapper in console mode using the following command:

    runConsole.bat
    

    If the configurations are set properly for YAJSW, you will see console output similar to the following. Now you can access the WSO2 Identity Server console from your web browser via https://localhost:9443/console.

Work with the WSO2CARBON service

  • To install the Carbon-based product as a Windows service, open a console with administrative privileges and execute the following command in the <YAJSW_HOME>/bat/ directory:

    installService.bat
    

    The console will display a message confirming that the WSO2CARBON service has been installed.

  • To start the service, execute the following command in the same console window (with administrative privileges):

    startService.bat
    

    The console will display a message confirming that the WSO2CARBON service has been started.

  • To stop the service, execute the following command in the same console window (with administrative privileges):

    stopService.bat
    

    The console will display a message confirming that the WSO2CARBON service has been stopped.

  • To uninstall the service, execute the following command in the same console window (with administrative privileges):

    uninstallService.bat
    

    The console will display a message confirming that the WSO2CARBON service has been removed.

Uninstall the product

To remove an installed product, follow the instructions below:

OS Instructions
Mac OS

Open a terminal and run the following command as the root user:

Windows
  • Go to the Start Menu -> Programs -> WSO2 -> Uninstall <PRODUCT_NAME_VERSION> or search Uninstall <PRODUCT_NAME_VERSION> and click the shortcut icon. This will uninstall the product from your computer.
  • NOTE: The above path is provided assuming the IS_HOME is in C:/Program Files/WSO2/<PRODUCT_NAME>/<VERSION>
  • Ubuntu

    Open a terminal and run the following command:

    CentOS

    Open a terminal and run the following command: