Skip to content

Deployment Checklist

Guideline Details
Security hardening Guidelines for hardening the security of a WSO2 Identity Server deployment in a production environment can be discussed under three high-level categories:
  • Product-level security
  • OS-level security
  • Network-level security
Related Topics
  • Security Guidelines for Production Deployment
  • Hostname By default, WSO2 Identity Server identifies the hostname of the current machine through the Java API. However, this value sometimes yields erroneous results on some environments. Therefore, users are recommended to configure the hostname by setting the relevant parameter in the <IS_HOME>/repository/conf/deployment.toml file.
    Related Topics
  • Change the hostname
  • Userstores
    WSO2 Identity Server offers three choices to store user details:
    • Using a database
    • Using an LDAP server
    • Using an Active Directory service
    The default is the embedded H2 database, with the userstore schema. Like in the case of the registry database, you can switch to a database like Oracle, MySQL, or MSSQL. You can point to an existing LDAP or an Active Directory to make use of existing user bases and grant access privileges based on those userstores.
    Tuning WSO2 products WSO2 Identity Server has additional guidelines for optimizing the performance of product-specific features.
    Related Topics
  • Performance Tuning Recommendations
  • Firewalls
    The following ports must be accessed when operating within a firewall.
    • 9443 - Used by the console and services that use the servlet transport, and is defined in the <IS_HOME>/repository/conf/deployment.toml file.
    Proxy servers
    WSO2 Identity Server can work with two types of proxy servers. They serve different purposes and are configured independently.

    Forward proxy (outbound traffic)
    If WSO2 Identity Server must connect to external endpoints through a forward proxy, provide the following system properties at server start-up.

    -Dhttps.proxyHost=your.proxy.host
    -Dhttps.proxyPort=your.proxy.port
    -Dhttp.proxyHost=your.proxy.host
    -Dhttp.proxyPort=your.proxy.port


    The https.proxyHost and https.proxyPort properties apply to HTTPS endpoints, and the http.proxyHost and http.proxyPort properties apply to HTTP endpoints.

    Reverse proxy (inbound traffic)
    If users access WSO2 Identity Server through a reverse proxy such as Apache HTTPD or NGINX that forwards requests to the HTTPS port of WSO2 Identity Server, add the following configurations to the <IS_HOME>/repository/conf/deployment.toml file. Tomcat then uses the proxy hostname and port when it builds redirect URLs.

    [transport.https.properties]
    proxyName = "your.proxy.host"
    proxyPort = "your.proxy.port"

    WSO2 Identity Server uses the hostname configured under [server] in the URLs it generates. To set it to the proxy hostname, see Change the hostname.
    High availability
    For high availability, WSO2 Identity Server must run on a cluster. Databases used for the repository, user management, and business activity monitoring can also be configured in a cluster or can use replication management provided by the RDBMS.
    Data backup and archiving For data backup and for archiving of data, use the functionality provided by the RDBMS.