how-to-deploy-bold-bi-using-existing-db-server.md

How to deploy Bold BI using existing DB server?

In the following section, we are going to run the Bold BI application by passing the application startup backend configuration environment variable using the existing DB server details.

1. Download docker compose file using the following command.

   curl -o docker-compose.yml "https://raw.githubusercontent.com/boldbi/boldbi-docker/main/deploy/single-container-with-env-variable/docker-compose.yml"

2. Open the docker compose file and fill the mandatory fields - Unlock Key and Database details

   

   Environment variable Usage:

   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

3. Run docker compose up command.

   docker-compose up -d

   

   Note: The docker volumes boldservices_data persists data of Bold BI. Learn more about docker volumes

4. Now, access the Bold BI application by entering the URL as http://localhost:8085 or http://host-ip:8085 in the browser. When opening this URL in the browser, it will configure the application startup in the background and display the page below within a few seconds. The default port number mentioned in the compose file is 8085. If you are making changes to the port number, then you need to use that port number for accessing the Bold BI application.

   

   Note:
   1. The deployment steps above are recommended for evaluation purposes only. For a production use case, you will need to mount the volume to the host path location or online storage and utilize managed DB servers.
   2. Don't use localhost IP (http://127.0.0.1) with port to access the application.

Shutdown and Cleanup

The command docker-compose down removes the containers and default network, but preserves the volumes of Bold BI and PostgreSQL.

The command docker-compose down --volumes removes the containers, default network, and all the volumes.