Description

ReportServer is the enterprise business intelligence platform. It integrates multiple reporting engines, dashboards and ad-hoc analytics, with scripting capabilities to for deep customization..

License information

The Bitnami ReportServer Enterprise Stack includes a free trial license for 45 days. To learn more about ReportServer Enterprise plans and licensing, visit the ReportServer Enterprise website.

First steps with the Bitnami ReportServer Enterprise Stack

Welcome to your new Bitnami application running on Amazon Web Services! Here are a few questions (and answers!) you might need when first starting with your application.

What credentials do I need?

You need two sets of credentials:

• The application credentials that allow you to log in to your new Bitnami application. These credentials consist of a username and password.
• The server credentials that allow you to log in to your AWS Cloud server using an SSH client and execute commands on the server using the command line. These credentials consist of an SSH username and key.

Watch the following video to learn quickly how to obtain the application credentials of those applications deployed using the AWS Console:

What is the administrator username set for me to log in to the application for the first time?

Username: user

How do I get my SSH key or password?

SSH username: bitnami

What are the default ports?

A port is an endpoint of communication in an operating system that identifies a specific process or a type of service. Bitnami stacks include several services or servers that require a port.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

Port 22 is the default port for SSH connections.

Bitnami opens some ports for the main servers. These are the ports opened by default: 80, 443.

How to start or stop the services?

Each Bitnami stack includes a control script that lets you easily stop, start and restart services. The script is located at /opt/bitnami/ctlscript.sh. Call it without any service name arguments to start all services:

$ sudo /opt/bitnami/ctlscript.sh start

Or use it to restart a single service, such as Apache only, by passing the service name as argument:

$ sudo /opt/bitnami/ctlscript.sh restart apache

Use this script to stop all services:

$ sudo /opt/bitnami/ctlscript.sh stop

Restart the services by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh restart

Obtain a list of available services and operations by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh

How to change the default administrator password?

For security, it is recommended that you change the default administrator password as soon as possible. Follow the steps below:

• Log in to the application as an administrator.

• Click the "Welcome" link at the top-right corner. The default user profile will pop up.

  

• Click "Change Password", and enter the old password and the new password twice.

  

• Click "Submit" to save your changes.

  

How to change the interface language?

ReportServer Enterprise uses the English language pack by default. However, translations also exist for other languages. To change the interface language, follow these steps:

• Log in to the application as an administrator.

• Open the ReportServer Enterprise terminal by pressing: Ctrl+Alt+T (Control+option+T in Mac OS X).

• Type the following command:

   $ editTextFile fileserver/etc/main/localization.cfg
  

  

• Change the default tag's value to the desired language.

  

• Restart Tomcat:

   $ /opt/bitnami/ctlscript.sh restart tomcat
  

• Log in to the application again.

How to configure outbound email settings?

To configure outbound email, follow these steps:

• Log in to the application as an administrator.

• Open the ReportServer Enterprise terminal by pressing: Ctrl+Alt+T (control+option+T in Mac OS X).

• Type the following command:

  $ editTextFile fileserver/etc/mail/mail.cf

  

• Enter details for the SMTP server to be used for outbound email. For example, to configure a Gmail account, you could use the settings below. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.
  • SMTP Server - ssl://smtp.gmail.com
  • SMTP port - 465
  • SSL tag - true
  • SMTP Username - USERNAME@gmail.com
  • SMTP Password - PASSWORD
  • Modify the sender at your convenience.

  

• Click "Submit" to save your changes.

• Restart Tomcat:

   $ /opt/bitnami/ctlscript.sh restart tomcat
  

• Log in to the application again.

To configure the application to use the SMTP service provided by Amazon Simple Email Service (SES), refer to the guide on using Amazon SES.

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid or Mandrill, refer to the FAQ.

How to create a full backup of ReportServer Enterprise?

Backup

The Bitnami ReportServer Enterprise Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

Follow these steps:

• Change to the directory in which you wish to save your backup:

    $ cd /your/directory
  

• Stop all servers:

    $ sudo /opt/bitnami/ctlscript.sh stop
  

• Create a compressed file with the stack contents:

    $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
  

• Restart all servers:

    $ sudo /opt/bitnami/ctlscript.sh start
  

You should now download or transfer the application-backup.tar.gz file to a safe location.

Restore

Follow these steps:

• Change to the directory containing your backup:

    $ cd /your/directory
  

• Stop all servers:

    $ sudo /opt/bitnami/ctlscript.sh stop
  

• Move the current stack to a different location:

    $ sudo mv /opt/bitnami /tmp/bitnami-backup
  

• Uncompress the backup file to the original directoryv

    $ sudo tar -pxzvf application-backup.tar.gz -C /
  

• Start all servers:

    $ sudo /opt/bitnami/ctlscript.sh start
  

If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

How to upgrade ReportServer Enterprise?

It is strongly recommended to create a backup before starting the update process. If you have important data, create and restore a backup to ensure that everything works properly.

To upgrade the application only without modifying any other stack components, download the upgrade guide and script from the official ReportServer Enterprise website.

How to create an SSL certificate for Apache Tomcat?

A detailed guide is available in the official Apache Tomcat documentation at http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html.

How to enable SSL access over HTTPS?

You can configure Apache Tomcat to enable SSL access to applications using HTTPS. It is necessary to configure Tomcat with the location of the Apache SSL certificate, as described below.

• Check that the certificate file is present at /opt/bitnami/apache-tomcat/conf/ssl/tomcat.cert.pem and the certificate key file is present at /opt/bitnami/apache-tomcat/conf/ssl/tomcat.key.pem.

• Uncomment the following line in the /opt/bitnami/apache-tomcat/conf/server.xml file:

     <Connector port="8443"
                protocol="HTTP/1.1" SSLEnabled="true"
                maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
                enableLookups="false" disableUploadTimeout="true"
                acceptCount="100" scheme="https" secure="true"
                clientAuth="false" sslProtocol="TLS"
                keystoreFile="conf/myKeystore"
                keystorePass="your_password"
                SSLCertificateFile="/opt/bitnami/apache-tomcat/conf/ssl/tomcat.cert.pem"
                SSLCertificateKeyFile="/opt/bitnami/apache-tomcat/conf/ssl/tomcat.key.pem"/>
  

• Restart the Apache Tomcat server

You should now be able to access your Web applications over HTTPS by browsing to https://SERVER-IP:8443.

How to create an SSL certificate?

OpenSSL is required to create an SSL certificate. A certificate request can then be sent to a certificate authority (CA) to get it signed into a certificate, or if you have your own certificate authority, you may sign it yourself, or you can use a self-signed certificate (because you just want a test certificate or because you are setting up your own CA).

Follow the steps below:

• Generate a new private key:

   $ sudo openssl genrsa -out /opt/bitnami/apache2/conf/server.key 2048
  

• Create a certificate:

   $ sudo openssl req -new -key /opt/bitnami/apache2/conf/server.key -out /opt/bitnami/apache2/conf/cert.csr
  

  IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".

• Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

• Until the certificate is received, create a temporary self-signed certificate:

   $ sudo openssl x509 -in /opt/bitnami/apache2/conf/cert.csr -out /opt/bitnami/apache2/conf/server.crt -req -signkey /opt/bitnami/apache2/conf/server.key -days 365
  

• Back up your private key in a safe location after generating a password-protected version as follows:

   $ sudo openssl rsa -des3 -in /opt/bitnami/apache2/conf/server.key -out privkey.pem
  

  Note that if you use this encrypted key in the Apache configuration file, it will be necessary to enter the password manually every time Apache starts. Regenerate the key without password protection from this file as follows:

   $ sudo openssl rsa -in privkey.pem -out /opt/bitnami/apache2/conf/server.key
  

Find more information about certificates at http://www.openssl.org.

How to enable HTTPS support with SSL certificates?

Bitnami images come with SSL support already pre-configured and with a dummy certificate in place. Although this dummy certificate is fine for testing and development purposes, you will usually want to use a valid SSL certificate for production use. You can either generate this on your own (explained here) or you can purchase one from a commercial certificate authority.

Once you obtain the certificate and certificate key files, you will need to update your server to use them. Follow these steps to activate SSL support:

• Use the table below to identify the correct locations for your certificate and configuration files.

  Variable	Value
  Current application URL	https://[custom-domain]/
  	Example: https://my-domain.com/ or https://my-domain.com/appname
  Apache configuration file	/opt/bitnami/apache2/conf/bitnami/bitnami.conf
  Certificate file	/opt/bitnami/apache2/conf/server.crt
  Certificate key file	/opt/bitnami/apache2/conf/server.key
  CA certificate bundle file (if present)	/opt/bitnami/apache2/conf/server-ca.crt

• Copy your SSL certificate and certificate key file to the specified locations.

  NOTE: If you use different names for your certificate and key files, you should reconfigure the SSLCertificateFile and SSLCertificateKeyFile directives in the corresponding Apache configuration file to reflect the correct file names.

• If your certificate authority has also provided you with a PEM-encoded Certificate Authority (CA) bundle, you must copy it to the correct location in the previous table. Then, modify the Apache configuration file to include the following line below the SSLCertificateKeyFile directive. Choose the correct directive based on your scenario and Apache version:

  Variable	Value
  Apache configuration file	/opt/bitnami/apache2/conf/bitnami/bitnami.conf
  Directive to include (Apache v2.4.8+)	SSLCACertificateFile "/opt/bitnami/apache2/conf/server-ca.crt"
  Directive to include (Apache < v2.4.8)	SSLCertificateChainFile "/opt/bitnami/apache2/conf/server-ca.crt"

  NOTE: If you use a different name for your CA certificate bundle, you should reconfigure the SSLCertificateChainFile or SSLCACertificateFile directives in the corresponding Apache configuration file to reflect the correct file name.

• Once you have copied all the server certificate files, you may make them readable by the root user only with the following commands:

   $ sudo chown root:root /opt/bitnami/apache2/conf/server*
  
   $ sudo chmod 600 /opt/bitnami/apache2/conf/server*
  

• Open port 443 in the server firewall. Refer to the FAQ for more information.

• Restart the Apache server.

You should now be able to access your application using an HTTPS URL.

How to force HTTPS redirection with Apache?

Add the following lines in the default Apache virtual host configuration file at /opt/bitnami/apache2/conf/bitnami/bitnami.conf, inside the default VirtualHost directive, so that it looks like this:

<VirtualHost _default_:80>
  DocumentRoot "/opt/bitnami/apache2/htdocs"
  RewriteEngine On
  RewriteCond %{HTTPS} !=on
  RewriteRule ^/(.*) https://%{SERVER_NAME}/$1 [R,L]
  ...
</VirtualHost>

After modifying the Apache configuration files:

• Open port 443 in the server firewall. Refer to the FAQ for more information.

• Restart Apache to apply the changes.

How to debug Apache errors?

Once Apache starts, it will create two log files at /opt/bitnami/apache2/logs/access_log and /opt/bitnami/apache2/logs/error_log respectively.

• The access_log file is used to track client requests. When a client requests a document from the server, Apache records several parameters associated with the request in this file, such as: the IP address of the client, the document requested, the HTTP status code, and the current time.

• The error_log file is used to record important events. This file includes error messages, startup messages, and any other significant events in the life cycle of the server. This is the first place to look when you run into a problem when using Apache.

If no error is found, you will see a message similar to:

Syntax OK

How to change the Java memory settings?

The Java Virtual Machine (JVM) determines the default settings for your Java application:

JAVA_OPTS="-Xms256m -Xmx512m"

You can increase these Java settings for your application if necessary. The settings are in the /opt/bitnami/java/bitnami/setenv.sh file. Here is an example of how to change the memory settings:

$ export JAVA_OPTS="$JAVA_OPTS -Xms256M -Xmx768M"

How to debug errors in Tomcat?

The main Apache Tomcat configuration file is at /opt/bitnami/apache-tomcat/conf/server.xml.

Once Apache Tomcat starts, it will create several log files in the /opt/bitnami/apache-tomcat/logs directory. The main log file is the catalina.out file where you can find error messages. On some platforms, you may need root account privileges to view these files.

How to find the MariaDB database credentials?

• Database username: root.
• Database password: The same as the application password. Find out how to obtain application credentials.

How to connect to the MariaDB database?

You can connect to the MariaDB database from the same computer where it is installed with the mysql client tool.

$ mysql -u root -p

You will be prompted to enter the root user password. This is the same as the application password.

How to debug errors in your database?

The main log file is created at /opt/bitnami/mariadb/data/mysqld.log on the MySQL database server host.

How to reset the MariaDB root password?

If you don't remember your MariaDB root password, you can follow the steps below to reset it to a new value:

• Create a file in /home/bitnami/mysql-init with the content shown below (replace NEW_PASSWORD with the password you wish to use):

   UPDATE mysql.user SET Password=PASSWORD('NEW_PASSWORD') WHERE User='root';
   FLUSH PRIVILEGES;
  

• Stop the MariaDB server:

   $ sudo /opt/bitnami/ctlscript.sh stop mariadb
  

• Start MariaDB with the following command:

   $ sudo /opt/bitnami/mariadb/bin/mysqld_safe --defaults-file=/opt/bitnami/mariadb/my.cnf --pid-file=/opt/bitnami/mariadb/data/mysqld.pid --init-file=/home/bitnami/mysql-init 2> /dev/null &
  

• Restart the MariaDB server:

   $ sudo /opt/bitnami/ctlscript.sh restart mariadb
  

• Remove the init script

   $ rm /home/bitnami/mysql-init
  

How to change the MariaDB root password?

You can modify the MariaDB password using the following command at the shell prompt:

$ /opt/bitnami/mariadb/bin/mysqladmin -p -u root password NEW_PASSWORD

How to upload files to the server with SFTP?

Although you can use any SFTP/SCP client to transfer files to your server, the link below explains how to configure FileZilla (Windows, Linux and Mac OS X), WinSCP (Windows) and Cyberduck (Mac OS X). It is required to use your server's private SSH key to configure the SFTP client properly. Choose your preferred application and follow the steps in the link below to connect to the server through SFTP.

How to upload files to the server

Troubleshooting ReportServer Enterprise

How to debug errors in ReportServer Enterprise?

Application logs are stored in the /opt/bitnami/apache-tomcat/logs directory.