Hub Installation Files Checklist

HotDocs Hub installation requires several installation files and scripts. Before you start installing the Hub, use the table below to check that you have all of the installation files available.

Hub with User Management and Active Directory Installation Checklist

The following table lists all prerequisites and installation files required to install HotDocs Hub with user management and Active Directory. You should check this list before beginning a new installation, to verify that you have all the software and installation files necessary to complete the install process.

Item Name	Type	Description	Notes
Internet connection	Prerequisite	Required to download installation files and verify HotDocs Server installation.
Windows Server 2008 R2 SP1 or later	Prerequisite	Server operating system.	See Windows and IIS Configuration Checklist below.
Internet Information Service (IIS) 7 or later	Prerequisite	Web server for Windows Server.	See Windows and IIS Configuration Checklist below.
SQL Server 2012 or later	Prerequisite	Database server.	See SQL Server Configuration Checklist below.
Active Directory	Prerequisite	Directory service for Windows. Provides user account management and authentication for HotDocs Hub.
Microsoft .Net Framework 4.6.2 or later	Prerequisite	.Net software framework.
Powershell 3.0 or later	Prerequisite	Used to run Hub post-installation configuration scripts.
Java Runtime Environment (JRE) 7.0 (32-bit)	Prerequisite	Required for ApacheDS installation.
ApacheDS – version 2.0.0 M23 (32-bit)	Prerequisite	LDAP server, required for Hub user management functionality.	https://directory.apache.org/apacheds/
Apache Directory Studio – version 2.0 (32-bit)	Prerequisite	Management tools used to configure ApacheDS.	https://directory.apache.org/studio/
SSL Certificate	Prerequisite	Used to configure HTTPS for the Hub.	See Notes on SSL Certificates and Signing Certificates below.
Signing Certificate	Prerequisite	Used to sign API requests between HotDocs Hub applications.	See Notes on SSL Certificates and Signing Certificates below.
HotDocs Hub installer	Installation file	Installer for HotDocs Hub. Provided with the Hub installation package.	HubInstaller.msi
Windows Authentication application	Installation file	Provided with the Hub installation package.	Webhostwinauth.zip
LDAP setup file	Installation file	File used to configure LDAP connection in ApacheDS for Hub. Provided with the Hub installation package.	LdapInitialSetup.ldif
Hub configuration scripts	Installation file	Powershell scripts used for post-installation configuration of Hub. Provided with the Hub installation package.	Invoke.ps1
Hub Common Files	Installation file	Additional common files required by the post-installation configuration files. Provided with the Hub installation package.	Common folder
HotDocs Server	Installation file	Provides core HotDocs document assembly and interview generation functionality. Provided with the Hub installation package.
HotDocs Web Service API	Installation file	Web services used by HotDocs Hub to access core HotDocs Server functionality. Provided with the Hub installation package.
Upload Plugin for HotDocs Developer	Installation file	Plugin for HotDocs Developer required to upload templates to Hub. Provided with the Hub installation package.

Windows and IIS Configuration Checklist

Windows and IIS features that you must enable before installing HotDocs Hub.

Item Name	Type	Description	Notes
ASP.Net 4.5	Windows Server feature	Web application framework.
Basic Authentication	IIS application pool	Required to authenticate users login without AD.
Windows Authentication	Windows Server feature	Required to authenticate requests to Hub applications.
Feature Delegation	Windows Server feature	Must be enabled.
Feature Delegation > Authentication –Windows	IIS setting	Authentication – Windows setting must be set to Read/Write.
HTTPS binding	IIS setting	HTTPS must be enabled on the web site where Hub is installed.	See Notes on SSL Certificates and Signing Certificates below.
HTTP Redirection	IIS setting	Required by the HotDocs Hub UI.
Signing Certificate Permissions	Security setting	The user under which the Hub's application pool runs must have read permissions to the private key of your signing certificate.	See assigning permissions for the signing certificate for more information.

SQL Server Configuration Checklist

Hub must be able to connect to SQL Server, to create new databases, read data, and write data. Connection strings for the databases are configured in the Invoke.ps1 post-installation script.

Item Name	Type	Description	Notes
User account	SQL user	The account used by HotDocs Hub to access SQL Server. This can be: Local account – e.g. Network Service Service account – e.g. a specific domain user SQL login user – e.g. a specific SQL user account with appropriate permissions	Different user account types require different connection strings. For example, a service account may not require a username and password. This may require editing the Invoke.ps1 post-installation script.
dbcreator	SQL Server role	The user must be able to create new databases for the installed Hub applications.
db_datareader	Master Database role	The user must be able to read data from the Hub databases.	Typically not required when user has dbcreator role.
db_datawriter	Master Database role	The user must be able to write data to the Hub databases.	Typically not required when user has dbcreator role.

Notes on SSL Certificates and Signing Certificates

PFX Files

If they have not set up the certificates themselves, clients must have .PFX files for both certificates ready for the deployment.

TLS/SSL

You must enable a TLS/SSL connection in IIS when installing HotDocs Hub with User Management and Active Directory.

2048 bit public key.
Must be exportable.
Must be imported to the local machine Personal store.
Must be imported to the local machine Trusted People store (if using a self-signed certificate).

Signing Certificate

The Hub requires a certificate for signing access tokens, used for authenticating requests to Hub APIs. The certificate has the following configuration requirements:

May be a self-signed certificate, if necessary.
2048 bit public key.
Must be exportable.
Must be imported to the local machine Personal store.
The identity for the application pool under which the HotDocs Hub applications run must have permissions to the private key of the certificate. You configure these permissions after you install Hub.

You must also add the certificate's thumbprint to the HotDocs Identity Server application settings SigningCertificateThumbprint key during the installation process.

HotDocs recommends that you use a separate security certificate as the signing certificate for HotDocs Hub. However, you can use the SSL certificate as the signing certificate if necessary.