Installing HotDocs Hub with User Management and Active Directory Overview

This document is a step-by-step guide to installing the HotDocs Hub with user management and Active Directory, as part of an on-premise solution. You must complete each step in order when deploying the Hub to your environment.

In this Topic ShowHide

Overview

The following provides a high-level overview of how Active Directory and HotDocs Hub interact.

Component Responsibilities

• Active Directory provides user account management and authentication.
• HotDocs Hub User Hub component provides user authorization.

Hub Installation

• Active Directory must already be installed and joined to a domain.

Root User

• You set an existing Active Directory user account as the Hub Root User, after Hub is installed.
• The Root User is the only user that can initially log in to the Hub.

Importing User Accounts from Active Directory

• The Root User imports Active Directory Groups into the Hub, using the Hub user interface.
• Importing Active Directory Groups creates new Hub user accounts for all imported users.
• Active Directory users can log into the Hub using their standard domain login credentials.

1. Pre-installation

Check system requirements are met and security configuration is understood before installing the HotDocs Hub.

1. System Requirements
2. Security Configuration Options
3. Installation Files Checklist

2. Install and Configure Prerequisites

1. Install HotDocs Server
2. Configure SQL Server
3. Install ApacheDS
4. Downloading and running Apache Directory Studio
5. Configuring ApacheDS for use with Active Directory

3. HotDocs Hub Installation

1. Installing HotDocs Hub with User Management and Active Directory
2. Assigning permissions for the signing certificate
3. Configuring HotDocs Identity Server Application Settings – assign an Active Directory user account as the Hub Root User
4. Installing the Windows Authentication Application – additional application required for installations that use Active Directory

4. HotDocs Web Services

Note: you only need to install HotDocs Server and Web Services if you are not using HotDocs Cloud Services to assemble documents and generate interviews.

HotDocs Hub relies on HotDocs Server and HotDocs Web Services to display interviews and generate documents. These must be installed after installing the Hub.

1. Installing HotDocs Web Services
2. Configuring HotDocs Hub to use HotDocs Web Services

5. Post-installation Tasks

After the HotDocs Hub and its prerequisites are installed, complete the following configuration steps:

1. Getting Started – first steps for using HotDocs Hub after installation
2. Changing the client secret for the Upload Plugin – you must configure the client secret before you can upload templates to Hub

6. Install Software for Content Developers

Template authors are users that create HotDocs templates. The following software must be installed on template authors' desktop computers:

1. Installing HotDocs Developer – used to develop HotDocs templates
2. Installing the Upload Plugin for HotDocs Developer – used to upload templates from HotDocs Developer to the HotDocs Hub

7. Using HotDocs Hub

After the HotDocs Hub is installed and configured, see the following topics for information about using the Hub:

• Using the HotDocs Hub overview
• Manage User Groups – organize users into Groups
• Manage Users – create and edit individual user accounts
• Manage template groups – organize templates into groups
• Upload templates to the HotDocs Hub
• Manage templates – view and edit individual templates uploaded to the Hub
• Set user permissions – give User Groups access to Template Groups
• Create a new work item
• Launch an interview – launch an Interview for a template
• Generate a direct interview link – generate a direct link to a Interview for a template