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:
- 1.A system that complies with the Exivity minimal system requirements
- 2.The Exivity software installation executable
- 3.A valid Exivity license key
To install Exivity interactively, execute the provided setup executable. Then follow the instructions depending on your intended architecture:
To execute a silent installation the following command line parameters are supported:
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.
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:
- 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"
- 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) :
- 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.
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:
Separating web portal from backend components
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_PORTALwith the actual hostname or IP address of the system that serves as your Exivity Backend Portal.
After completing your installation, you should now be able to access your Exivity User Portal.
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:
Manage System Variables
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:
Skip proxy for certain addresses
After confirming the change, make sure to restart both the Exivity Windows Services.
In order to generate PDF documents through the Exivity API, the Chrome browser needs to be installed and the directory where
chrome.execan be found should be made available in the systems
Pathenvironmental variable. Read how to add a directory to the Path environmental variable.
Depending on your installation method
chrome.exeshould be installed in one of those directories:
Restart the Exivity API service after making these changes.