boldreports-server-in-docker/docs/multiple-container-podman.md at master · boldreports/boldreports-server-in-docker

Run multiple services `Bold Reports` via `podman-compose`

This quick-start guide demonstrates how to use Compose to set up and run Bold Reports. Before starting, make sure you have Compose installed

Define the Project

Create an empty project directory.
You can name the directory something easy for you to remember. This directory is the context for your application image. This project directory should contains a docker-compose.yml file which is complete in itself for a good starter BoldReports project.
Download the configuration files here. This directory includes docker-compose YML file and configuration file for Nginx.

Tip: You can use either a .yml or .yaml extension for this file. They both works well.
Change into your project directory. For example, if you named your directory my_boldreports
```
$  cd my_boldreports/
```

Create a docker-compose.yml file that starts your BoldReports and a separate PostgreSQL instance with volume mounts for data persistence:

 services:
   id-web:
     container_name: id_web_container
     image: us-docker.pkg.dev/boldreports/multi-container/bold-identity:14.1.12
     restart: on-failure
     environment: 
       # Required
       - APP_BASE_URL=<app_base_url>                      # Set the Application base URL or the machine IP of external DNS to access the site. For example: https://example.com or http://172.174.25.9 or http://host.docker.internal
       # Optional: Uncomment the line below, if you want to use the client libraries.
       #  - INSTALL_OPTIONAL_LIBS=mysql,oracle,postgresql,snowflake,googlebigquery,mongodb
       - DEPLOY_MODE=docker_multi_container
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5
         
   id-api:
     container_name: id_api_container
     image: us-docker.pkg.dev/boldreports/multi-container/bold-idp-api:14.1.12
     restart: on-failure
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5
         
   id-ums:
     container_name: id_ums_container
     image: us-docker.pkg.dev/boldreports/multi-container/bold-ums:14.1.12
     restart: on-failure
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5
         
   reports-web:
     container_name: reports_web_container
     image: us-docker.pkg.dev/boldreports/multi-container/boldreports-server:14.1.12
     restart: on-failure
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5
         
   reports-api:
     container_name: reports_api_container
     image: us-docker.pkg.dev/boldreports/multi-container/boldreports-server-api:14.1.12
     restart: on-failure
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
       reports-web
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5
       
   reports-jobs:
     container_name: reports_jobs_container
     image: us-docker.pkg.dev/boldreports/multi-container/boldreports-server-jobs:14.1.12
     restart: on-failure
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
       reports-web
         condition: service_healthy
       reports-api
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5
       
   reports-reportservice:
     container_name: reports_reportservice_container
     image: us-docker.pkg.dev/boldreports/multi-container/boldreports-designer:14.1.12
     restart: on-failure
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
       reports-web
         condition: service_healthy
       reports-api
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5

   reports-viewer:
     container_name: reports_viewer_container
     image: us-docker.pkg.dev/boldreports/multi-container/boldreports-viewer:14.1.12
     restart: on-failure
     volumes: 
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
       reports-web
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5

   reports-etl:
     container_name: reports_etl_container
     image: us-docker.pkg.dev/boldreports/multi-container/bold-etl:14.1.12
     restart: on-failure
     volumes:
       - boldservices_data:/application/app_data
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
       reports-web
         condition: service_healthy
     healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost/health-check"]
         interval: 10s
         timeout: 10s
         retries: 5
         
   reverse-proxy:
     container_name: nginx
     image: nginx
     restart: on-failure
     volumes:
       -   "<default_conf_path>:/etc/nginx/conf.d/default.conf"          # Set the default.conf file path.
       # Uncomment the lines below, if you want to configure the SSL.
       # - "<ssl_cert_file_path>:/etc/ssl/domain.crt"
       # - "<ssl_key_file_path>:/etc/ssl/domain.key"
     ports:
       - "80:80"
       # - "443:443"
     environment:
       - NGINX_PORT=80
     networks:
       - boldservices
     depends_on:
       id-web
         condition: service_healthy
       id-api
         condition: service_healthy
       id-ums
         condition: service_healthy
       reports-web
         condition: service_healthy
       reports-api
         condition: service_healthy
       reports-jobs
         condition: service_healthy
       reports-reportservice
         condition: service_healthy
       reports-viewer
         condition: service_healthy
       reports-etl
         condition: service_healthy
   pgdb:
     image: postgres:17
     restart: always
     environment:
       POSTGRES_PASSWORD: <Password>              # Set the password for the PostgreSQL database that will be deployed along with this Bold Reports deployment.
     volumes:
       - db_data:/var/lib/postgresql/data/
     networks:
       - boldservices

 networks:
   boldservices: 
   
 volumes:
   boldservices_data:
     driver: local
     driver_opts:
       type: 'none'
       o: 'bind'
       device: '<host_path_boldservices_data>'     # Set the path for storing the data of the bold reports.
   db_data:
     driver: local
     driver_opts:
       type: 'none'
       o: 'bind'
       device: '<host_path_db_data>'               # Set the path for the docker PostgreSQL database data to be stored.

Replace <app_base_url> with your DNS or IP address, by which you want to access the application.

For example,
http://example.com
https://example.com
http://<public_ip_address>
http://host.docker.internal
Note:
- If you are using the IP address for the Base URL, make sure 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.
- Provide the HTTP or HTTPS scheme for APP_BASE_URL value.
You can also change the Port number other than 80
Provide the default.conf file path, which you have downloaded earlier in <default_conf_path> place.

For example,
"./default.conf:/etc/nginx/conf.d/default.conf"
"D:/boldreports/docker/default.conf":"/etc/nginx/conf.d/default.conf"
"/var/boldreports/docker/default.conf:/etc/nginx/conf.d/default.conf"
Allocate a directory in your host machine to store the shared folders for applications’ usage. Replace the directory path with <host_path_boldservices_data> and <host_path_db_data> in docker-compose.yml file.

For example,
Windows: device: 'D:/boldreports/boldservices_data' and device: 'D:/boldreports/db_data'
Linux: device: '/var/boldreports/boldservices_data' and device: '/var/boldreports/db_data'

Note: The docker volumes boldservices_data and db_data persists data of Bold Reports and PostgreSQL respectively. Learn more about podman volumes

Build the project

Now, run podman-compose up -d from your project directory.

This runs podman-compose up in detached mode, pulls the needed Docker images, and starts the boldreports and database containers, as shown in the example below.

Bring up BoldReports in a web browser

At this point, BoldReports should be running in <app_base_url> (as appropriate)

Note: The BoldReports site is not immediately available on port 80 because the containers are still being initialized and may take a couple of minutes before the first load.

Application Startup

Configure the Bold Reports On-Premise application startup to use the application. Please refer the following link for more details on configuring the application startup.

https://help.boldreports.com/enterprise-reporting/administrator-guide/application-startup/

Note: To use the above configured PostgreSQL server in Bold Reports please use pgdb as the PostgreSQL server name.

Shutdown and cleanup

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

The command podman volume rm <volume_name> removes the containers, default network, and all the volumes.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Run multiple services `Bold Reports` via `podman-compose`

Define the Project

Build the project

Bring up BoldReports in a web browser

Application Startup

Shutdown and cleanup

Uh oh!

FilesExpand file tree

multiple-container-podman.md

Latest commit

History

multiple-container-podman.md

File metadata and controls

Run multiple services Bold Reports via podman-compose

Define the Project

Build the project

Bring up BoldReports in a web browser

Application Startup

Shutdown and cleanup

Run multiple services `Bold Reports` via `podman-compose`