Environment Variables

Environment Variables can be used to configure the dashboard - these are especially useful for automated deployments.

Dashboard

Variable

Description

Variable

Description

PI_AUTH_SSO

Enable Single Sign On for the dashboard

PI_LICENCE

Inline licence XML text

PI_LICENCE_URL

Link to the dashboard licence

PI_LICENCE_FILE

Disk location of a licence file

PI_DASHBOARD_STYLES

Location of the dashboard styles

PI_DASHBOARD_LOGO

Location of the dashboard logo

Database

Variable

Description

Variable

Description

PI_DB_HOST

Database host

PI_DB_PORT

Database port

PI_DB_USERNAME

Database username

PI_DB_PASSWORD

Database password

PI_DB_MAX_MEMORY

Maximum RAM allocated to the database

PI_DB_SCHEMA_NAME

Schema name of the database (Default: dashboard)

PI_EXTERNAL_DB

Set to true if the database is remote or false if otherwise

Tomcat

Variable

Description

Available since version

Variable

Description

Available since version

PI_TOMCAT_PORT

Dashboard

 

PI_TOMCAT_INTERNAL_PORT

Tomcat internal port (local only) (see PI_TOMCAT_USE_HTTPS)

 

PI_TOMCAT_ADMIN_PORT

Tomcat's administration port

 

PI_TOMCAT_AJP_PORT

Tomcat AJP por

 

PI_TOMCAT_MAX_MEMORY

Maximum memory allocated to tomcat

 

PI_TOMCAT_MAX_CONNECTIONS

Maximum concurrent connections to the tomcat server

 

PI_TOMCAT_CONNECTION_TIMEOUT

Connection timeout definition

 

PI_TOMCAT_MAX_THREADS

Maximum threads tomcat can run

 

PI_TOMCAT_MIN_SPARE_THREADS

Minimum spare threads tomcat should keep

 

PI_TOMCAT_FRAME_ANCESTORS

Frame-Ancestors definition for dashboard embedding. A space separated list of scheme://host:port or one of 'none' or 'self'

 

PI_TOMCAT_X_FRAME_OPTIONS

X-Frame-Options setting for Dashboard.

 

PI_TOMCAT_USE_HTTPS

Makes tomcat use HTTPS

 

PI_TOMCAT_HTTPS_CERT

The location of the X509 certificate to use for https

April 2021

PI_TOMCAT_HTTPS_CERT_KEY

The location of the X509 certificate key file

April 2021

PI_TOMCAT_HTTPS_CERT_KEY_PASSWORD

The password of the certificate key (if set)

April 2021

PI_TOMCAT_COOKIE_SECURE

Must be true if the dashboard is somehow being served with HTTPS. Default: false. If your https is provided by an external application/layer you should also set PI_PROXY_IS_SECURE totrue .

November 2020

PI_TOMCAT_COOKIE_SAMESITE

One of nonelax or strict. Default: strict

November 2020

PI_TOMCAT_COOKIE_NAME

The cookie name that is used to identify a user’s session to a particular dashboard. Defaults to DASHBOARDSESSIONID<port> (e.g. a dashboard running on port 8224 will have its cookie as DASHBOARDSESSIONID8224.

August 2021

Renderer

Variable

Description

Available since version

Variable

Description

Available since version

RENDERER_DASHBOARD_URL

URL for the dashboard. Default: http://localhost:8224/pi

 

RENDERER_PORT

Internal port to run on. Default 9915

 

RENDERER_POST_LIMIT

Size limit that the server accepts when POSTed to. Default: 5mb

 

RENDERER_LOGGER_TYPE

Type of logger. Default tomcat

 

RENDERER_LOG_PATH

Path to the directory containing the logs. Default ../../tomcat/logs

 

RENDERER_LOG_LEVELS

Comma separated string with the levels to log. Valid values: error,info,warn,debug,verbose. Default error,warn

 

DIE_ON_UNHEALTHY

Boolean field. Kill the container if it reports as unhealthy. This is for orchestrators that only monitor running/stopped states. Default false

March 2021

Excel Reader

Variable

Description

Variable

Description

EXREAD_BIND_ADDRESS

Host to bind to. Default 0.0.0.0

EXREAD_PORT

Internal port to run on. Default 9916

EXREAD_ACCESS_CONTROL_ALLOW_ORIGIN

Access control allow origin value. Default *

EXREAD_LOG_PATH

Path to the directory that holds the logfile. Default logs/

EXREAD_LOG_LEVEL

Log level (DEBUG,INFO,WARN,ERROR). Default WARN

Scheduler

Variable

Description

Variable

Description

SCHEDULER_LOGGING_DIR

Path to the directory that keeps the logs. Default: ./logs]

SCHEDULER_LOGGING_LEVEL

Minimum log level. Default: ERROR].

SCHEDULER_PORT

Port that the scheduler is listening on. Default: 9917]

SCHEDULER_JWT_KEY_PATH

Location where the key pairs are kept. Default: ../keys]

SCHEDULER_DASHBOARD_URL

URL to the dashboard. Default: http://localhost:8224/pi]

Pirana

Variable

Description

Variable

Description

PIRANA_LOG_LEVELS

Comma separated string with the levels to log. Default error,warn

PIRANA_BIND_ADDRESS

Host to bind to. Default 0.0.0.0

PIRANA_PORT

Internal port to run on. Default 9918

PIRANA_POOL

Connection pool. Default 30

PIRANA_LOGFILE

Path to the logfile. When left empty logs to stdout

PIRANA_ENV_TYPE

Environment type to run on. Default production

PIRANA_SSL_ENABLED

Enable options below. Default false

PIRANA_SSL_CERTIFICATE

Path to an SSL certificate

PIRANA_SSL_PRIVATE_KEY

Path to an SSL private key

PIRANA_SSL_CERT_CHAIN

Path to an SSL certificate chain

PIRANA_MODEL_SEED

Seed number for the model. Default 123456789

PIRANA_MODEL_MAX_DEPTH

Maximum model depth. Default 4

PIRANA_MODEL_FILL_STRATEGY

Fill strategy for missing data. Default fill

Proxy

Variable

Description

Variable

Description

PI_PROXY_ENABLED

Let tomcat know it's behind a proxy (this will make it know how to rewrite it's URLs)

PI_PROXY_SCHEME

One of http or https

PI_PROXY_IS_SECURE

If the proxy is using https protocol (generally true)

PI_PROXY_HOST

Proxy host (usually the publicly accessible domain)

PI_PROXY_PORT

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.