You can customize the post-installation scripts used to configure HotDocs Hub. The table below describes all available parameters.
You must set the following parameters before running the Invoke.ps1 Powershell script.
The settings below already have working default values in the Invoke.ps1. They should be left unchanged for most installations.
| 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 |
| 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) |
Settings that control the connection between HotDocs Hub and ApacheDS.
| Parameter Name | Description | Example Data |
| ApacheDS | The name of the server on which ApacheDS runs. | exampleserver01 |
| ApachePort | The port used by the ApacheDS host. Must be the port configured during the ApacheDS installation process. | 10389 |
| ApacheUser | The administrative user account used to access ApacheDS. The initial default value after installation is uid=admin,ou=system. | uid=admin,ou=system |
| ApachePass | The administrative user account password. The initial default value after installation is secret. | secret |
| ApacheDomain | The installation domain controller in ApacheDS. The default value is dc=example,dc=com. | dc=example,dc=com |
| ApacheTenancy | The ID of the LDAP tenancy group in ApacheDS. The value is the entryUUID obtained during ApacheDS configuration. | 64fd13cf-45f9-49cf-b31b-9nn0f2e8d63w |
| ApacheUseSSL | Enables the use of SSL with ApacheDS. The default value is false. | false |
Settings that control e-mails sent from the HotDocs 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-mail 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 |
Settings that control interview functionality in the HotDocs Hub. The CSSubscribedId and CSKey settings only need to be set if you have a Cloud Services subscription.
| Parameter Name | Description | Example Data |
| EnableInterviews | Enables interview functionality in the HotDocs Hub. The default value is true. | true |
| HdCoreServiceUrl | Only required by installations using HotDocs Cloud Services. The URL of the HotDocs Cloud Services instance used to generate interviews. | https://europe.hotdocs.ws/hdcs/ |
| CSRegion | The name of the region to which your Cloud Services subscription is provisioned. Must be set to None for installations that use the on-premise HotDocs Web Services. |
|
| CSSubscriberId | Only required by installations using HotDocs Cloud Services. The Subscriber ID used by the client to access Cloud Services. The ID is set in the Cloud Services Portal. | ExampleSubscriberId |
| CSKey | Only required by installations using HotDocs Cloud Services. The Signing Key used by the client to access Cloud Services. The Key is set in the Cloud Services Portal. | ExampleSigningKey |