PI_AUTH_SSO

Enable Single Sign On for the dashboard using Windows Authentication

PI_LICENCE

Inline licence file content (XML or UUID)

PI_LICENCE_URL

Link to the dashboard licence

PI_LICENCE_FILE

Disk location of a licence file

RENDERER_DASHBOARD_URL

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

PI_SYSTEM_ADMIN_TOKEN

A token created by you, min 15 chars, used as a bearer auth token in a post request to the /health endpoint to view dashboard metrics including licence & memory info

PI_EMAIL_SMTP_SERVER

The smtp server any mail will be sent via

June 24

PI_EMAIL_PORT

The smtp port

June 24

PI_EMAIL_USERNAME

The smtp username

June 24

PI_EMAIL_ADDRESS

The smtp email address (optional)

June 24

PI_EMAIL_PASSWORD

The smtp password

June 24

PI_EMAIL_SSL

Sets smtp with ssl (boolean)

June 24

PI_EMAIL_TLS

Sets smtp with tls (boolean)

June 24

PI_EMAIL_ALLOW_UNVERIFIED_CERTS

Allow unverified tls certificates (not recommended)

June 24

PI_VARIABLE_PAN_RENDERER_URL

Sets the dashboard variable PAN_RENDERER_URL

June 24

PI_VARIABLE_PAN_SCHEDULER_URL

Sets the dashboard variable PAN_SCHEDULER_URL

June 24

PI_VARIABLE_PAN_EXCEL_READER_URL

Sets the dashboard variable PAN_EXCEL_READER_URL

June 24

PI_VARIABLE_ANALYTICS_SERVER_URL

Sets the dashboard variable ANALYTICS_SERVER_URL

June 24

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

PI_DB_SKIP_MIGRATIONS

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

PI_TOMCAT_PORT

Dashboard port

PI_TOMCAT_INTERNAL_PORT

Tomcat internal port (local only) (see PI_TOMCAT_USE_HTTPS)

default 28748

PI_TOMCAT_ADMIN_PORT

Tomcat's administration port

PI_TOMCAT_AJP_PORT

Tomcat AJP port

PI_TOMCAT_MAX_MEMORY

Maximum memory allocated to tomcat, we recommend around 50-60% of the machine memory for this setting as there are a number of other memory requirements from both Tomcat and the OS.

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

PI_TOMCAT_HTTPS_CERT

The location of the X509 certificate to use for https

PI_TOMCAT_HTTPS_CERT_KEY

The location of the X509 certificate key file

PI_TOMCAT_HTTPS_CERT_KEY_PASSWORD

The password of the certificate key (if set)

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 .

PI_TOMCAT_COOKIE_SAMESITE

One of none, lax or strict. Default: strict

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.

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

PI_TOMCAT_ENABLE_SESSION_SYNC

Used to enable session sync

PI_TOMCAT_SESSION_SYNC_MODE

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

PI_TOMCAT_SESSION_SYNC_BROADCAST_PORT

Used to set the session sync broadcast port

PI_TOMCAT_SESSION_SYNC_LISTENING_PORT

Used to set the session sync listening port

PI_TOMCAT_SESSION_SYNC_REDIS_HOST

Set the redis host if session sync mode is redis

PI_TOMCAT_SESSION_SYNC_REDIS_PORT

Set the redis port if session sync mode is redis

PI_TOMCAT_SESSION_SYNC_REDIS_PASSWORD

Set the redis password if session sync mode is redis

PI_TOMCAT_USE_HSTS

Boolean field. Apply HSTS to the dashboard.

PI_TOMCAT_HSTS_INCLUDE_SUBDOMAINS

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

PI_TOMCAT_HSTS_PRELOAD

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

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.

PI_TOMCAT_USER_ACCOUNT_NAME

The name of the user account under which Tomcat should run

PI_TOMCAT_USER_ACCOUNT_PASSWORD

Password for user account set by PI_DB_USER_ACCOUNT_NAME variable

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

PI_TOMCAT_LOGGING_LOG_LEVEL

The minimum log level for Tomcat and Dashboard logs. Default setting of INFO. (Options: DEBUG, INFO, WARN, ERROR)

PI_TOMCAT_LOGGING_JSON

Log in json format. Defaults to false.

PI_TOMCAT_LOGGING_ACCESS_LOG

Log http requests. Defaults to true.

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

PI_TOMCAT_HTTPS_CERT_CHAIN

The location of the HTTPS certificate chain file

PI_TOMCAT_CIPHERS

A list of ciphers as a single string, with each cipher separated by a comma (e.g. “TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256")

Defaults to a ciphers list supported by the dashboard.

PI_TOMCAT_MONITORING_ENABLED

True to enable Java Agent to collect and export telemetry data (traces, metrics and logs) for observability and performance monitoring. Default false.

Requires PI_TOMCAT_OBSERVABILITY_EXPORTER_ENDPOINT to be defined to be able to connect.

November 2024

PI_TOMCAT_MONITORING_OTLP_EXPORTER_ENDPOINT

URL of the OTLP Exporter endpoint where telemetry data will be sent for collection and processing

November 2024

PI_TOMCAT_MONITORING_SERVICE_NAME

(Optional) Service name used for OpenTelemetry tracing. Default Dashboard.

November 2024

PI_TOMCAT_MONITORING_OTLP_EXPORTER_PROTOCOL

Protocol used by Java Agent to export telemetry data such as traces and metrics to OpenTelemetry Collector. Default http/protobuf.

November 2024