Environment Variables can be used to configure the dashboard - these are especially useful for automated deployments.
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Dashboard
Variable | Description |
|---|---|
| Enable Single Sign On for the dashboard |
| Inline licence XML text |
| Link to the dashboard licence |
| Disk location of a licence file |
PI_DASHBOARD_STYLESLocation of the dashboard styles
PI_DASHBOARD_LOGO
Location of the dashboard logo
Database
Variable | Description |
|---|---|
| Database host |
| Database port |
| Database username |
| Database password |
| Maximum RAM allocated to the database |
| Schema name of the database (Default: dashboard) |
| Set to |
Tomcat
Variable | Description | Available since version |
|---|---|---|
| Dashboard | |
| Tomcat internal port (local only) (see | |
| Tomcat's administration port | |
| Tomcat AJP por | |
| Maximum memory allocated to tomcat | |
| Maximum concurrent connections to the tomcat server | |
| Connection timeout definition | |
| Maximum threads tomcat can run | |
| Minimum spare threads tomcat should keep | |
| Frame-Ancestors definition for dashboard embedding. A space separated list of | |
| X-Frame-Options setting for Dashboard. | |
| Makes tomcat use HTTPS | |
| The location of the X509 certificate to use for https | April 2021 |
| The location of the X509 certificate key file | April 2021 |
| The password of the certificate key (if set) | April 2021 |
| Must be | November 2020 |
| One of | November 2020 |
| The cookie name that is used to identify a user’s session to a particular dashboard. Defaults to | August 2021 |
Renderer
Variable | Description | Available since version |
|---|---|---|
| URL for the dashboard. Default: | |
| Internal port to run on. Default | |
| Size limit that the server accepts when | |
| Type of logger. Default | |
| Path to the directory containing the logs. Default | |
| Comma separated string with the levels to log. Valid values: | |
| Boolean field. Kill the container if it reports as unhealthy. This is for orchestrators that only monitor running/stopped states. Default | March 2021 |
Excel Reader
Variable | Description |
|---|---|
| Host to bind to. Default |
| Internal port to run on. Default |
| Access control allow origin value. Default |
| Path to the directory that holds the logfile. Default |
| Log level ( |
Scheduler
Variable | Description |
|---|---|
| Path to the directory that keeps the logs. Default: |
| Minimum log level. Default: |
| Port that the scheduler is listening on. Default: |
| Location where the key pairs are kept. Default: |
| URL to the dashboard. Default: |
Pirana
Variable | Description |
|---|
PIRANA_LOG_LEVELS
error,warn
| Host to bind to. Default |
| Internal port to run on. Default |
| Connection pool. Default |
| Path to the logfile. When left empty logs to |
| Environment type to run on. Default |
| Comma separated string with the levels to log. Default |
| Enable options below. Default |
| Path to an SSL certificate |
| Path to an SSL private key |
| Path to an SSL certificate chain |
| Seed number for the model. Default |
| Maximum model depth. Default |
| Fill strategy for missing data. Default |
Proxy
Variable | Description |
|---|---|
| Let tomcat know it's behind a proxy (this will make it know how to rewrite it's URLs) |
| One of |
| If the proxy is using https protocol (generally true) |
| Proxy host (usually the publicly accessible domain) |
| Proxy port |
These settings are only required if you want tomcat to do any URL rewriting. This is generally a good idea if you're using IIS as a reverse proxy. Nginx and Apache httpd are more than capable of doing this on their own though.