Installation Configuration Settings
You can customize the settings used to configure a HotDocs Hub installation in the DefaultConfig.psd1 settings file. The table below describes all available parameters.
If you are using a Service account to connect to the Hub databases, see Connecting to the HotDocs Hub databases without a username and password for more information.
Configuration Settings
You must set the following parameters before running the ConfigureHub.ps1 Powershell script.
SQL Server settings
| Parameter Name | Description | Example Data |
|
SqlIntegratedSecurity |
Set to true if you
are using integrated security to connect to SQL Server. |
true |
|
SqlServer |
The name of the SQL Server to which Hub will deploy its databases. |
.\sqlexpress |
| SqlUser | Username of a user account with permissions to connect to SQL Server. Only required if you are not using integrated security. |
sa |
| SqlPass | The password for the user account above. | examplepassword |
IIS settings
| Parameter Name | Description | Example Data |
|
IisWebSite |
The name of the IIS web site on which Hub you are installing Hub. |
Default Web Site |
| IisHostName | The host name in IIS used by the web site on which Hub
is installed.
Note: you must use a multi-level host name when installing Hub. |
hub.yourorganization.dev |
| IisAppRoot | The directory in which the Hub applications are installed. |
C:\inetpub\wwwroot |
Database names
Note: you can use a single database name for all the databases below; in this case, Hub will create one database for the use of all services.
| Parameter Name | Description | Example Data |
|
PermissionsCS |
The database name for the Permissions service (HotDocsPermissions). |
HubPermissionsDb |
| TenancyCS |
The database name for the Tenancy Administration service (HotDocsTenancyResolver).
|
HubTenancyDb
|
| IdentityCS |
The database name for the Identity Server Store service (HotDocsIdentityStore).
|
HubIdentityStoreDb
|
| InterviewCS |
The database name for the Interview service (HotDocsInterviews).
|
HubInterviewsDb
|
| TemplateCS |
The database name for the Templates service (HotDocsTemplateHubApi).
|
HubTemplatessDb
|
| AnswersCS |
The database name for the Answers service (HotDocsAnswers).
|
HubAnswersDb
|
| UserCS |
The database name for the User Admin service (HotDocsUserAdmin).
|
HubUserAdminDb
|
General settings
The settings below already have working default values in the DefaultConfig.psd1. They should be left unchanged for most installations.
| Parameter Name | Description | Example Data |
|
HdCoreServiceUrl |
The URL for HotDocs Web Services. The domain should be the full machine name and domain under which HotDocs Web Services is installed. For example, server.yourorganization.local. |
https://{domain}/HDSWebAPI/api/hdcs/ |
| HDServerFilesLocation | The URL for the HDServerFiles application in IIS; this application points to the HDServerFiles directory for the installed on-premise HotDocs Server. |
https://{domain}/HDServerFiles/ |
| SigningCertificateThumbprint | Note: if using the
steps below to retrieve the thumbprint, you may need to remove
a hidden space from the beginning of the copied thumbprint.
The thumbprint of the Identity Server signing certificate. You must add the signing certificate to the LocalMachine\TrustedPeople store. See How to: Retrieve the Thumbprint of a certificate for more information. The identity for the application pool under which HotDocs Hub runs must have read permissions for the certificate's private key. |
(Specific certificate thumbprint hexadecimal value) |
Active Directory
Settings for configuring Active Directory; you should not change these settings for a non-Active Directory installation of Hub.
| Parameter Name | Description | Example Data |
| UseAd | Enables the use of Active Directory as an external identity provider. Must be set to false for deployments that do not require Active Directory federation. | false |
| ActiveDirectoryDomain | Not applicable. | |
| AdUsername | Not applicable. |
Initial root user name and password
The initial root user account that you will use to log in to Hub for the first time.
| Parameter Name | Description | Example Data |
| RootUser | The user name for the default root administrator for Hub. | admin |
| RootPass | The password for the default root administrator for Hub. You should change the password for the administrator user account after Hub is completely installed. |
secret |
E-mail Settings
Settings that control e-mails sent from Hub to users.
| Parameter Name | Description | Example Data |
| EmailHost | The URI of your SMTP e-mail server. | |
| EmailPort | The port of the SMTP e-mail server. | |
| EmailUsername | The user account name for the SMTP e-mail server. | |
| EmailUserPass | The password for the user account name. | |
| EmailFromAddress | The e-mail address from which e-mails are sent. | hub@examplecompany.com |
| EmailUseNetworkCredentials | Enables the use of Network Credentials when connecting to the SMTP e-mail server. The default value is true. | true |
| EmailEnableSsl | Enables the use of SSL with the SMTP e-mail server. The default value is true. | true |
Interviews
Settings that control interview functionality in the HotDocs Hub.
| Parameter Name | Description | Example Data |
| EnableInterviews | Enables interview functionality in the HotDocs Hub. The default value is true. | true |