Post-Installation Script Parameters

You can customize the post-installation scripts used to configure HotDocs Hub. The table below describes all available parameters.

Note: 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.

Required Settings

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 by Hub used to access ApacheDS. The default setting (uid=admin,ou=system) uses the ApacheDS admin user to connect the Hub to ApacheDS.	uid=admin,ou=system
ApachePass	The password you set for uid=admin,ou=system when configuring ApacheDS.
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.

Parameter Name	Description	Example Data
EnableInterviews	Enables interview functionality in the HotDocs Hub. The default value is true.	true
HdServerFilesUrl	The URL for the HDServerFiles application in IIS; this application points to the HDServerFiles directory for the installed on-premise HotDocs Server.	https://{servername}/HDServerFiles/