Search results
Suggest a FeaturePDF

Auto Deployment of Bold Reports® on Linux

This section provides instructions for deploying Bold Reports® on Linux without manually activating licensing and configuring startup from the browser. It also allows customization of deployment settings using environment variables.

Deployment prerequisites

Steps Ubuntu CentOS
1 Install Nginx

sudo apt-get update

sudo apt-get install nginx
Install Nginx
2 Install zip

sudo apt-get install zip
Install zip

sudo yum install zip
3 Install GDIPlus package using the following command:

sudo apt-get install libgdiplus
Install GDIPlus package using the following command:

sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
sudo yum install epel-release
sudo yum install libgdiplus
4 Install the Python3 for ETL service by running the following command:

Ubuntu Version:22.04 : sudo apt-get install -y python3

Ubuntu Version:20.04 : sudo apt update && sudo apt install wget software-properties-common && sudo add-apt-repository ppa:deadsnakes/ppa && sudo apt update && sudo apt install python3.9
Install the Python3 for ETL service by running the following command:

sudo dnf groupinstall 'development tools' && sudo dnf install wget openssl-devel bzip2-devel libffi-devel && sudo curl https://www.python.org/ftp/python/3.9.2/Python-3.9.2.tgz -O && sudo tar -xvf Python-3.9.2.tgz && cd Python-3.9.2 && sudo ./configure --enable-optimizations && sudo make install
5 Install python pip by running the below command:

sudo apt-get install python3-pip
Install python pip by running the below command:

sudo yum -y install python3-pip
6 Install pip dependency package for ETL service by running the following command:

sudo pip install duckdb===1.1.2 dlt===0.5.4 pymysql pyodbc pg8000 poetry pandas===2.2.2 "dlt[parquet]" "dlt[filesystem]"
Install pip dependency package for ETL service by running the following command:

python3.9 -m pip install duckdb===1.1.2 dlt===0.5.4 pymysql pyodbc pg8000 poetry pandas===2.2.2 "dlt[parquet]" "dlt[filesystem]"
7 Add an openssl conf path in the environment, if does not exist.

export OPENSSL_CONF=/etc/ssl/
Add an openssl conf path in the environment, if does not exist.

export OPENSSL_CONF=/etc/ssl/

Configuring the Bold Reports® application

  1. Register and download the Bold Reports® Linux package from here.

  2. Download the Bold Reports® Linux package by running the following command:

    sudo wget {Bold Reports Linux package link}
  3. Extract the zip file by running the following command:

    sudo unzip {Bold Reports Linux package zip file}
  4. Change the directory to BoldReports_EnterpriseReporting-Linux by running the following command:

    cd BoldReports_EnterpriseReporting-Linux
  5. Execute the following command to deploy Bold Reports® on your Linux machine.

       sudo bash install-boldreports.sh -i {new} -u {user} -h {host URL} -n {true} --ssl-cert {ssl certificate path} --ssl-key {ssl key path} -databasetype {databasetype} -databasehost {Database server name} -databaseport {database port} -maintaindb {default database} -databaseuser {database username} -databasepwd {database password} -databasename {database name} -email {email address} -emailpwd {Password}

Environment Variable and It’s Usage

The following variable is necessary to configure a startup application on the backend.

Name Required Description
i Yes Installation type - Specify it as new.
u Yes Specify the user or group that manages the service. Make sure this user exists on your Linux server.
h Yes Domain or IP address of the machine with HTTP protocol.
n Yes Setting this to true will automatically configure Bold Reports® with Nginx front-end server.
ssl-cert Yes Specify the path in which the SSL certificate is present.
ssl-key Yes Specify the path in which the SSL key is present.
license No License key of Bold Reports®
databasetype Yes Type of database server to be used for configuring the Bold Reports®.
The following DB types are accepted:
1. mssql – Microsoft SQL Server/Azure SQL Database
2. postgresql – PostgreSQL Server
3. mysql – MySQL
4. Oracle
databasehost Yes Name of the Database Server
databaseport No The system will use the following default port numbers based on the database server type. PostgreSQL – 5432
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.
maintaindb No 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.
databaseuser Yes Username for the database server

Ensure that the specified database user has the necessary permissions to create and manage databases during installation.
databasepwd Yes The database user's password
databasename 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.
email Yes It should be a valid email.
emailpwd Yes Password used to create the default Bold Reports® administrator account during auto-deployment.

This password is used to log in to the Bold Reports® application and is not an email account password.
usesiteidentifier No The variable is optional, and the default value is TRUE. By default, all sites in Bold Reports® require a site identifier, which differentiates sites on the same domain. That is https://example.com/reports/site/ You can ignore the site identifier by setting the value as FALSE. If the site identifier is disabled, each site requires a unique domain.
mainlogo loginlogo emaillogo favicon footerlogo No If you want to upload the custom image as a logo of the site, you can use these variables. If this environment variable is not present, Bold Reports® will use its default logo.

Type : URL

https://cdn.boldreports.com/website/images/logo/bold-reports-logo.svg

Format : png, svg, jpg, jpeg

Note: Enter the image URL for all the variables. If the value is given to any of the variables, you must consider other variables also a required field.
sitename No If you want to customize the site name, enter the site name as a value. The default site name is Bold Reports® Enterprise Reports
siteidentifier No If you want to customize the identifier name, enter the identifier name as a value. The default identifier name is site1
optionallibs No To install the client libraries, provide the values as a comma-separated string. The client libraries used in Bold Reports® are "Oracle, PostgreSQL, Snowflake, MySQL, GoogleBigQuery and MongoDB". You need to add the names only for the libraries, which you are consenting to use with Bold Reports® application.

Example for silent installation:

sudo bash install-boldreports.sh -i new -u root -h http://linux.example.com -n true --ssl-cert /etc/ssl/domain.crt --ssl-key /etc/ssl/domain.key -databasetype postgresql -databasehost localhost -maintaindb defaultdb -databaseuser doadmin -databasepwd boldreports@123 -databasename testing -databaseport 25060 -email [email protected] -emailpwd Admin@123