Redistribution of Bold BI with Other Products on Ubuntu Linux Server
This article discusses integrating Bold BI with other applications, specifically demonstrating how to deploy Bold BI alongside WordPress on an Ubuntu Linux server. By following these instructions, you can adapt the setup to work with other products by replacing the WordPress installation steps with those specific to your application.
Prerequisites
Before you begin, make sure you have the following:
- A Linux-based server: The script is designed specifically for Ubuntu.
- Bold BI license key: Required to activate Bold BI.
Steps to Deploy Bold BI Along with Another Product or Application
Step 1: Download and Provide Access to the Automation Script
-
Start by downloading the Bash script that automates the entire installation and configuration process for Bold BI, along with your main application, to ensure a seamless setup experience.
-
To make the
install_script.sh
file executable, change its file permissions by running the following command:Command:
chmod +x install_script.sh
Step 2: Customize the Installation Script for Your Main Application
When customizing installation scripts, it may be necessary to modify them to accommodate different applications. This guide outlines the steps to adapt an installation script for your primary application, replacing the default WordPress installation process. Follow the steps below to customize the script:
-
Access and Edit the Script:
-
Open the installation script in a text editor to begin making the necessary modifications.
-
If you plan to use a different primary application, you should replace the WordPress installation steps in the script with the corresponding steps for your chosen application.
-
Replace the contents of the
install_wordpress
function with the commands necessary to install your main application.
-
-
Update the Main Function:
-
Find the reference to
install_wordpress
within the main function and replace it with the name of your main application’s installation function.
-
-
Configure Nginx:
- In the
create_wordpress_config
function, update or replace the server blocks to point to your main application’s root directory and adjust proxy settings as necessary.
Note: The line
include /etc/nginx/sites-available/boldbi;
is mandatory because it includes the configuration for Bold BI. If you modify the configuration file according to your main application’s needs, ensure that this line remains included. It ensures that Bold BI’s configuration is properly integrated into your application’s Nginx setup. - In the
-
Execute Installation Script:
-
The script installs the necessary packages for both Bold BI and WordPress. If your application requires additional packages, you can install them manually.
-
After modifying the script, you can proceed with running the installation command. This command initiates the installation process and allows you to customize the branding elements (white labeling) according to your needs. To enable white labeling and enhance the branding of your Bold BI deployment while using your own database, refer to the parameter details below and run the following command:
./install_script.sh \ --install-type new \ --user <your-username> \ --host-url <your-host-url> \ --default_config false \ --package-link <boldbi-package-link> \ --license-key <your-license-key> \ --database-type <your-database-type> \ --database-host <your-database-host> \ --database-port <your-database-port> \ --database-user <your-database-user> \ --database-password <your-database-password> \ --email <your-email> \ --email-password <your-email-password> \ --main-logo <main-logo-url> \ --login-logo <login-logo-url> \ --email-logo <email-logo-url> \ --favicon <favicon-url> \ --footer-logo <footer-logo-url> \ --site-name <your-site-name> \ --site-identifier <your-site-identifier>
Parameters Explained:
./install_script.sh
: The name of your installation script.--install-type
: Type of installation (new
for fresh installation,upgrade
for an existing installation).--user
: The user who will execute the script (e.g.,www-data
).--host-url
: The URL where Bold BI will be hosted.--default_config
: Set tofalse
if Nginx should not be installed.--package-link
: The link to download the Bold BI package.--license-key
: Your Bold BI license key.--database-type
: The type of database used (e.g.,mysql
,postgresql
,mssql
).--database-host
: The database host (default islocalhost
).--database-port
: The port number used by the database.--database-user
: The username used to access the database.--database-password
: The password for the database user.--email
: The email address used for notifications and alerts.--email-password
: The password for the email account.--main-logo
: URL of the main logo for your application.--login-logo
: URL of the logo to display on the login page.--email-logo
: URL of the logo used in email communications.--favicon
: URL of the favicon (the icon shown in browser tabs).--footer-logo
: URL of the logo that appears in the footer.--site-name
: The name of your site.--site-identifier
: A unique identifier for your site.
Example Command:
./install_script.sh \ --install-type new \ --user www-data \ --host-url http://172.191.17.104 \ --default_config false \ --package-link https://s3.amazonaws.com/files2.syncfusion.com/Installs/Bold/BoldBI/v7.10.16/BoldBIEnterpriseEdition_Linux.zip \ --license-key your-license-key \ --database-type mysql \ --database-host localhost \ --database-port 3306 \ --database-user boldbiuser \ --database-password Admin@123 \ --email demo@boldbi.com \ --email-password Admin@123 \ --main-logo https://cdn.boldbi.com/wp/pages/boldbi-header-menu-logo.svg \ --login-logo https://cdn.boldbi.com/wp/pages/boldbi-header-menu-logo.svg \ --email-logo https://cdn.boldbi.com/wp/pages/boldbi-header-menu-logo.svg \ --favicon https://cdn.boldbi.com/wp/pages/boldbi-header-menu-logo.svg \ --footer-logo https://cdn.boldbi.com/wp/pages/boldbi-header-menu-logo.svg \ --site-name bisite \ --site-identifier site1
Note: This automation script requires Sudo privileges to install the application. Please ensure that the user executing the script has the necessary Sudo permissions.
-
Step 3: Verifying the Installation and access the application.
- You can access the main application through your host URL:
http://host-url
.
- You can access the Bold BI dashboard through your host URL:
http://host-url/dashboard
.