Set up WSO2 clusters with Nginx¶

When setting up the WSO2 Identity Server cluster with Nginx, follow the instructions given below.

Following is the deployment diagram with the load balancer.

Configure Nginx¶

Use the following steps to configure NGINX Plus version 1.7.11 or nginx community version 1.9.2 as the load balancer for WSO2 products. (In these steps, we refer to both versions collectively as "Nginx".)

1. Install Nginx (NGINX Plus or nginx community) in a server configured in your cluster.

2. Configure Nginx to direct the HTTP requests to the two worker nodes via the HTTP 80 port using the http://is.wso2.com/> . To do this, create a VHost file ( is.http.conf ) in the /etc/nginx/conf.d directory and add the following configurations into it.

   Note

   For NGINX Open Source, the location depends on the installation method and OS. Common locations include /usr/local/nginx/conf, /etc/nginx, or /usr/local/etc/nginx.

   See NGINX docs for details.

   Click here to view a generic Nginx configuration

   ```java tab="HTTP configuration" upstream wso2.is.com { server xxx.xxx.xxx.xx3:9763; server xxx.xxx.xxx.xx4:9763; }

   server { listen 80; server_name is.wso2.com; location / { proxy_set_header X-Forwarded-Host $host; proxy_set_header X-Forwarded-Server $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host; proxy_read_timeout 5m; proxy_send_timeout 5m; proxy_pass http://wso2.is.com;

           proxy_http_version 1.1;
           proxy_set_header Upgrade $http_upgrade;
           proxy_set_header Connection "upgrade";
       }

   } ```

   Click here to view a specific configuration that exposes various endpoints

   ```java tab="Nginx configuration that exposes /oauth2, /commonauth, and other endpoints" upstream ssl.nginx.com { server xxx.xxx.xxx.xx3:9443;
   server xxx.xxx.xxx.xx4:9443
   ip_hash; }

   server { listen 443; server_name is.wso2.com;
   ssl on; ssl_certificate /home/abc/STAR_wso2is_com.crt; ssl_certificate_key /home/abc/wso2is.key;

   location /oauth2/token {
       proxy_set_header X-Forwarded-Host $host;
       proxy_set_header X-Forwarded-Server $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host;
       proxy_read_timeout 5m;
       proxy_send_timeout 5m;
   
       proxy_pass  https://ssl.nginx.com/oauth2/token ;
       proxy_redirect https://xxx.xxx.xxx.xx3:9443/oauth2/token https://is.wso2.com/oauth2/token ;
       proxy_redirect https://xxx.xxx.xxx.xx4:9443/oauth2/token https://is.wso2.com/oauth2/token ; 
   }
   
   location /commonauth {
       proxy_set_header X-Forwarded-Host $host;
       proxy_set_header X-Forwarded-Server $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host;
       proxy_read_timeout 5m;
       proxy_send_timeout 5m;
       proxy_pass https://ssl.nginx.com/commonauth;
       proxy_redirect https://xxx.xxx.xxx.xx3:9443/commonauth https://is.wso2.com/commonauth ;
       proxy_redirect https://xxx.xxx.xxx.xx4:9443/commomnauth https://is.wso2.com/commonauth;
   }
   
   location /oauth2/authorize {
       proxy_set_header X-Forwarded-Host $host;
       proxy_set_header X-Forwarded-Server $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host;
       proxy_read_timeout 5m;
       proxy_send_timeout 5m;
       proxy_pass https://ssl.nginx.com/oauth2/authorize;
       proxy_redirect https://xxx.xxx.xxx.xx3:9443/oauth2/authorize https://is.wso2.com/oauth2/authorize ;
       proxy_redirect https://xxx.xxx.xxx.xx4:9443/oauth2/authorize https://is.wso2.com/oauth2/ authorize;
   }
   
   location /authenticationendpoint/ {
       proxy_set_header X-Forwarded-Host $host;
       proxy_set_header X-Forwarded-Server $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host;
       proxy_read_timeout 5m;
       proxy_send_timeout 5m;
       proxy_pass https://ssl.nginx.com/authenticationendpoint/;
       proxy_redirect https://xxx.xxx.xxx.xx3:9443/authenticationendpoint/ https://is.wso2.com/authenticationendpoint/ ;
       proxy_redirect https://xxx.xxx.xxx.xx4:9443/authenticationendpoint https://is.wso2.com/ authenticationendpoint;
   }
   
   location /oauth2/userinfo {
       proxy_set_header X-Forwarded-Host $host;
       proxy_set_header X-Forwarded-Server $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host;
       proxy_read_timeout 5m;
       proxy_send_timeout 5m;
       proxy_pass https://ssl.nginx.com/oauth2/userinfo;
       proxy_redirect https://xxx.xxx.xxx.xx3:9443/oauth2/userinfo https://is.wso2.com/oauth2/userinfo ;
       proxy_redirect https://xxx.xxx.xxx.xx4:9443/oauth2/userinfo https://is.wso2.com/oauth2/ userinfo;
   }

   } ```

   Security Notice

   While HTTP (port 80) is demonstrated here for completeness, it is not recommended for use in production environments due to security concerns. Instead, configure HTTPS (port 443) to ensure all communication is encrypted. If HTTP must be enabled, it is advisable to use it only for redirection to HTTPS, not for transmitting sensitive data.

3. Now that you've configured HTTP requests, you must also configure HTTPS requests. Configure Nginx to direct the HTTPS requests to the two worker nodes via the HTTPS 443 port using https://is.wso2.com/ . To do this, create a VHost file ( is.https.conf ) in the /etc/nginx/conf.d directory and add the following configurations into it.

   Note

   For NGINX Open Source, the location depends on the installation method and OS. Common locations include /usr/local/nginx/conf, /etc/nginx, or /usr/local/etc/nginx.

   See NGINX docs for details.

   The configurations for nginx community version and NGINX Plus are different here since the community version does not support the sticky directive.

   ``` java tab="nginx Community Version" upstream ssl.wso2.is.com { server xxx.xxx.xxx.xx3:9443; server xxx.xxx.xxx.xx4:9443; ip_hash; }

   server { listen 443; server_name is.wso2.com; ssl on; ssl_certificate /etc/nginx/ssl/wrk.crt; ssl_certificate_key /etc/nginx/ssl/wrk.key; location / { proxy_set_header X-Forwarded-Host $host; proxy_set_header X-Forwarded-Server $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host; proxy_read_timeout 5m; proxy_send_timeout 5m; proxy_pass https://ssl.wso2.is.com;

           proxy_http_version 1.1;
           proxy_set_header Upgrade $http_upgrade;
           proxy_set_header Connection "upgrade";
       }

   } java tab="NGINX Plus" upstream ssl.wso2.is.com { server xxx.xxx.xxx.xx3:9443; server xxx.xxx.xxx.xx4:9443; sticky learn create=$upstream_cookie_jsessionid lookup=$cookie_jsessionid zone=client_sessions:1m; } server { listen 443; server_name is.wso2.com; ssl on; ssl_certificate /etc/nginx/ssl/wrk.crt; ssl_certificate_key /etc/nginx/ssl/wrk.key; location / { proxy_set_header X-Forwarded-Host $host; proxy_set_header X-Forwarded-Server $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Host $http_host; proxy_read_timeout 5m; proxy_send_timeout 5m; proxy_pass https://ssl.wso2.is.com; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; } } ```

4. Configure Nginx to access the WSO2 Identity Server Management Console as https://mgt.is.wso2.com/carbon via HTTPS 443 port. This is to direct requests to the manager node. To do this, create a VHost file ( mgt.is.https.conf ) in the /etc/nginx/conf.d directory and add the following configurations into it.

   ``` java tab="Management Console configurations" server { listen 443; server_name mgt.is.wso2.com; ssl on; ssl_certificate /etc/nginx/ssl/mgt.crt; ssl_certificate_key /etc/nginx/ssl/mgt.key;

       location / {
                  proxy_set_header X-Forwarded-Host $host;
                  proxy_set_header X-Forwarded-Server $host;
                  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                  proxy_set_header Host $http_host;
                  proxy_read_timeout 5m;
                  proxy_send_timeout 5m;
                  proxy_pass https://xxx.xxx.xxx.xx2:9443/;
   
                  proxy_http_version 1.1;
                  proxy_set_header Upgrade $http_upgrade;
                  proxy_set_header Connection "upgrade";
           }
       error_log  /var/log/nginx/mgt-error.log ;
              access_log  /var/log/nginx/mgt-access.log;
   }

   ```

5. Reload the Nginx server.
   $sudo service nginx reload

   Tip

   If you have made modifications to anything other than the VHost files, you may need to restart the Nginx server instead of reloading it.

   $sudo service nginx restart