Exivity can be installed in your on-premises data center using the provided installer. You can automatically deploy it using the silent installation command-line options or execute it as an interactive installer.
To install Exivity, you'll need the following:
- A system that complies with the Exivity minimal system requirements
- The Exivity software installation executable
- A valid Exivity license key
If you need help meeting one or more of the above requirements, please get in contact with our support department.
To install Exivity interactively, execute the provided setup executable. Then follow the instructions depending on your intended architecture:
Silent installation is only recommended for experienced users requiring automated deployments
To execute a silent installation the following command line parameters are supported:
|/EXIVITY_PROGRAM_PATH||Path to Exivity program files||C:\Exivity\program|
|/EXIVITY_HOME_PATH||Path to Exivity home files||C:\Exiivty\home|
|/ADMIN_USER||Exivity admin user||admin|
|/ADMIN_PASSWORD||Exivity admin password||exivity|
|/PGHOST||Hostname for PostgreSQL server||localhost|
|/PGPORT||Port of PostgreSQL server||5432|
|/PGSSLMODE||Disable or require PostgreSQL SSL communication||disable|
|/PGDATABASE||Exivity database on PostgreSQL server||exdb|
|/PGDATA||Location of PostgreSQL data files (only used when installing local database instance)||<exivity_home>\system\pgdata|
|/PSQL_INSTALLED||1 (install locally) or 0 (do not install)||1|
|/PROXIMITYHOST||Remote API hostname (required when installing Web component only)||localhost|
|/PROXIMITYPORT||Remote API port (required when installing Web component only)||8002|
|/API_INSTALLED||1 (install locally) or 0 (do not install)||1|
|/SCHEDULER_INSTALLED||1 (install locally) or 0 (do not install)||1|
|/BACKEND_INSTALLED||1 (install locally) or 0 (do not install)||1|
|/JOBMAN_INSTALLED||1 (install locally) or 0 (do not install)||1|
|/MQ_INSTALLED||1 (install locally) or 0 (do not install)||1|
|/MQPORT||RabbitMQ port number||5672|
|/MQSSL||MQ SSL/TLS enabled (1) or disabled (0)||0|
|/MQUSER||RabbitMQ user account||guest|
|/MQVHOST||RabbitMQ virtual host||/|
Example to install using all defaults:
Example to install using the custom path and Exivity admin user:
<setup>.exe /S /EXIVITY_PROGRAM_PATH="C:\Program Files\Exivity\program" /EXIVITY_HOME_PATH=D:\Exivity\home /ADMIN_USER=master /[email protected]
Updating minor versions
Updating your installation of Exivity to a more recent minor and/or bugfix release (i.e. 3.x.x --> 3.x.x) is straightforward and may be done by installing the new version over the top of the old.
Execute the setup executable. It will detect the installed version of Exivity, and will automatically upgrade when you click
<setup>.exe /S, your existing installation will be automatically upgraded.
Upgrading major versions
When upgrading to a more recent major version (i.e. 2.10.2 --> 3.x.x) consult first the release notes to verify any breaking changes that may apply to your installation.
Installing a valid SSL certificate
Exivity comes as standard with an untrusted self-signed SSL certificate. It is therefore highly recommended to replace the default certificate with an official one, signed by your Certificate Authority. To install a signed certificate, follow this procedure:
- Download the 32 bit version of openssl.exe from https://slproweb.com/products/Win32OpenSSL.html, and install this tool on the Exivity server
- Use the openssl.exe executable to generate a valid key file on the Exivity server by executing the following command:
openssl.exe genrsa -out exivity.key 4096
- Run the following command to create a certificate signing request file:
openssl.exe req -new -key exivity.key -out exivity.csr -addext "subjectAltName = DNS:example.com"
example.com in the command above with the FQDN of the Exivity server.
- You will be asked to enter general information like company name, city, etc. It is important to include the FQDN of the Exivity server when asked for
Common Name (e.g. server FQDN or YOUR name) :
NOTE: ** when asked, it is required to not** provide a password (leave this field empty and press return), otherwise the Exivity application will not be able to use your certificate.
- The generated CSR file should be sent to your Certificate Authority. After processing by your CA, you should receive back a .crt file. Rename this file to webcertificate.crt and rename your exivity.key to webcertificate.key and copy it to the directory
%EXIVITY_PROGRAM_PATH%\server\nginx\conf. This should overwrite the existing .key and .crt files.
- Restart the
Exivity Web ServiceWindows service to activate your signed certificate.
Configuring a separate web server portal
In some environments it may be desirable to separate the webserver from the backend components. This can be achieved by installing two separate Exivity instances. One instance could be placed in a DMZ and the second instance would then typically be deployed within a local network as shown in the following diagram:
To achieve this, first install Exivity on the backend node using the standard procedure described here. Afterwards install the Exivity software on the system that should become the User Portal and only install the Web Component. When asked, specify the API Backend hostname and port to finalize the installation.
Make sure to replace
HOSTNAME_BACKEND_PORTAL with the actual hostname or IP address of the system that serves as your Exivity Backend Portal.
When using SAML2 as an authentication mechanism for Single Sign On, and users also connect to a User Portal, take special attention to the
X-Forwarded-Port in the Nginx webproxy.conf. These are required when the User Portal is served on a different port (i.e. 443) compared to the backend portal API (i.e. 8002). When this is the case, the forwarded port needs to match the port number of the user portal.
After completing your installation, you should now be able to access your Exivity User Portal.
Using an Internet proxy when extracting data
In cases where Exivity instance requires internet connectivity (i.e. to obtain Azure or AWS consumption data), and your network infrastructure requires use of a proxy server, it is necessary to configure a system environment variable.
Right click on This PC in an Explorer Window and click on Properties:
Then go to Advanced System Settings, then click the Environment Variables button:
Now add a new System Variable with the name ALL_PROXY and fill in the address of your proxy server as the value for this variable:
In case you do not want to use the proxy for certain address or domains, it is also possible to add an additional variable NO_PROXY:
If the name in the noproxy list has a leading period, it is a domain match against the provided host name. This way ".example.com" will switch off proxy use for both "www.example.com" as well as for "foo.example.com".
After confirming the change, make sure to restart both the Exivity Windows Services.
Increase limit of filesize upload in the API
By default, Exivity API has a limit of 2048kb for filesize uploading, should you require to increase it, please modify the file located in %EXIVITY_PROGRAM_PATH%\server\php\php.ini
Adjust the variables post_max_size and upload_max_filesize to your desired value.
Enable PDF report exports
In order to generate PDF documents through the Exivity API, the Chrome browser needs to be installed and the directory where
chrome.exe can be found should be made available in the systems
Path environmental variable. Read how to add a directory to the Path environmental variable.
Depending on your installation method
chrome.exe should be installed in one of those directories:
To prevent server overload, generating PDF reports through the API is limited to take 1 minute. Very large reports (e.g. consolidated reports with instance details) may take more time and result in an API error. If that's the case, try generating reports for single accounts or without instance details.
Restart the Exivity API service after making these changes.