Post-Installation Script Parameters

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

General Settings

Parameter Name Description Example Data
HelpUrl The URL for the HotDocs Hub help file. This setting should not be changed. /hotdocshub/1.0.0/onpremise/user/
CloudDeployment Indicates type of Hub deployment. Must be false for on-premise deployments. false
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. true
AlwaysValidServerCert Disables the use of SSL certificates for inter-component connections in the Hub. Must be set to false for production or QA deployments. false
CompilationDebug Enables debugging in a deployment. Must be set to false for production or QA deployments. false
SigningCertificateThumbprint The thumbprint of the Identity Server signing certificate. The certificate must be present in the LocalMachine\TrustedPeople store. See How to: Retrieve the Thumbprint of a certificate for more information. (Specific certificate thumbprint hexadecimal value)

ApacheDS Setting

Settings that control the connection between HotDocs Hub and ApacheDS.

Parameter Name Description Example Data
ApacheDS The URI of the ApacheDS host. Must be the address of the ApacheDS instance installed during the Hub installation process.  
ApachePort The post used by the ApacheDS host. Must be the port configured during the ApacheDS installation process.  
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.  
ApacheUseSSL Enables the use of SSL with ApacheDS. The default value is false. false

 

E-mail Settings

Settings that control e-mails sent from the HotDocs Hub to users.

Parameter Name Description Example Data
EmailHost The URI of the SMTP e-mail server used by HotDocs Hub.  
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

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
HdCoreServiceUrl The URL of the HotDocs Cloud Services instance used to generate interviews. https://europe.hotdocs.ws/hdcs/
CSRegion The name of the region where the Cloud Services instance is installed. Europe
CSSubscriberId The Subscriber ID used by the client to access Cloud Services. The ID is set in the Cloud Services Portal. ExampleSubscriberId
CSKey The Signing Key used by the client to access Cloud Services.  The Key is set in the Cloud Services Portal. ExampleSigningKey