Environment Variables

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

Server / Dashboard

These should be used to configure the dashboard application and are set against the dashboard or “server” container in containerised deployments.

Dashboard settings

Variable

Description

Version Introduced

Variable

Description

Version Introduced

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

Repository Database configration

Variable

Description

Version Introduced

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