This guide provides installation and configuration instructions for Windows.

• Terminology
  • Acronyms
• Installation procedure
  • List of modules outside of DigDash
• Supported versions
• Installations
  • Creating a file system
    • Editing the digdash.properties file
    • Creating log files at the root of the digdash directory :E
      • log4j2_api.properties
      • log4j2_dash.properties
      • log4j2_studio.properties
  • Deploying WebApps
  • Installing Microsoft JDK (optional if already installed)
  • Installing Tomcat 9
  • Installing OpenDJ (recommended)
    • Initial setup
    • Additional settings
    • Useful option
      • Extending the limit for LDAP searches
  • Installing MariaDB
    • Database configuration
    • Creating users and assigning rights
    • MariaDB Update
• Configuring DigDash after installation
  • Starting Digdash
  • Connecting Digdash to the installed OpenDJ server
  • Changing the supervisor password and creating the LDAP account
    • Changing the supervisor password
    • Creating the LDAP account
  • Database configuration
    • Audit data database
    • Comments database
    • Data entry database
  • DigDash Services

This document describes how to install DigDash on Windows.

To install DigDash on Linux, please refer to the Installation guide for Linux.

To update an existing installation, please refer to the Upgrade Guide.

Terminology

Acronyms

Installation procedure

List of modules outside of DigDash

All servers must have at least the following installations:

• File system
• Microsoft JDK 17
• Tomcat 9
• DigDash WebApps

List of production components:

• Replace ADSWRAPPER with OpenDJ (For production environments)
• Replace H2 with a Database: PostGres or MariaDB

List of optional components:

• Reverse Proxy: Apache for Windows

Supported versions

The following versions are supported :

• Tomcat 9 : last patch
• OpenDJ (recommended) : version 4.6.2 and later
• MariaDB : OS version or last patch of last LTS version
• Apache2 : last patch

Installations

Creating a file system

1. Create a “logs” directory at the root of the desired directory (L):
   • logs: hosts the log files of applications running on the server locally
2. Create a “digdash” directory at the root of E.
3. In the digdash directory, create 4 directories:
   • tools: hosts the tools delivered by DigDash which can interact with it (import tool, backup tools)
   • webapps: DigDash application modules: (studio, adminconsole, dashboard, ddenterpriseapi)
   • ldapdigdash: hosts LDAP configuration and data
   • appdata: hosts DigDash data
4. In each directory created in the previous steps, create a default directory.
5. Copy the digdash.properties file to the root of the digdash directory of E:

Editing the digdash.properties file

• Open the digdash.properties file and add the following lines: :

log4j2_api.properties

Create the log4j2_api.properties file at the root of the directory.

Copy the following code: 

Create the log4j2_dash.properties file at the root of the directory.

Copy the following code:

log4j2_studio.properties

Create the log4j2_studio.properties file at the root of the directory.

Copy the following code:

Deploying WebApps

Place the following (contained in the <DD Install>\apache-tomcat\webapps directory) in the E:/digdash/webapps/default folder:

• adminconsole.war
• ddenterpriseapi.war
• digdash_dashboard.war
• studio.war
• ROOT/ folder

Installing Microsoft JDK (optional if already installed)

1. Download Microsoft JDK : https://docs.microsoft.com/fr-fr/java/openjdk/download or use the binary available in the installation Zip partenaire_installation_initial.zip.
2. Start the installation.

Installing Tomcat 9

5. Leave the configuration settings at default.

6. Enter the path to the installation of the openjdk installed in step 1.

7. Set the TomCat 9 installation directory.

8. Click Install to start TomCat 9 installation.
9. Open page http://localhost:8080 to check TomCat is working properly.
10. Open the TomCat 9 installation directory then the bin directory and launch tomcat9w.exe.

11. Modify the parameters contained in the Java tab :
    *

    • Adapt the paths to future digdash directories:
      Ddigdash.properties.path=E:\digdash\digdash.properties

    • To ensure that special characters are taken into account, add the parameter -Dfile.encoding=UTF-8 to the end of the JAVA_OPTS variable as below:
      

     

Editing the server.xml file

1. Open the server.xml file located in the \Apache Software Foundation\Tomcat 9.0\conf directory.

2. Change the path of the webapps to deploy.

3. Add the log valve and then, the securing valve.

1. Open the context.xml file located in the \Apache Software Foundation\Tomcat 9.0\conf directory.
2. Add the following XML tag in the Context section:

Initial setup

1. Download the OpenDJ installation file (opendj-4.x.x.msi) from: https://github.com/OpenIdentityPlatform/OpenDJ/releases 
2. Start the installation by double-clicking the opendj-4.x.x.msi file.
3. Keep the default location for the installtion directory : (C:/Program Files (x86)/opendj).
4. Open the installation directory C:/Program Files (x86)/opendj) and run the “setup.bat” as administrator.
5. Complete the Server settings and make sure to save the password entered.
   
    
6. In the Topology Options tab, leave the default option This will be a stand alone server.
   
    
7. Fill in the Directory Data and select Only Create Base Entry (dc=digdash,dc=com).
   
    
8. In the Review tab, check the entered values ​​and select the Run the server as a Windows Service checkbox.
   
    
9. Click Finish.
   

When the installation is finished, check if the service is started. Then launch an administrator terminal for additional settings.

Additional settings

1. Open the OpenDJ installation directory.

2. LDIF files can be downloaded by clicking on the following link : LDIF_OpenDJ.
3. Create the organizations using the “neworganization.ldif” file below

4. To create a password checker:
   • Use the dsconfig.bat command, then log in with the Directory Manager credentials and accept the certificates.
   • Go to menu 29 then select “create a new Password Validator” > select “Character Set Password Validator” > enter “Custom Character Set Password Validator” > “true” > “true” > then configure 4 character-set as follows:

➡ The result should look like this:

Once the configuration is complete, “finish” and exit “dsconfig”.

5. For the second password checker, we can use a command line because it does not contain special characters: 

6. Apply both password checkers:

7. Set the password policy for users using the “ppolicy.ldif” file below :

8. Set a second password policy for the admin using the “ppolicy-admin.ldif” file below

9. Change the password policy to allow pre-encoded passwords (useful for restores in digdash).

10. Create an admin user for digdash via the “create_user_admin.ldif” file below:

11. Assign the admin user the necessary rights using the “add_admin_right.ldif” and “add_admin_right2.ldif” files below:

12. Generate a password for the administrator and remember it for later:

Useful option

The operation below is not part of the installation.
However, it may be useful to know it for later use.

Extending the limit for LDAP searches

It is possible to extend the LDAP search limit to more than 1000 users with the “extend_search_limit.ldif” file below.

Installing MariaDB

The MariaDB database will be used to store the following elements: comments, audit data and data entry.

This database is more durable than an H2 database, that is why we recommend its use. If you already have a database that Digdash can write to and read from then proceed to the configuration step.

PostgreSQL and MySQL are also compatible.

Running the installer

1. Access the website https://mariadb.com/downloads/ and download the latest version of the software for OS: MS Windows (64-bit).
   
    
2. Run the .msi file to start the installation and click Next.
   
    
3. Choose the database root password:
   
    
4. Click Next and install MariaDB.
   
    
5. Check the security of the C:/Program Files/MariaDB 10.10 folder to only give the following rights to users: Read and execute; List folder contents; Read.
   

Database configuration

1. Open command prompt as administrator and launch MariaDB.

2. Create the necessary databases domain_module (domain examples: default, dev, prod)

Creating users and assigning rights

1. Create a user for each database domaine_user_module:

2. Assign rights to the user on databases:

MariaDB Update

For a minor update (for example, 10.10.1 to 10.10.2), you have to :

1. Read the release note of the new version to ensure that there is no need to worry about the data.
2. Download the new version (example: 10.10.2) and run it : the update should be done automatically.
3. Restart MariaDB server.

Configuring DigDash after installation

4. Access DigDash homepage at the following address : http://localhost:8080/adminconsole
   The login/password is admin/admin.

Connecting Digdash to the installed OpenDJ server

Open http://localhost:8080/adminconsole/, Configuration -> Server settings -> Servers -> LDAP Server.

• Port:  389
• User: uid=admin, ou=default,dc=digdash,dc=com
• Password: OpenDJ admin password

Then click the LDAP Queries button and fill in the fields as below:

Changing the supervisor password and creating the LDAP account

Changing the supervisor password

Open Configuration  -> Server settings > Servers -> Enterprise Server and enter a new password in the Supervisor Password field.

Creating the LDAP account

1. Open Configuration -> User management -> Users. 
2. Create a new admin user and assign him all roles and authorizations groups.
3. In the Password field, enter the new supervisor password defined above.

Database configuration

Audit data database

Open Configuration -> Server settings -> Databases -> Audit data and enter the URL, user and password.

URL : jdbc:mariadb://localhost:3306/default_ddaudit

This solution makes it possible to secure access to the audit database.

Comments database

Open Configuration -> Server settings -> Databases -> Audit data and enter the URL, user and password.

URL : jdbc:mariadb://localhost:3306/default_comment

This solution makes it possible to secure access to the comment database.

Data entry database

Open Configuration -> Server settings -> Databases -> Data entry and enter the URL, user and password.

Select the Enable data entry checkbox and select a database in the drop-down list below. 

You must first have created a connection to the database from the Data connection manager in the Studio.
Enter default.user.ddentry for the user and password defined in the previous step.
The name defined in the Login Name field is the one that will appear in the database selection drop-down list.

DigDash Services

Open the Server status page : http://localhost:8080/ddenterpriseapi/serverstatus?adminDomain=adminconsole&serverDomain=ddenterpriseapi.

Check that the DigDash services are activated and that the maximum memory is well adapted to the capacity of the server, you must leave at least 4 GB for the system.