# On-Premise Installation Guide
URL: https://docs.valsight.ai/on-premise-installation-guide/
Description: The Valsight platform is a standalone server application. It is recommended to install the Valsight application on a dedicated (virtual) machine.
The Valsight platform is a standalone server application. It is recommended to install the Valsight application on a dedicated (virtual) machine.

## System requirements

The Valsight platform has the following minimum hardware and software requirements:

### Hardware

The figures below are recommendations for a server running the Valsight platform.

| Resource | Recommended                                                                                                                              |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| CPU      | x64 architecture, at least 2 GHz, 4 cores. More than 10 parallel users: 8 or more cores.                                                 |
| Memory   | Minimum 8 GB. More than 10 parallel users: at least 16 GB. Typical enterprise production deployments with complex models: 64 GB or more. |

### Software

The server requires the following software.

| Component                         | Requirement                                                                          |
| --------------------------------- | ------------------------------------------------------------------------------------ |
| Operating System                  | Debian Stable, Ubuntu LTS, SLES 12 or later. Other Linux distributions are possible. |
| Java Runtime                      | OpenJDK 21, 64-bit                                                                   |
| Model Database (production setup) | PostgreSQL 14 or later, or Microsoft SQL Server 2019 or later                        |

The Java runtime is not part of the Valsight distribution: install OpenJDK 21 yourself and point `JAVA_HOME` at it. The startup scripts check the major version and refuse to start on anything other than 21.

> **Production deployments run on Linux**
>
> Windows is not a supported operating system for production use. Non-production evaluation use is possible on Windows 11: see [Install an Evaluation Version on Windows](/install-an-evaluation-version-on-windows/).

### Client

Each user accesses the Valsight platform from a browser, which must meet the following requirements.

| Requirement       | Supported versions                                                            |
| ----------------- | ----------------------------------------------------------------------------- |
| Operating System  | Windows, Mac, Linux                                                           |
| Browser           | Google Chrome, Firefox, Edge - see [Supported Browsers](/supported-browsers/) |
| Screen Resolution | minimum 1280×800                                                              |
| Connection        | HTTPS & Secure Websockets to Valsight Cloud or On-Premise Server              |

### Intermediate proxies & loadbalancers

Any proxy or load balancer between the client and the server must meet the following requirement.

| Requirement | Recommended                  |
| ----------- | ---------------------------- |
| Websocket   | Proxy Support for Websockets |

## Installation steps

### Requirements

Install the requirements listed above on the target machine. Make sure the `JAVA_HOME` environment variable is set.

### Unpacking

Extract the supplied ZIP file (e.g. *valsight-server-7.0.14.zip*) to the desired install location, without spaces in the name. On Linux, this could be `/opt/valsight` and on Windows `C:\valsight`

### Configuration

In the *conf/* directory: copy *config.yml.default* to *config.yml* and edit the file accordingly. While the standard settings work, consider to setup a production database.

## Launching the server

The Valsight application is launched using the supplied scripts, depending on the operating system:

### Linux

Execute the script `bin/valsight-server` from the command line.

You may set up an initscript to run the service repeatedly or on system startup.

Make sure to set the service's working dir to the installation dir (and not bin/).

### Windows (Non-Production setups only)

Execute the script `bin\valsight-server.bat` from a command line or by double-clicking in Windows Explorer.

## Configuration

The Valsight application is now running on port 8080 and you can access it using a browser by entering `http://localhost:8080` into the address bar. The default username and password is "admin" and "admin".

### Adding a license file

The license file needs to be put into the main directory of the application as "*license.pem*" (i.e. at the same level as the *conf*, *lib* and *bin* folders.) Alternatively, the license can be uploaded on the first start of the server.

Opening the URL above will bring you to the configuration page (`http://localhost:8080/system/config`) after starting the server for the first time. Before using the server, you need to add a valid license file.

* In the file upload form in the upper part of the configuration dialog, select the license file which was provided to you
* Press "Update License Key" to submit the form
* The server should respond "License file uploaded successfully" and the license key information should be visible under "Current License"

![Screen Shot 2015-07-14 at 11.06.09.png](./images/5094192637.png)

### Configuring a model database

By default, the Valsight application will use a file-based internal database to store model configurations (the database files are located under `db/*.db`). For a growing production setup, it is recommended to use a dedicated database to store model configurations. The exact steps necessary will vary depending on the chosen database, but the general process is as follows:

1. Set up a supported database system
2. Create a dedicated database user for use by the Valsight application
3. Create a dedicated database and grant permissions to the user created in the previous step.
4. If using a MS SQL database ensure the setting READ\_COMMITED\_SNAPSHOT is enabled, more information can be found here <https://learn.microsoft.com/en-gb/dotnet/framework/data/adonet/sql/snapshot-isolation-in-sql-server>
5. In the Database Configuration form on the system configuration page (see above), enter the details to access your database
6. Press "Update Database Configuration" to save the configuration (it is stored in the config file `conf/config.yml`)
7. Re-start the Valsight application server to use the newly configured database. You will start with an empty database (information from the previously configured model database is not copied over).

Troubleshooting, hints & tips:

* Postgresql of many distributions is often not configured for TCP/IP access and allowance of password based authentication. Make sure that *psql -h 127.0.0.1 -U username* allows you to connect to the database.
* If you like to configure SSL, you can do so by adding the correct parameters to the JDBC string, e.g. for Postgresql extend the URL with ?ssl=true and enable SSL in the server settings.

##### conf/config.yml

```
# Excerpt from conf/config.yml#
environments:
    production:
        dataSource:
            driverClassName: org.postgresql.Driver
            sqlDialect: org.hibernate.dialect.PostgreSQLDialect

            # Alternative MSSQL:
            #   driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver
            #   sqlDialect: org.hibernate.dialect.SQLServerDialect
            #
            username:
            password:
            url: jdbc:postgresql://localhost:5432/es-rest-service
```

### Configuring an HTTPS proxy

> **Websockets**
>
> The application requires the support of websockets, please make sure that any used proxy is able to forward requests accordingly.

In a production setup, it is recommended to add HTTPS protection to the Valsight application. In a typical setup, an HTTP server such as Apache 2.0 would be set up "in front of" the Valsight application with a reverse proxy setup to port 8080. The exact steps necessary will vary depending on the chosen HTTP server, but a sample Apache 2.0 configuration could look like this:

##### /etc/apache2/sites-available/valsight.conf

```
<VirtualHost *:80>
  ServerName simulation.company.com
  Redirect permanent / https://simulation.company.com/
</VirtualHost>
NameVirtualHost *:443
<VirtualHost *:443>
  ServerName simulation.company.com

  # Reverse Proxy Settings
  ProxyPass / http://localhost:8080/
  ProxyPassReverse / http://localhost:8080/
  ProxyPreserveHost On

  # Rewrite WSS requests to WS
  RewriteCond %{HTTP:Upgrade} websocket [NC]
  RewriteRule ^/(.*)	ws://localhost:8080/$1 [P,L]

  SSLEngine on
  RequestHeader set X-Forwarded-Proto "https"
  SSLCertificateFile /etc/ssl/certs/simulation_service_https.pem
  SSLCertificateKeyFile /etc/ssl/private/simulation_service_https.key
  SSLHonorCipherOrder on
  # Enable this if you want HSTS (recommended)
  Header add Strict-Transport-Security "max-age=31536000; includeSubDomains; preload"
  BrowserMatch "MSIE [2-6]" \
    nokeepalive ssl-unclean-shutdown \
    downgrade-1.0 force-response-1.0
  # MSIE 7 and newer should be able to use keepalive
  BrowserMatch "MSIE [17-9]" ssl-unclean-shutdown
</VirtualHost>
```

## First steps

Please add at least one default data source with an empty xlsx file before using the software. See [Data Source Upload](/data-source-upload/) for the basic steps.

To get started with the software, work through [Tutorial: Build a Valsight Project](/getting-started/).

## Upgrade steps

To move an existing installation to a newer version, follow [Update / Upgrade the installation](/update-upgrade-the-installation/). Always create a database backup first.