Bold BI supports the following environment variables. You can find the name of the environment variable and its usage below.
| Name | Required | Description |
|---|---|---|
APP_URL |
No Needed when configuring with domain or IP |
Domain or IP address with http/https protocol. For example, http://<public_DNS_address>http://<public_ip_address> The default APP_URL is http://localhostNote: • If you are using the IP address for the Base URL, ensure you are using the public IP of the machine instead of internal IP or local IP address. Applications can communicate with each other using the public IP alone. Host machine IP will not be accessible inside the application container. • For Docker depoyment the default APP_URL is http://localhost or http://172.17.0.1 • You can provide the HTTP or HTTPS scheme for APP_URL value. • Please refer to this section for SSL Termination. |
OPTIONAL_LIBS |
No | These are the client libraries used in Bold BI by default.'mongodb,mysql,influxdb,snowflake,oracle,clickhouse,google'Please refer Consent to deploy client libraries Libraries section to know more. |
widget_bing_map_enable |
No | If you need to use Bing Map widget feature, enable this to true.By default, this feature is set to false. |
widget_bing_map_api_key |
No | API key value for the Bing Map. |
AppSettings__CustomSizePDFExport |
No | To utilize a customized page size for A4 PDF export, set this feature to true. By default, this feature is set to false. |
AppSettings__BrowserTimezone |
No | If you need to use Browser time zone feature , enable this to true. By default, this feature is set to false. |
<host_path_for_appdata_files> |
No | Persistent volume path for the Bold BI application data |
<host_path_for_nginx_config> |
No | Persistent volume path for the Nginx configuration |
AppSettings__EnableQueryMetricsInDebugFiles |
No | If the query metrics needs to be logged in debug files, enable this to true. By default, this option is set to false. |
AppSettings__EnableQueryMetricsWithQueryInDebugFiles |
No | If the query and query metrics needs to be logged in debug files, enable this to true. By default, this option is set to false. |
BOLD_SERVICES_REVERSE_PROXY |
No | This property is used to perform HTTPS redirection correctly in Bold BI when using an External Balancer such as ALB or NLB to access Bold BI, set this to true. By default, this option is set to false. |
The following Environment variables are optional. If not provided, a manual Application Startup configuration is needed.
| Name | Required | Description |
|---|---|---|
BOLD_SERVICES_UNLOCK_KEY |
Yes | License key for activating Bold BI. Please download the offline Bold BI unlock key from the downloads page. If you don't have the download key option, please create a support ticket here. |
BOLD_SERVICES_DB_TYPE |
Yes | Type of database server can be used for configuring Bold BI. The following DB types are accepted: 1. mssql – Microsoft SQL Server/Azure SQL Database 2. postgresql – PostgreSQL Server 3. mysql – MySQL/MariaDB Server |
BOLD_SERVICES_DB_HOST |
Yes | Name of the Database Server |
BOLD_SERVICES_DB_PORT |
No | The system will use the following default port numbers based on the database server type. PostgrSQL – 5234 MySQL -3306 Please specify the port number for your database server if it is configured on a different port. For MS SQL Server, this parameter is not necessary. |
BOLD_SERVICES_DB_USER |
Yes | Username for the database server Please refer to this documentation for information on the user's permissions. |
BOLD_SERVICES_DB_PASSWORD |
Yes | The database user's password |
BOLD_SERVICES_DB_NAME |
No | If the database name is not specified, the system will create a new database called bold services. If you specify a database name, it should already exist on the server. |
BOLD_SERVICES_POSTGRESQL_MAINTENANCE_DB |
Yes | For PostgreSQL DB Servers, this is an optional parameter. The system will use the database name postgres by default.If your database server uses a different default database, please provide it here. |
BOLD_SERVICES_DB_ADDITIONAL_PARAMETERS |
No | If your database server requires additional connection string parameters, include them here. Connection string parameters can be found in the official document. My SQL: https://dev.mysql.com/doc/connector-net/en/connector-net-8-0-connection-options.html PostgreSQL: https://www.npgsql.org/doc/connection-string-parameters.html MS SQL: https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring Note: A semicolon(;) should be used to separate multiple parameters. |
BOLD_SERVICES_USER_EMAIL |
Yes | It should be a valid email. |
BOLD_SERVICES_USER_PASSWORD |
Yes | It should meet our password requirements. Note: Password must meet the following requirements. It must contain at least 6 characters, 1 uppercase character, 1 lowercase character, 1 numeric character, 1 special character |
BOLD_SERVICES_USE_SITE_IDENTIFIER |
No | The variable is optional, and the default value is TRUE. By default, all sites in Bold BI require a site identifier, which differentiates sites on the same domain. That is https://example.com/bi/site/{site_identifier} You can ignore the site identifier by setting the value as FALSE. If the site identifier is disabled, each site requires a unique domain. |
The following environment variables are optional. If they are not provided, Bold BI will use the default configured values.
| Name | Description |
| BOLD_SERVICES_BRANDING_MAIN_LOGO | This is the header logo for the application, and the preferred image size is 40 x 40 pixels. |
| BOLD_SERVICES_BRANDING_LOGIN_LOGO | This is the login logo for the application, and the preferred image size is 200 x 40 pixels. |
| BOLD_SERVICES_BRANDING_EMAIL_LOGO | This is an email logo, and the preferred image size is 200 x 40 pixels. |
| BOLD_SERVICES_BRANDING_FAVICON | This is a favicon, and the preferred image size is 40 x 40 pixels. |
| BOLD_SERVICES_BRANDING_FOOTER_LOGO |
This is powered by the logo, and the preferred size is 100 x 25 pixels.
Note: • All branding variables are accepted as URL. • Ex: https://example.com/loginlogo.jpg. • Image type: png, svg, jpg, jpeg. • If you want to use custom branding, provide the value for all branding variables. If all variable values are given, the application will use the branding images, otherwise, it will take the default logos. |
| BOLD_SERVICES_SITE_NAME |
This is organization name.
If the value is not given, the site will be deployed using the default name. |
| BOLD_SERVICES_SITE_IDENTIFIER |
This is site identifier, and it will be the part of the application URL.
If the value is not given, the site will be deployed using the default value. |
