Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Variable

Description

Version Introduced

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

PI_DB_USER_ACCOUNT_NAME

The name of the user account under which Database should run

PI_DB_USER_ACCOUNT_PASSWORD

Password for user account set by PI_DB_USER_ACCOUNT_NAME variable

PI_DB_USE_SSL

Set to true if the database is configured to use ssl or false if otherwise

PI_DB_IS_MYSQL

Set to true if the database is MySQL 8

March 2024

PI_DB_SKIP_MIGRATIONS

Set to true if you want to stop migrations from running upon startup

April 2024

Tomcat settings

Variable

Description

Version Introduced

PI_TOMCAT_PORT

Dashboard port

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 port

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 (this is only for Internet Explorer. Chrome, Edge, Mozilla, and other modern browsers would use Frame-Ancestors).

PI_TOMCAT_USE_HTTPS

Makes tomcat use HTTPS

April 2021

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

PI_TOMCAT_MAX_TOTAL_DB_CONNECTIONS

Maximum number of connections to the dashboard’s own database. Default: 150 - updated from 15 to 150 in the February 23 release

March 2022

PI_TOMCAT_ENABLE_SESSION_SYNC

Used to enable session sync

March 2022

PI_TOMCAT_SESSION_SYNC_MODE

Choose either Tomcat session sync (tcp) or Redis session offload (redis)

October 2023

PI_TOMCAT_SESSION_SYNC_BROADCAST_PORT

Used to set the session sync broadcast port

March 2022

PI_TOMCAT_SESSION_SYNC_LISTENING_PORT

Used to set the session sync listening port

March 2022

PI_TOMCAT_SESSION_SYNC_REDIS_HOST

Set the redis host if session sync mode is redis

October 2023

PI_TOMCAT_SESSION_SYNC_REDIS_PORT

Set the redis port if session sync mode is redis

October 2023

PI_TOMCAT_SESSION_SYNC_REDIS_PASSWORD

Set the redis password if session sync mode is redis

October 2023

PI_TOMCAT_USE_HSTS

Boolean field. Apply HSTS to the dashboard.

July 2022

PI_TOMCAT_HSTS_INCLUDE_SUBDOMAINS

Boolean field. Applies HSTS to all subdomains of your site.

July 2022

PI_TOMCAT_HSTS_PRELOAD

Boolean field. Enables HSTS preload header, meaning browsers will never connect to your domain using an insecure connection.

Info

You should only enable preload if you are confident your entire site and all of its subdomains can be served over HTTPS. Once on the HSTS preload list, it can take several months to remove your site if needed.

July 2022

PI_TOMCAT_HSTS_MAX_AGE

The amount of time in seconds that the browser should remember that the site is only to be accessed using HTTPS. Default setting of 31536000.

July 2022

PI_TOMCAT_USER_ACCOUNT_NAME

The name of the user account under which Tomcat should run

January 2023

PI_TOMCAT_USER_ACCOUNT_PASSWORD

Password for user account set by PI_DB_USER_ACCOUNT_NAME variable

January 2023

PI_TOMCAT_LOGGING_MAX_AGE

The amount of time (in days) to retain rotated log files.

Default setting of 0. A value of 0 disables automated log removal

October 2023

PI_TOMCAT_LOGGING_LOG

The minimum log level for Tomcat and Dashboard logs. Default setting of INFO.

November 2023

PI_TOMCAT_COOKIE_PARTITIONED

Set to true by default, determine whether cookies will be partitioned, currently incompatible with open id pop up login via an iFrame

February 2024

...