diff --git a/README.md b/README.md index dcac1d3..8dfd936 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,13 @@ The following software requirements are necessary to run the Bold Reports Enterp | Tags | OS Version | Last Modified | | ------------- | ------------- | ------------- | -| `5.3.8` | Ubuntu 20.04 (amd64) | 26/10/2023 | -| `5.3.8_alpine` | Alpine 3.13 (amd64) | 26/10/2023 | -| `5.3.8_debian` | Debian 10 (amd64,arm64) | 26/10/2023 | -|`5.3.8_arm64`|Debian 10 (arm64)|26/10/2023 | -|`5.3.8_ubuntu_arm64`| Ubuntu 20.04 (arm64) | 26/10/2023 | +| `5.4.20` | Ubuntu 20.04 (amd64) | 22/12/2023 | +| `5.4.20_alpine` | Alpine 3.13 (amd64) | 22/12/2023 | +| `5.4.20_debian` | Debian 10 (amd64,arm64) | 22/12/2023 | +|`5.4.20_arm64`|Debian 10 (arm64)|22/12/2023 | +|`5.4.20_ubuntu_arm64`| Ubuntu 20.04 (arm64) | 22/12/2023 | -Note: The tag `5.3.8_ubuntu_arm64` have some limitations where the data visualization will not be work in the exported reports. +Note: The tag `5.4.20_ubuntu_arm64` have some limitations where the data visualization will not be work in the exported reports. # How to use this image diff --git a/deploy/multiple-container/docker-compose.yml b/deploy/multiple-container/docker-compose.yml index 7fd7dbe..970e863 100644 --- a/deploy/multiple-container/docker-compose.yml +++ b/deploy/multiple-container/docker-compose.yml @@ -3,7 +3,7 @@ version: '3.5' services: id-web: container_name: id_web_container - image: gcr.io/boldreports/bold-identity:5.3.8 + image: gcr.io/boldreports/bold-identity:5.4.20 restart: on-failure environment: - APP_BASE_URL= @@ -20,7 +20,7 @@ services: id-api: container_name: id_api_container - image: gcr.io/boldreports/bold-idp-api:5.3.8 + image: gcr.io/boldreports/bold-idp-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -36,7 +36,7 @@ services: id-ums: container_name: id_ums_container - image: gcr.io/boldreports/bold-ums:5.3.8 + image: gcr.io/boldreports/bold-ums:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -52,7 +52,7 @@ services: reports-web: container_name: reports_web_container - image: gcr.io/boldreports/boldreports-server:5.3.8 + image: gcr.io/boldreports/boldreports-server:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -68,7 +68,7 @@ services: reports-api: container_name: reports_api_container - image: gcr.io/boldreports/boldreports-server-api:5.3.8 + image: gcr.io/boldreports/boldreports-server-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -85,7 +85,7 @@ services: reports-jobs: container_name: reports_jobs_container - image: gcr.io/boldreports/boldreports-server-jobs:5.3.8 + image: gcr.io/boldreports/boldreports-server-jobs:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -103,7 +103,7 @@ services: reports-reportservice: container_name: reports_reportservice_container - image: gcr.io/boldreports/boldreports-designer:5.3.8 + image: gcr.io/boldreports/boldreports-designer:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -121,7 +121,7 @@ services: reports-viewer: container_name: reports_viewer_container - image: gcr.io/boldreports/boldreports-viewer:5.3.8 + image: gcr.io/boldreports/boldreports-viewer:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data diff --git a/docs/FAQ/how-to-auto-deploy-bold-reports-multiple-services-in-docker-compose.md b/docs/FAQ/how-to-auto-deploy-bold-reports-multiple-services-in-docker-compose.md index 26676de..2244ead 100644 --- a/docs/FAQ/how-to-auto-deploy-bold-reports-multiple-services-in-docker-compose.md +++ b/docs/FAQ/how-to-auto-deploy-bold-reports-multiple-services-in-docker-compose.md @@ -19,7 +19,7 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i services: id-web: container_name: id_web_container - image: gcr.io/boldreports-294612/bold-identity:5.3.8 + image: gcr.io/boldreports/bold-identity:5.4.20 restart: on-failure environment: - APP_BASE_URL= @@ -36,7 +36,7 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i id-api: container_name: id_api_container - image: gcr.io/boldreports-294612/bold-identity-api:5.3.8 + image: gcr.io/boldreports/bold-identity-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -52,7 +52,7 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i id-ums: container_name: id_ums_container - image: gcr.io/boldreports-294612/bold-ums:5.3.8 + image: gcr.io/boldreports/bold-ums:5.4.20 restart: on-failure environment: - BOLD_SERVICES_HOSTING_ENVIRONMENT=docker @@ -79,7 +79,7 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i reports-web: container_name: reports_web_container - image: gcr.io/boldreports-294612/boldreports-server:5.3.8 + image: gcr.io/boldreports/boldreports-server:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -95,7 +95,7 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i reports-api: container_name: reports_api_container - image: gcr.io/boldreports-294612/boldreports-server-api:5.3.8 + image: gcr.io/boldreports/boldreports-server-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -112,7 +112,24 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i reports-jobs: container_name: reports_jobs_container - image: gcr.io/boldreports-294612/boldreports-server-jobs:5.3.8 + image: gcr.io/boldreports/boldreports-server-jobs:5.4.20 + restart: on-failure + volumes: + - boldservices_data:/application/app_data + networks: + - boldservices + depends_on: + - id-web + - reports-web + healthcheck: + test: ["CMD", "curl", "-f", "http://localhost/health-check"] + interval: 10s + timeout: 10s + retries: 5 + + reports-viewer: + container_name: reports_viewer_container + image: gcr.io/boldreports/boldreports-viewer:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -129,7 +146,7 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i reports-dataservice: container_name: reports_dataservice_container - image: gcr.io/boldreports-294612/boldreports-designer:5.3.8 + image: gcr.io/boldreports/boldreports-designer:5.4.20 restart: on-failure # environment: ## Refer README.md for available environment variables. # - widget_bing_map_enable=false @@ -238,7 +255,7 @@ This section allows you to deploy [Bold Reports](https://www.boldreports.com/) i |`BOLD_SERVICES_DB_TYPE` | Yes | Type of database server can 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/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_USER` | Yes | Username for the database server

Please refer to [this documentation](https://help.boldreports.com/enterprise-reporting/administrator-guide/faq/what-are-the-database-permissions-required-to-set-up-bold-reports/) 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.| diff --git a/docs/enable-puppeteer-when-upgrading-lower-to-v5.4.20.md b/docs/enable-puppeteer-when-upgrading-lower-to-v5.4.20.md new file mode 100644 index 0000000..93d799f --- /dev/null +++ b/docs/enable-puppeteer-when-upgrading-lower-to-v5.4.20.md @@ -0,0 +1,40 @@ +# Enable Puppeteer when upgrading lower version to v5.4 or higher + +> **Important:** Puppeteer are necessary to achieve `image and PDF export` functionalities in reports,schedules from Bold Reports. Without these packages, the image and PDF export options in reports and schedules will no longer be available. + +1. Navigate to the following directory in the persistent volume. + + ```sh + cd //configuration/reporting + ``` + #### Example: /home/devops/bold-reportsvolume/reporting/configuration + +2. Edit the config.xml file by using below command. + + ```sh + nano config.xml + ``` + +3. Add the following line on the config file to enable the puppeteer and save the changes. + + ```sh + + ``` + ![enable-puppteer](images/enable-puppeteer.png) + + +4. Restart the report container based on your Docker setup using given commands, + + Mulitple-Container: + + ```sh + docker restart reports_web_container reports_api_container reports_jobs_container reports_reportservice_container reports_viewer_container + ``` + + Singlecontainer: + + ```sh + docker restart + `````` + + #### Example: docker restart boldreports diff --git a/docs/how-to-use-host-path-as-persistent-volume-for-bold-reports-deployment.md b/docs/how-to-use-host-path-as-persistent-volume-for-bold-reports-deployment.md index d1c1286..e491e11 100644 --- a/docs/how-to-use-host-path-as-persistent-volume-for-bold-reports-deployment.md +++ b/docs/how-to-use-host-path-as-persistent-volume-for-bold-reports-deployment.md @@ -33,7 +33,7 @@ You can store the application data on your host machine to make the Bold Reports -e APP_URL=https://example.com \ -v D:/boldreports/app_data:/application/app_data \ -v D:/boldreports/nginx:/etc/nginx/sites-available \ - -d syncfusion/boldreports:5.3.8 + -d syncfusion/boldreports:5.4.20 ``` 2. After running the command, access the Bold Reports App by entering `APP_URL` in a browser. At this point, Bold Reports should be running in `` (as appropriate) diff --git a/docs/images/enable-puppeteer.png b/docs/images/enable-puppeteer.png new file mode 100644 index 0000000..724c3e1 Binary files /dev/null and b/docs/images/enable-puppeteer.png differ diff --git a/docs/multiple-container-podman.md b/docs/multiple-container-podman.md index 2d6c623..119b58f 100644 --- a/docs/multiple-container-podman.md +++ b/docs/multiple-container-podman.md @@ -27,7 +27,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re services: id-web: container_name: id_web_container - image: gcr.io/boldreports/bold-identity:5.3.8 + image: gcr.io/boldreports/bold-identity:5.4.20 restart: on-failure environment: - APP_BASE_URL= @@ -44,7 +44,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re id-api: container_name: id_api_container - image: gcr.io/boldreports/bold-idp-api:5.3.8 + image: gcr.io/boldreports/bold-idp-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -60,7 +60,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re id-ums: container_name: id_ums_container - image: gcr.io/boldreports/bold-ums:5.3.8 + image: gcr.io/boldreports/bold-ums:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -76,7 +76,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-web: container_name: reports_web_container - image: gcr.io/boldreports/boldreports-server:5.3.8 + image: gcr.io/boldreports/boldreports-server:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -92,7 +92,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-api: container_name: reports_api_container - image: gcr.io/boldreports/boldreports-server-api:5.3.8 + image: gcr.io/boldreports/boldreports-server-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -109,7 +109,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-jobs: container_name: reports_jobs_container - image: gcr.io/boldreports/boldreports-server-jobs:5.3.8 + image: gcr.io/boldreports/boldreports-server-jobs:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -127,7 +127,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-reportservice: container_name: reports_reportservice_container - image: gcr.io/boldreports/boldreports-designer:5.3.8 + image: gcr.io/boldreports/boldreports-designer:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -145,7 +145,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-viewer: container_name: reports_viewer_container - image: gcr.io/boldreports/boldreports-viewer:5.3.8 + image: gcr.io/boldreports/boldreports-viewer:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data diff --git a/docs/multiple-container.md b/docs/multiple-container.md index f4bf6de..9810e14 100644 --- a/docs/multiple-container.md +++ b/docs/multiple-container.md @@ -27,7 +27,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re services: id-web: container_name: id_web_container - image: gcr.io/boldreports/bold-identity:5.3.8 + image: gcr.io/boldreports/bold-identity:5.4.20 restart: on-failure environment: - APP_BASE_URL= @@ -44,7 +44,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re id-api: container_name: id_api_container - image: gcr.io/boldreports/bold-idp-api:5.3.8 + image: gcr.io/boldreports/bold-idp-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -60,7 +60,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re id-ums: container_name: id_ums_container - image: gcr.io/boldreports/bold-ums:5.3.8 + image: gcr.io/boldreports/bold-ums:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -76,7 +76,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-web: container_name: reports_web_container - image: gcr.io/boldreports/boldreports-server:5.3.8 + image: gcr.io/boldreports/boldreports-server:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -92,7 +92,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-api: container_name: reports_api_container - image: gcr.io/boldreports/boldreports-server-api:5.3.8 + image: gcr.io/boldreports/boldreports-server-api:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -109,7 +109,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-jobs: container_name: reports_jobs_container - image: gcr.io/boldreports/boldreports-server-jobs:5.3.8 + image: gcr.io/boldreports/boldreports-server-jobs:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -127,7 +127,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-reportservice: container_name: reports_reportservice_container - image: gcr.io/boldreports/boldreports-designer:5.3.8 + image: gcr.io/boldreports/boldreports-designer:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data @@ -145,7 +145,7 @@ This quick-start guide demonstrates how to use Compose to set up and run Bold Re reports-viewer: container_name: reports_viewer_container - image: gcr.io/boldreports/boldreports-viewer:5.3.8 + image: gcr.io/boldreports/boldreports-viewer:5.4.20 restart: on-failure volumes: - boldservices_data:/application/app_data diff --git a/docs/upgrade.md b/docs/upgrade.md index ebc2d36..659d74c 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -15,7 +15,7 @@ Before upgrading the Bold Reports to latest version, make sure to take the backu Bold Reports updates the database schema of your current version to the latest version. The upgrade process will retain all the resources and settings from the previous deployment. 1. If you are using the docker compose yaml file for deployment, - You can download the latest docker-compose file from this [docker-compose](https://raw.githubusercontent.com/boldreports/bold-reports-docker/v5.3.8/deploy/single-container/docker-compose.yml) and use the below command to down the containers from where you deploy the docker compose file. + You can download the latest docker-compose file from this [docker-compose](https://raw.githubusercontent.com/boldreports/bold-reports-docker/v5.4.20/deploy/single-container/docker-compose.yml) and use the below command to down the containers from where you deploy the docker compose file. ```sh docker-compose down @@ -55,18 +55,19 @@ Bold Reports updates the database schema of your current version to the latest v -d syncfusion/boldreports: ``` - #### Example: docker run --name boldreports -p 8085:80 -p 443:443 -e APP_URL="http://10.103.215.44:8085" -e OPTIONAL_LIBS="mysql,oracle,postgresql" -v "/home/Admin123/upgrade/app_data":/application/app_data -v "/home/Admin123/upgrade/nginx":/etc/nginx/sites-available -d syncfusion/boldreports:5.3.8 + #### Example: docker run --name boldreports -p 8085:80 -p 443:443 -e APP_URL="http://10.103.215.44:8085" -e OPTIONAL_LIBS="mysql,oracle,postgresql" -v "/home/Admin123/upgrade/app_data":/application/app_data -v "/home/Admin123/upgrade/nginx":/etc/nginx/sites-available -d syncfusion/boldreports:5.4.20 > **Note:** > When upgrading Bold Reports, ensure that the volume mount remains the same, and only the tag needs to be changed. > Once you run the container, please wait a couple of minutes to access the url. +After upgrading the bold reports application.Please refer [this](/docs/enable-puppeteer-when-upgrading-lower-to-v5.4.20.md) documentation for enable puppeteer. ## Proceeding with upgrade for multiple container Bold Reports updates the database schema of your current version to the latest version. The upgrade process will retain all the resources and settings from the previous deployment. -You can download the latest docker-compose file and default.conf from this [docker-compose](https://raw.githubusercontent.com/boldreports/bold-reports-docker/v5.3.8/deploy/multiple-container/docker-compose.yml) -[default.conf](https://raw.githubusercontent.com/boldreports/bold-reports-docker/v5.3.8/deploy/multiple-container/default.conf) and use the below command to down the containers from where you deploy the docker compose file. +You can download the latest docker-compose file and default.conf from this [docker-compose](https://raw.githubusercontent.com/boldreports/bold-reports-docker/v5.4.20/deploy/multiple-container/docker-compose.yml) +[default.conf](https://raw.githubusercontent.com/boldreports/bold-reports-docker/v5.4.20/deploy/multiple-container/default.conf) and use the below command to down the containers from where you deploy the docker compose file. ```sh docker-compose down @@ -78,4 +79,6 @@ And run the below command to upgrade Bold Reports. ```sh docker-compose up -d -``` \ No newline at end of file +``` + +After upgrading the bold reports application.Please refer [this](/docs/enable-puppeteer-when-upgrading-lower-to-v5.4.20.md) documentation for enable puppeteer.