Customers
User information
 Loading ...
Show article in Knowledge Base

 How do I install and configure a proxy server with VisionProject? Export knowledge base Export     SubscribeSubscribe      Show article info


A proxy server is needed if you want to run VisionProject in a clustered environment or if you want to enable the chat module.

 

The proxy server supported by VisionProject is Nginx even though other proxy servers can also be used if you have experience of these and know how to configure them yourself. 

 

NOTE!  It is assumed that Nginx is not installed otherwise make sure to backup configuration files etc. before starting the installation

 

NOTE!  It is assumed that VisionProject is deployed in webapps\ROOT of the Tomcat installation. 

 

Nginx will run on port 80 (and 443 if using HTTPS) so any other service using this port need to be stopped or reconfigured.

 

 

 Install Nginx.

  • (Linux). sudo apt-get install nginx  

  • (Windows). Download and unzip the latest stable relase of Nginx from http://nginx.org/en/download.html to a directory of your choice. 

 

 

 

1.a Windows

 

(We denote nginx_root as the directory where Nginx is installed). 

 

  •  Copy all files in in the folder (from VisionProject webapp in tomcat) WEB-INF/internal_docs/installed version/configuration/clustered/nginx/windows/conf to nginx_root/conf. Note! This will replace the original nginx.conf. 
  • (Windows) copy VisionProject_proxy.exe and VisionProject_proxy.xml (in the same directory) to nginx_root (example c:\nginx\).
  • Edit nginx_root/conf/nodes_normal.conf so the root path matches the path to the VisionProject webapp to one tomcat instance (example c:/tomcat6030/webapps/ROOT). Also change port in the same file if needed. If you are running Tomcat clustered uncomment #iphash and the second server. Paths in a configuration file must be specified in UNIX-style using forward slashes.
    Note if you you are not supporting HTTPS you can remove the second server configuration from nginx_root/conf/nginx.conf (the one that listen on 443) otherwise Nginx will not start until HTTPS is configured (see configure HTTPS below).

 

 

1.b Linux

 

(We denote nginx_root as the directory where Nginx is installed. Typically /etc/nginx). 

 

  •  Copy all files in in the folder (from VisionProject webapp in tomcat) WEB-INF/internal_docs/installed version/configuration/clustered/nginx/ubuntu/ to nginx_root/
  •  Edit nginx_root/conf/nodes_normal.conf so the root path matches the path to the VisionProject webapp to one tomcat instance (example /var/lib/tomcat7/ROOT)

 

 Install Nginx as a service (Optional)

 

(Only applies to Windows)

  • Edit nginx_root/VisionProject_proxy.xml to match the path of your nginx installation. 
  • From a command prompt execute the command: nginx_root\VisionProject_proxy.exe install (example c:\nginx\VisionProject_proxy.exe install).

 

 

 

  Configure HTTPS  (Optional)

 

This step is optional or can be configured in later stage. Make sure to comment out (or remove) the HTTPS server configuration from  

       nginx_root/conf/nginx.conf (Windows)

      nginx_root/VisionProject.conf (linux

 if you are leaving out this part.

 

Nginx expects certificates in the PEM format. If you don't have the certificate in PEM format you need to export the private key and certificates from the keystore. This Tool will help you with the export.

 

Note!:When using https it is important to add <Valve className="org.apache.catalina.valves.RemoteIpValve" protocolHeader="X-Forwarded-Proto"  protocolHeaderHttpsValue="https" />      

to server.xml in tomcat. If you use tomcat on a seperate server from nginx you will need to add internal proxies on the element as well. See tomcat documentaion for more information. 

 

 

3.a. When you have the certificate - Windows:

 

  • Copy the certificate and private key to nginx_root/conf/ (example c:\nginx\conf).
  • In nginx_root/conf/nginx.conf. Change ssl_certificate property to name of your crt file 
    and also change ssl_certificate_key property to the name of your key file.

 

3.b When you have the certificate - Linux:

 

  • Copy the certificate and private key to nginx_root/.
  • In nginx_root/sites-enabled/VisionProject.conf. Change ssl_certificate property to name of your crt file 
    and also change ssl_certificate_key property to the name of your key file.

 

Knowledge Base Images/Icons/number_4_blue.gif Change maximum file size, for document upload

 

Add the row below into the nginx_root/conf/nginx.conf file to allow for file sizes > 1 MB:

 

client_max_body_size 1000m; 

 

(This should be added below the the HTTP section in the file)

 

In addition to this you also need to make the appropriate changes to the struts-config-xml file, see more information about this here...

 

Knowledge Base Images/Icons/number_5_blue.gif Verify

       (Linux). Start or restart the service nginx.  

       (Windows). If installed as a service run the service otherwise run nginx_root/nginx.exe


User comments
 Loading ...