containers/bitnami/jasperreports

What is JasperReports?

The JasperReports server can be used as a stand-alone or embedded reporting and BI server that offers web-based reporting, analytic tools and visualization, and a dashboard feature for compiling multiple custom views. JasperReports supports multiple data sources including Hadoop Hive, JSON data sources, Excel, XML/A, Hibernate and more. You can create reports with their WYSIWYG tool and build beautiful visualizations, charts and graphs.

http://community.jaspersoft.com/project/jasperreports-server

TL;DR;

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

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.
• Bitnami images are built on CircleCI and automatically pushed to the Docker Hub.
• 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.

Prerequisites

To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later.

How to use this image

Run the application using Docker Compose

This is the recommended way to run JasperReports. You can use the following docker compose template:

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - mariadb_data:/bitnami/mariadb
  jasperreports:
    image: bitnami/jasperreports:latest
    depends_on:
      - mariadb
    ports:
      - '80:8080'
      - '443:8443'
    volumes:
      - jasperreports_data:/bitnami/jasperreports

volumes:
  mariadb_data:
    driver: local
  jasperreports_data:
    driver: local

Then you can access your application at http://your-ip/. Enter bitnami default username and password: user/ bitnami

Run the application manually

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

1. Create a new network for the application:

$ docker network create jasperreports-tier

2. Run the JasperReports container:

$ docker run -d -p 80:8080 --name jasperreports --net=jasperreports-tier bitnami/jasperreports

Then you can access your application at http://your-ip/. Enter bitnami default username and password: user/ bitnami

Note! If you are using Docker for Windows (regardless of running the application using Docker compose or manually) you must check the Docker virtual machine IP executing this command:

docker-machine ip

This IP address allowing you to access to your application.

Persisting your application

If you remove every container and volume all your data will be lost, and the next time you run the image the application 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 of the JasperReports deployment, the above examples define docker volumes namely tomcat_data and jasperreports_data. The JasperReports application state will persist as long as these volumes are not removed.

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

Note! If you have already started using your application, follow the steps on backing up to pull the data from your running container down to your host.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml template previously shown:

version: '2'
services:
  mariadb: bitnami/mariadb:latest
  volumes:
    - /path/to/mariadb-persistence:/bitnami/mariadb
jasperreports:
  image: bitnami/jasperreports:latest
  depends_on:
    - mariadb
  ports:
    - 80:8080
  volumes:
    - /path/to/jasperreports-persistence:/bitnami/jasperreports

Mount persistent folders manually

In this case you need to specify the directories to mount on the run command. The process is the same than the one previously shown:

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

$ docker network create jasperreports-tier

2. Create a MariaDB container with host volume:

$ docker run -d --name mariadb -e ALLOW_EMPTY_PASSWORD=yes \
  --net jasperreports-tier \
  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
 bitnami/mariadb:latest

3. Create the JasperReports container with host volume:

$  docker run -d --name jasperreports -p 80:8080 \
  --net jasperreports-tier \
  --volume /path/to/jasperreports-persistence:/bitnami/jasperreports \
  bitnami/jasperreports:latest

Upgrade this application

Bitnami provides up-to-date versions of 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.

1. Get the updated images:

$ docker pull bitnami/jasperreports:latest

2. Stop your container

• For docker-compose: $ docker-compose stop jasperreports
• For manual execution: $ docker stop jasperreports

3. (For non-compose execution only) Create a backup if you have not mounted the jasperreports folder in the host.

4. Remove the currently running container

• For docker-compose: $ docker-compose rm -v jasperreports
• For manual execution: $ docker rm -v jasperreports

5. Run the new image

• For docker-compose: $ docker-compose start jasperreports
• For manual execution (mount the directories if needed): docker run --name 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:

jasperreports:
  image: bitnami/jasperreports:latest
  ports:
    - 80:8080
  environment:
    - JASPERREPORTS_PASSWORD=my_password
  volumes_from:
    - jasperreports_data

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

  $ docker run -d -e JASPERREPORTS_PASSWORD=my_password -p 80:8080 --name jasperreports -v /your/local/path/bitnami/jasperreports:/bitnami/jasperreports --network=jasperreports-tier bitnami/jasperreports

Available variables:

• JASPERREPORTS_USERNAME: JasperReports admin username. Default: user
• JASPERREPORTS_PASSWORD: JasperReports admin password. Default: bitnami
• JASPERREPORTS_EMAIL: JasperReports admin email. Default: user@example.com

SMTP Configuration

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

• SMTP_HOST: SMTP host.
• SMTP_PORT: SMTP port.
• SMTP_EMAIL: SMTP email.
• SMTP_USER: SMTP account user.
• SMTP_PASSWORD: SMTP account password.
• SMTP_PROTOCOL: SMTP protocol.

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

• docker-compose:

  jasperreports:
    image: bitnami/jasperreports:latest
    ports:
      - 80:8080
    environment:
      - SMTP_HOST=smtp.gmail.com
      - SMTP_PORT=587
      - SMTP_EMAIL=your_email@gmail.com
      - SMTP_USER=your_email@gmail.com
      - SMTP_PASSWORD=your_password
    volumes_from:
      - jasperreports_data

• For manual execution:

 $ docker run -d -e SMTP_HOST=smtp.gmail.com -e SMTP_PORT=587 -e SMTP_USER=your_email@gmail.com -e SMTP_PASSWORD=your_password -p 80:8080 --name jasperreports -v /your/local/path/bitnami/jasperreports:/bitnami/jasperreports --net=jasperreports-tier bitnami/jasperreports

Backing up your application

To backup your application data follow these steps:

1. Stop the running container:

• For docker-compose: $ docker-compose stop jasperreports
• For manual execution: $ docker stop jasperreports

2. Copy the JasperReports data folder in the host:

$ docker cp /your/local/path/bitnami:/bitnami/jasperreports

Restoring a backup

To restore your application using backed up data simply mount the folder with JasperReports data in the container. See persisting your application section for more info.

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. For us to provide better support, 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 (echo $BITNAMI_IMAGE_VERSION inside the container)
• The command you used to run the container, and any relevant output you saw (masking any sensitive information)

Community

Most real time communication happens in the #containers channel at bitnami-oss.slack.com; you can sign up at slack.oss.bitnami.com.

Discussions are archived at bitnami-oss.slackarchive.io.

License

Copyright 2016 Bitnami

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.