JasperReports packaged by Bitnami

Changes in original project

We needed to email reports through the company's internal hub, which doesn't use authentication.

So, I changed this file: /7/debian-10/rootfs/opt/bitnami/scripts/libjasperreports.sh:

jasperreports_configure_smtp() {
    info "Configuring SMTP"
    jasperreports_conf_set "quartz.mail.sender.host" "$JASPERREPORTS_SMTP_HOST"
    jasperreports_conf_set "quartz.mail.sender.port" "$JASPERREPORTS_SMTP_PORT_NUMBER"
    jasperreports_conf_set "quartz.mail.sender.protocol" "$JASPERREPORTS_SMTP_PROTOCOL"
    jasperreports_conf_set "quartz.mail.sender.username" "$JASPERREPORTS_SMTP_USER"
    jasperreports_conf_set "quartz.mail.sender.password" "$JASPERREPORTS_SMTP_PASSWORD"
    jasperreports_conf_set "quartz.mail.sender.from" "$JASPERREPORTS_SMTP_FROM"       <------ CHANGED
    # We only need to configure the URL when sending reports via email, so the user gets the proper URL for accessing the report
    # Source: https://community.jaspersoft.com/documentation/tibco-jasperreports-server-installation-guide/v720/configuring-report-scheduling
    jasperreports_conf_set "quartz.web.deployment.uri" "$JASPERREPORTS_HOST"
}

jasperreports_validate() {
    [...]

    # Validate SMTP credentials
    if ! is_empty_value "$JASPERREPORTS_SMTP_HOST"; then
        for empty_env_var in "JASPERREPORTS_SMTP_USER" "JASPERREPORTS_SMTP_PASSWORD"; do
            is_empty_value "${!empty_env_var}" && warn "The ${empty_env_var} environment variable is empty or not set."
        done
        is_empty_value "$JASPERREPORTS_SMTP_PORT_NUMBER" && print_validation_error "The JASPERREPORTS_SMTP_PORT_NUMBER environment variable is empty or not set."
        ! is_empty_value "$JASPERREPORTS_SMTP_PORT_NUMBER" && check_valid_port "JASPERREPORTS_SMTP_PORT_NUMBER"
        ! is_empty_value "$JASPERREPORTS_SMTP_PROTOCOL" && check_multi_value "JASPERREPORTS_SMTP_PROTOCOL" "ssl tls smtp smtps"  <--- CHANGED
    fi

    return "$error_code"
}

jasperreports_initialize() {
    [...]

            if ! is_empty_value "$JASPERREPORTS_SMTP_HOST"; then
                # Fix that needs to be done after the installation on SMTP
                # Source: https://github.com/bitnami/bitnami-docker-jasperreports/issues/49
                # We need to use * in the XPath expressions because it is a namespaced XML but the namespace is not properly detected
                # in regular XPath experssions with namespace
                # Set mail.smtp.auth to false to enable internal hub mail sending
                xmlstarlet ed -L -u '//*[name()="prop" and @key="mail.smtp.auth"]' -v "false" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"  <--- CHANGED
                # Add a new prop node with mail.smtp.startls.enable=true
                #xmlstarlet ed -L --subnode '//*[name()="property" and @name="javaMailProperties"]/*[name()="props"]' --type elem -n "prop" -v "true" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"  <--- COMMENTED
                #xmlstarlet ed -L -i '//*[name()="prop" and not(@key)]' --type "attr" -n "key" -v "mail.smtp.starttls.enable" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"  <--- COMMENTED
            fi

      [...]
}

What is JasperReports?

JasperReports Server is a stand-alone and embeddable reporting server. It is a central information hub, with reporting and analytics that can be embedded into web and mobile applications.

Overview of JasperReports

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-jasperreports/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Warning: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Environment Variables section for a more secure deployment.

Why use Bitnami Images?

Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
With Bitnami images the latest bug fixes and features are available as soon as possible.
Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
All Bitnami images available in Docker Hub are signed with Docker Content Trust (DCT). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
Bitnami container images are released daily with the latest distribution packages available.

This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.

How to deploy JasperReports Server in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami JasperReports Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.

Supported tags and respective `Dockerfile` links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

7, 7-debian-10, 7.8.1, 7.8.1-debian-10-r89, latest (7/debian-10/Dockerfile)

Subscribe to project updates by watching the bitnami/jasperreports GitHub repo.

Get this image

The recommended way to get the Bitnami JasperReports Docker Image is to pull the prebuilt image from the Docker Hub Registry.

$ docker pull bitnami/jasperreports:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

$ docker pull bitnami/jasperreports:[TAG]

If you wish, you can also build the image yourself.

$ docker build -t bitnami/jasperreports:latest 'https://github.com/bitnami/bitnami-docker-jasperreports.git#master:7/debian-10'

How to use this image

JasperReports requires access to a MySQL or MariaDB database to store information. We'll use the Bitnami Docker Image for MariaDB for the database requirements.

Run the application using Docker Compose

The main folder of this repository contains a functional docker-compose.yml file. Run the application using it as shown below:

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-jasperreports/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Provide jasper specific file config

  ...
  jasperreports:
    image: docker.io/bitnami/jasperreports:7
    ports:
      - '80:8080'
    volumes:
      - 'jasperreports_data:/bitnami/jasperreports'
# The line below allows you to provide your own JasperReports configuration files, to be copied to WEB-INF
# - "./config:/bitnami/jasperreports-mounted-conf"
    depends_on:
      - mariadb
    environment:
      # ALLOW_EMPTY_PASSWORD is recommended only for development.
      - ALLOW_EMPTY_PASSWORD=yes
      - JASPERREPORTS_DATABASE_HOST=mariadb
      - JASPERREPORTS_DATABASE_PORT_NUMBER=3306
      - JASPERREPORTS_DATABASE_USER=bn_jasperreports
      - JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports

Using the Docker Command Line

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

Step 1: Create a network

$ docker network create jasperreports-network

Step 2: Create a volume for MariaDB persistence and create a MariaDB container

$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_jasperreports \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_jasperreports \
  --network jasperreports-network \
  --volume mariadb_data:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3: Create volumes for JasperReports persistence and launch the container

$ docker volume create --name jasperreports_data
$ docker run -d --name jasperreports \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
  --env JASPERREPORTS_DATABASE_PASSWORD=bitnami \
  --env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
  --network jasperreports-network \
  --volume jasperreports_data:/bitnami/jasperreports \
  bitnami/jasperreports:latest

Access your application at http://your-ip/

Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence, you should mount a directory at the /bitnami/jasperreports path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define the Docker volumes named mariadb_data and jasperreports_data. The JasperReports application state will persist as long as volumes are not removed.

To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml file present in this repository:

   mariadb:
     ...
     volumes:
-      - 'mariadb_data:/bitnami/mariadb'
+      - /path/to/mariadb-persistence:/bitnami/mariadb
   ...
   jasperreports:
     ...
     volumes:
-      - 'jasperreports_data:/bitnami/jasperreports'
+      - /path/to/jasperreports-persistence:/bitnami/jasperreports
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  jasperreports_data:
-    driver: local

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

Mount host directories as data volumes using the Docker command line

Step 1: Create a network (if it does not exist)

$ docker network create jasperreports-network

Step 2. Create a MariaDB container with host volume

$ docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_jasperreports \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_jasperreports \
  --network jasperreports-network \
  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3. Create the JasperReports container with host volumes

$ docker run -d --name jasperreports \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
  --env JASPERREPORTS_DATABASE_PASSWORD=bitnami \
  --env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
  --network jasperreports-network \
  --volume /path/to/jasperreports-persistence:/bitnami/jasperreports \
  bitnami/jasperreports:latest

Configuration

Environment variables

When you start the JasperReports image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

For docker-compose add the variable name and value under the application section in the docker-compose.yml file present in this repository:
```
jasperreports:
  ...
  environment:
    - JASPERREPORTS_PASSWORD=my_password
  ...
```

For manual execution add a --env option with each variable and value:

$ docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
  --env JASPERREPORTS_PASSWORD=my_password \
  --network jasperreports-tier \
  --volume /path/to/jasperreports-persistence:/bitnami \
  bitnami/jasperreports:latest

Available environment variables:

User and Site configuration

JASPERREPORTS_USERNAME: JasperReports application username. Default: jasperadmin
JASPERREPORTS_PASSWORD: JasperReports application password. Default: bitnami
JASPERREPORTS_EMAIL: JasperReports application email. Default: user@example.com
JASPERREPORTS_SKIP_BOOTSTRAP: Whether to skip performing the initial bootstrapping for the application. This is necessary in case you use a database that already has JasperReports data. Default: no

Database connection configuration

JASPERREPORTS_DATABASE_HOST: Hostname for the MariaDB or MySQL server. Default: mariadb
JASPERREPORTS_DATABASE_PORT_NUMBER: Port used by the MariaDB or MySQL server. Default: 3306
JASPERREPORTS_DATABASE_NAME: Database name that JasperReports will use to connect with the database. Default: bitnami_jasperreports
JASPERREPORTS_DATABASE_USER: Database user that JasperReports will use to connect with the database. Default: bn_jasperreports
JASPERREPORTS_DATABASE_PASSWORD: Database password that JasperReports will use to connect with the database. No default.
ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

Create a database for JasperReports using mysql-client

MYSQL_CLIENT_DATABASE_HOST: Hostname for the MariaDB or MySQL server. Default: mariadb
MYSQL_CLIENT_DATABASE_PORT_NUMBER: Port used by the MariaDB or MySQL server. Default: 3306
MYSQL_CLIENT_DATABASE_ROOT_USER: Database admin user. Default: root
MYSQL_CLIENT_DATABASE_ROOT_PASSWORD: Database password for the database admin user. No default.
MYSQL_CLIENT_CREATE_DATABASE_NAME: New database to be created by the mysql client module. No default.
MYSQL_CLIENT_CREATE_DATABASE_USER: New database user to be created by the mysql client module. No default.
MYSQL_CLIENT_CREATE_DATABASE_PASSWORD: Database password for the MYSQL_CLIENT_CREATE_DATABASE_USER user. No default.
MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET: Character set to use for the new database. No default.
MYSQL_CLIENT_CREATE_DATABASE_COLLATE: Database collation to use for the new database. No default.
MYSQL_CLIENT_ENABLE_SSL: Whether to enable SSL connections for the new database. Default: no
MYSQL_CLIENT_SSL_CA_FILE: Path to the SSL CA file for the new database. No default.
ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

SMTP Configuration

To configure JasperReports to send email using SMTP you can set the following environment variables:

JASPERREPORTS_SMTP_HOST: SMTP host.
JASPERREPORTS_SMTP_PORT_NUMBER: SMTP port.
JASPERREPORTS_SMTP_USER: SMTP account user.
JASPERREPORTS_SMTP_PASSWORD: SMTP account password.
JASPERREPORTS_SMTP_PROTOCOL: If specified, SMTP protocol to use. Allowed values: tls, ssl. No default.

JasperReports base URL configuration

JASPERREPORTS_USE_ROOT_URL: JasperReports application default URL. Default: false at http://example.com/jasperserver. http://example.com/ if true.

Examples

SMTP configuration using a Gmail account

This would be an example of SMTP configuration using a Gmail account:

Modify the docker-compose.yml file present in this repository:

  jasperreports:
    ...
    environment:
      - JASPERREPORTS_DATABASE_USER=bn_jasperreports
      - JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports
      - ALLOW_EMPTY_PASSWORD=yes
      - JASPERREPORTS_SMTP_HOST=smtp.gmail.com
      - JASPERREPORTS_SMTP_PORT_NUMBER=587
      - JASPERREPORTS_SMTP_USER=your_email@gmail.com
      - JASPERREPORTS_SMTP_PASSWORD=your_password
  ...

For manual execution:

$ docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
  --env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
  --env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
  --env JASPERREPORTS_SMTP_HOST=smtp.gmail.com \
  --env JASPERREPORTS_SMTP_PORT_NUMBER=587 \
  --env JASPERREPORTS_SMTP_USER=your_email@gmail.com \
  --env JASPERREPORTS_SMTP_PASSWORD=your_password \
  --network jasperreports-tier \
  --volume /path/to/jasperreports-persistence:/bitnami \
  bitnami/jasperreports:latest

Connect JasperReports container to an existing database

The Bitnami JasperReports container supports connecting the JasperReports application to an external database. This would be an example of using an external database for JasperReports.

Modify the docker-compose.yml file present in this repository:

   jasperreports:
     ...
     environment:
-      - JASPERREPORTS_DATABASE_HOST=mariadb
+      - JASPERREPORTS_DATABASE_HOST=mariadb_host
       - JASPERREPORTS_DATABASE_PORT_NUMBER=3306
       - JASPERREPORTS_DATABASE_NAME=jasperreports_db
       - JASPERREPORTS_DATABASE_USER=jasperreports_user
-      - ALLOW_EMPTY_PASSWORD=yes
+      - JASPERREPORTS_DATABASE_PASSWORD=jasperreports_password
     ...

For manual execution:

$ docker run -d --name jasperreports\
  -p 8080:8080 -p 8443:8443 \
  --network jasperreports-network \
  --env JASPERREPORTS_DATABASE_HOST=mariadb_host \
  --env JASPERREPORTS_DATABASE_PORT_NUMBER=3306 \
  --env JASPERREPORTS_DATABASE_NAME=jasperreports_db \
  --env JASPERREPORTS_DATABASE_USER=jasperreports_user \
  --env JASPERREPORTS_DATABASE_PASSWORD=jasperreports_password \
  --volume jasperreports_data:/bitnami/jasperreports \
  bitnami/jasperreports:latest

In case the database already contains data from a previous JasperReports installation, you need to set the variable JASPERREPORTS_SKIP_BOOTSTRAP to yes. Otherwise, the container would execute the installation wizard and could modify the existing data in the database. Note that, when setting JASPERREPORTS_SKIP_BOOTSTRAP to yes, values for environment variables such as JASPERREPORTS_USERNAME, JASPERREPORTS_PASSWORD or JASPERREPORTS_EMAIL will be ignored.

Logging

The Bitnami JasperReports Docker image sends the container logs to stdout. To view the logs:

$ docker logs jasperreports

Or using Docker Compose:

$ docker-compose logs jasperreports

You can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Maintenance

Backing up your container

To backup your data, configuration and logs, follow these simple steps:

Step 1: Stop the currently running container

$ docker stop jasperreports

Or using Docker Compose:

$ docker-compose stop jasperreports

Step 2: Run the backup command

We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.

$ docker run --rm -v /path/to/jasperreports-backups:/backups --volumes-from jasperreports bitnami/minideb \
  cp -a /bitnami/jasperreports /backups/latest

Restoring a backup

Restoring a backup is as simple as mounting the backup as volumes in the containers.

For the MariaDB database container:

 $ docker run -d --name mariadb \
   ...
-  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+  --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
   bitnami/mariadb:latest

For the JasperReports container:

 $ docker run -d --name jasperreports \
   ...
-  --volume /path/to/jasperreports-persistence:/bitnami/jasperreports \
+  --volume /path/to/jasperreports-backups/latest:/bitnami/jasperreports \
   bitnami/jasperreports:latest

Upgrade this image

Bitnami provides up-to-date versions of MariaDB and JasperReports, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the JasperReports container. For the MariaDB upgrade see: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

The bitnami/jasperreports:latest tag always points to the most recent release. To get the most recent release you can simple repull the latest tag from the Docker Hub with docker pull bitnami/jasperreports:latest. However it is recommended to use tagged versions.

Step 1: Get the updated image

$ docker pull bitnami/jasperreports:latest

Step 2: Stop the running container

Stop the currently running container using the command

$ docker-compose stop jasperreports

Step 3: Take a snapshot of the application state

Follow the steps in Backing up your container to take a snapshot of the current application state.

Step 4: Remove the currently running container

Remove the currently running container by executing the following command:

docker-compose rm -v jasperreports

Step 5: Run the new image

Update the image tag in docker-compose.yml and re-create your container with the new image:

$ docker-compose up -d

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. Be sure to include the following information in your issue:

Host OS and version
Docker version (docker version)
Output of docker info
Version of this container
The command you used to run the container, and any relevant output you saw (masking any sensitive information)

Community supported solution

Please, note this asset is a community-supported solution. This means that the Bitnami team is not actively working on new features/improvements nor providing support through GitHub Issues. Any new issue will stay open for 20 days to allow the community to contribute, after 15 days without activity the issue will be marked as stale being closed after 5 days.

The Bitnami team will review any PR that is created, feel free to create a PR if you find any issue or want to implement a new feature.

New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.

Notable Changes

7.8.0-debian-10-r275

The size of the container image has been reduced.
The configuration logic is now based on Bash scripts in the rootfs/ folder.
The container has been migrated to a non-root user approach. Previously the container ran as the root user and the Tomcat daemon was started as the tomcat user. From now on, both the container and the Tomcat daemon run as user 1001. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing USER 1001 to USER root in the Dockerfile.

7.2.0-debian-10-r64

Java distribution has been migrated from AdoptOpenJDK to OpenJDK Liberica. As part of VMware, we have an agreement with Bell Software to distribute the Liberica distribution of OpenJDK. That way, we can provide support & the latest versions and security releases for Java.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

victorouttes/bitnami-docker-jasperreports