These are installation and setup instructions for the latest Private eazyBI version 5.0.
- Private eazyBI installation is supported on Mac OS X, Linux and Windows.
- Java 8 or Java 11 should be installed. Only Oracle or OpenJDK JVMs are supported.
- MySQL (version 5.x), PostgreSQL (version 9.x), MS SQL (version 2008 or later) and Oracle (version 11g or later) are supported as Private eazyBI database.
- Minimum requirements for server:
- CPU with 2 cores;
- 4 GB RAM;
- 10GB disk space.
Open https://eazybi.com/products/private_eazybi and create a new Private eazyBI account to access latest download files and receive your trial license key.
Unzip the downloaded file and copy folder
eazybi_private with all its contents from the downloaded file into the destination directory where all private eazyBI files will be located.
On Windows, there is a maximum 260 characters length limit for the full file path. eazyBI has a deep nested folder structure. System full file paths may exceed this limitation if the
eazybi_private folder is located deeply in the folder hierarchy. We recommended to create the
eazybi_private folder directly in the root folder for Windows installations.
eazybi_private directory contains the following subdirectories and files:
app- for private eazyBI customizations (e.g. custom layouts or view templates)
bin- startup and other shell scripts
config- configuration files
data- for storing uploaded files
eazybi_private.jar- main application archive file
lib- additional Ruby files or *.jar files (added if necessary)
log- web request and queue job log files
eazyBI will store data in additional MySQL, PostgreSQL, Microsoft SQL Server or Oracle database. It is recommended that you create a separate database user for eazyBI needs (by default with a name
eazybi_private) which will then create additional databases on a specified database server.
By default, eazyBI will use one database.
The following are database server specific instructions for eazyBI database setup.
On Mac OS X and Linux start the application with the
bin/start.sh shell script. Please review the
bin/start.sh script and if necessary customize it (e.g. increase Java memory parameters in
JAVA_OPTS environment variable).
On Windows start application with the
bin\start.bat batch file. Please review
bin\start.bat and customize it if necessary (e.g. change
If you get an error message
java.lang.reflect.InvocationTargetException then please check that you are using Java 8 or later (check with
Wait until you see the message
Private eazyBI (version ...) started on and then open
http://localhost:8080 in your browser – you should see the eazyBI settings page.
In eazyBI settings page specify database connection parameters for
eazybi_private database. By default, all eazyBI account specific data will be stored in the same database (as described earlier in Database section). If you want you can select Use separate DWH database option and specify a different database where account specific schemas (with uploaded or imported data) should be stored. Database connection parameters will be stored in the
In addition in the settings page please specify your eazyBI license information – the license name and key. License information will be stored in the
If database and license information will be correct then you will be redirected to a sign up page where you can create the first system administration user account.
eazybi.toml configuration file
config/eazybi.toml file you can configure different eazyBI parameters. The configuration file uses TOML format. Please see comments and commented examples for each section in this file.
On Windows please use the text editor that supports Unix style line endings when editing
eazybi.toml file. The standard Notepad application will not display the content of this file correctly. We recommend to use the Notepad++ application.
If you would like to add e-mail notifications support (to invite users, reset passwords or receive notifications about failed import jobs) from eazyBI then provide SMTP server information which can be used for outgoing e-mails (
mailer section in the configuration file). In addition, uncomment and specify
default_url_options section which is used to generate full URL links back to your private eazyBI server.
If you would like to set up Jira application link to Private eazyBI server then also please specify
accounts section you can provide connection parameters and schema definition files for accounts with a custom schema. See “FoodMart custom” account as an example.
Linux service startup script
bin/init.d/eazybi.sample is a Linux service startup script which can be modified and copied to
/etc/init.d/eazybi. Please specify the
EAZYBI_HOME variable in this script to point to
eazybi_private directory full path. By default, this startup script will use
$EAZYBI_HOME/bin/start.sh to start eazyBI – if needed then create a separate copy of the
start.sh script if different parameters should be used when starting eazyBI as a service.
Private eazyBI distribution by default does not include support for running as a Windows service. But you can use an application like AlwaysUp to create a Windows service that will start the
bin\start.bat file from the Private eazyBI installation directory.
Provide access to eazyBI from other computers
By default, Private eazyBI will be accessible just locally at address
http://localhost:8080. If you want to provide access to private eazyBI from other computers then edit
bin\start.bat and set
0.0.0.0 at the end of the file.
If you would like to change default web application port 8080 to a different port then edit
bin\start.bat and modify
root. An alternative solution is to use frontend web server which listens to port 80 and proxies web requests to private eazyBI. Please contact eazyBI support if you need help with private eazyBI setup in production mode.
Export to PDF using Google Chrome
If you would like to export dashboard pages to PDF or send regular emails with eazyBI dashboards as PDF attachments then please install Google Chrome on your Private eazyBI server.
If Private eazyBI initial page does not open or opens with an error message then check either console output or check the log file
log/eazybi-web.log if it has any error messages.
After eazyBI has started up it will store its log files in
eazybi-web.logcontains a log of web requests
eazybi-queues.logcontains a log of background queue jobs
To upgrade Private eazyBI version here is what you should do:
- Shut down Private eazyBI.
- Download the latest eazyBI private version from eazybi.com "License and Downloads" tab.
- Replace the
eazybi_private.jarfile in your
eazybi_privatedirectory with the .jar file from newest eazyBI Private version.
- If eazyBI major (4.7.1 → 5.0.1) or minor version (4.6.2 → 4.7.1) is changed:
- Backup the existing startup file
- Copy the latest startup file from the downloaded archive to the bin directory.
- Put back changes you have made in the startup file.
- If you use 'systemd' to start eazyBI, then there could be made changes in the file
- If you use 'init.d' to start eazyBI, then please check
bin/init.d/eazybi.samplefor any changes in the latest version.
- Backup the existing startup file
- Check https://docs.eazybi.com/eazybiprivate/set-up-and-administer/changelog for any additional action mentioned to be performed before upgrade.
After that, it should be safe to start Private eazyBI again.