Installation

Owned by Former user (Deleted)
Last updated: Oct 10, 2022 by Simon Klimke
4 min read

This chapter it is described how the M2 Tableau Toolbox can be installed. There are the following options:

We highly encourage you to install our product using docker with HTTPS as this comes bundled with the required database as well as a letsencrypt proxy to handle the SSL encryption for you.

SSL encryption is required by tableau. 

Installation via Docker on Windows with HTTP

Installation via Docker requires the Docker and Docker compose platform which can be downloaded from here. You can check the version with “docker-compose –version”.

  1. Unzip M2Toolbox <version> Windows Docker HTTP.zip to a directory of your choosing.

  2. The port can be changed in the "docker-compose.yml”.

  3. Randomize DB_PASS in  .env file before first start.

  4. Start the provided "startToolbox.bat" or "startToolbox.ps1"  script. This script will download the M2. Tableau Toolbox and build all required Docker containers. The containers will now be created; this may take a moment.

  5. Now the Toolbox is reachable via http://localhost

Installation via Docker on Windows with HTTPS

Installation via Docker requires the Docker and Docker compose platform which can be downloaded from here. You can check the version with “docker-compose –version”.

  1. Unzip M2Toolbox <version> Windows Docker HTTPS.zip to a directory of your choosing.

  2. In the "docker-compose.yml” file, please change EMAIL and DOMAIN to match your configuration. The domain should lead to your toolbox device.

  3. Randomize DB_PASS in  .env file before first start.

  4. Start the provided "startToolbox.bat" or "startToolbox.ps1"  script. This script will download the M2. Tableau Toolbox and build all required Docker containers. The containers will now be created; this may take a moment.

  5. Now the Toolbox is reachable via https://localhost and your domain configured in step 2.

Installation via Docker on Linux with HTTP

Installation via Docker requires the Docker and Docker compose platform which can be downloaded from here. You can check the version with “docker-compose –version”.

  1. Unzip M2Toolbox <version> Linux Docker HTTP.zip to a directory of your choosing.

  2. The port can be changed in the "docker-compose.yml”.

  3. Randomize DB_PASS in  .env file before first start.

  4. Start the provided "startToolbox.sh" script. This script will download the M2. Tableau Toolbox and build all required Docker containers. The containers will now be created; this may take a moment.

  5. Now the Toolbox is reachable via http://localhost

Installation via Docker on Linux with HTTPS

Prerequisites

Installation via Docker requires the Docker and Docker compose platform which can be downloaded from here. You can check the version with “docker-compose –version”.

  1. Unzip M2Toolbox <version> Linux Docker HTTPS.zip to a directory of your choosing.

  2. Randomize DB_PASS in  .env file before first start.

SSL Certificate

To provide a valid SSL certificate, it is possible to choose our preset automatic route.
This uses Letsencrypt as the certificate issuing source. To choose this route, the toolbox must be publicly accessible under the desired domain.
The reason for this is that the third party, letsencrypt, makes a short request from outside to the desired domain to verify that they are the owner of the domain. Read more about this here: https://letsencrypt.org/how-it-works/

If you want to use this automated route, please follow the instructions in the Using a Letsencrypt Certificate section. If you prefer to use your own certificate, follow the instructions in the Using a custom Certificate section.

Using a Letsencrypt Certificate

Please make sure that the domain you choose points to your Linux machine and that it is reachable on port 80 of public.

  1. In the "docker-compose.yml” file, please change EMAIL and DOMAIN to match your configuration.
    The domain should lead to your toolbox device.

  2. Start the provided "startToolbox.sh" script.
    This script will download the M2. Tableau Toolbox and build all required Docker containers. The containers will now be created; this may take a moment.

Now the Toolbox is reachable via https://localhost and your domain configured in step 1.

Using a custom Certificate

The Toolbox expects two files in the cert folder as a custom certificate. One is fullchain.pem and the other is privkey.pem.

  1. Replace our dummy files in the cert folder with your personal certificates:
    fullchain.pem and privkey.pem

  2. Start the toolbox with the script "installCustomCert.sh”.

The script updates and starts the toolbox, but with the custom certificates instead of those from Letsencrypt. From now on, please always use this script to start and update the Toolbox.

The toolbox is now accessible under https://localhost and of course its domain.

Manual Installation

This chapter describes in detail the necessary steps to perform the M2 Tableau Toolbox installation, including unpacking all required files and the initial configuration on Windows and Linux machines.

Prerequisites

The software requires a Java Runtime Environment and a MySQL database. Database server, schema, name and password need to be available to configure the software as part of the installation process. See section 2 for details.

Unpacking

In addition to your documents, you have received an M2Toolbox <version> Blank.zip -archive containing all relevant files. 

The archive can be unpacked at a location of your choice. The resulting file structure should look as shown in Figure 3.

Figure 3: Folder Structure after Unpacking the .zip-archive

Configuration

The file application.properties will hold all necessary settings required for the M2 Tableau Toolbox.

The following section describes the most important settings in detail. Additional descriptions and examples can be found as comments in the application.properties file.

  • spring.datasource.url: connection URL to your database instance including database- or schema-name

M2 Tableau Toolbox will not create a database or schema itself, so it must be present before the initial start-up.

  • spring.datasource.username:username for database or schema

  • spring.datasource.password: corresponding password for database or schema

  • spring.datasource.driver-class-name: java class-name for data source driver (you do not have to make changes here)

  • server.contextPath: Path addition for the internal webserver

  • server.port: Port for the internal webserver

The application.yaml file contains the necessary information about the database drivers. There are supported types of databases:

  • MySQL

  • PostgreSQL

  • MS SQL Server

  • Oracle

  • Snowflake

  • SAP Hana

  • IBM DB2

Drivers for each database type are included in the M2 Tableau Toolbox release package. The syntax of the description can be found in the application.yaml file.