SigningHub Installation Guide

Note: Username and Password must not contain the following characters: [] () , ; ? * ! @ =. These characters are used to either initialize a connection or separate connection values.

The SigningHub Enterprise database schema and the version required by the installer must be the same.

If the current SigningHub Enterprise database schema is older than the version required by the installer, and you click Next, the installer will prompt you that SigningHub Enterprise database schema will be upgraded to the latest version. Click OK to authorize the schema update.

Document Storage Configurations screen will not appear if it is already configured in existing database.

Document Storage path can be a local drive, a network drive or an Azure blob. If the path is on a local drive, then the installer will automatically assign the read/write permissions to the IIS_IUSRS user group. 

If the path is on a network/Azure drive, then the permissions should be assigned manually to a user before continuing the installation process. To add the permissions on a network drive, follow these instructions:

1. Create a domain/Azure user with read/write permissions.
2. Add the read/write permissions on the directory [Document Storage Path] and complete the installation process.
3. Now go to IIS Manager and add the user created in step 1 in Application Pool against all SigningHub websites one by one as shown below (Skip this step if SigningHub Enterprise is installed by using Windows Authentication).

Configurations

Item

Description

Account Name

Account Name of the Azure.  Note this must exist prior to the installation.

Account Key

Account Key of the Azure.  Note this must exist prior to the installation.

Redis Server Configurations screen will not appear if it is already configured in existing database.

Redis is a light weight server, which works as back-plane and message broker for SigningHub application over an HTTP/s port. For further information, https://redis.io/
It is bundled within SigningHub package. SigningHub will communicate with the server on that HTTP/s port. It is like SQL Server you need to have an account on Redis server, password is optional.

1. For new instance of Redis Server we create that account with provided details automatically in New Instance screen. It will install a new instance of Redis on the current machine and the configurations will be saved in SigningHub database.
2. If by any chance you have Redis server installed or you want to use Redis server from Azure or Amazon, you need to know the app name, password and port to connect to that instance. In that case, select Existing Instance in the above screen

Item

Description

Server Address

Specify the Redis server address. This server is used to send real-time on-screen notifications for document sharing. In future will be used for cache and message broker.

Port

Specify the service port for the Redis server. It is automatically populated the available port

Redis App Name

Specify the name of Redis App. This can be any random name that will be used to identify this server in Redis console logs for monitoring or debugging.

Password

Specify the password to authenticate the Redis server.

Confirm Password

Specify the same password again as provided in the above password field to confirm it.

Redis can enforce password-based security to save or read the key value pairs from the Redis server. To enable password-based security, follow these instructions:

1. Go to [SigningHub Installation Directory]/Redis
2. Run the Redis command line interface by click on redis-cli application in administrator mode
3. Run the command CONFIG SET requirepass "[password]"
4. Sign into SigningHub Administrator account
5. Go to Configurations>Redis and change the password in Redis Server Connection String
6. Update the settings and Restart IIS

Redis can disable asking for password for saving and reading the key value pairs from the Redis server. To turn off the password, follow these instructions:

1. Go to [SigningHub Installation Director]/Redis
2. Run the Redis command line interface by click on redis-cli application in administrator mode
3. Run the command CONFIG SET requirepass ""
4. Sign into SigningHub Administartor account
5. Go to Configurations>Redis and change the password as empty in Redis Server Connection String
6. Update the settings and Restart IIS

For Load balanced deployments, only one instance of Redis is needed for SigningHub to work with. Rest of the instances of SignignHub will communicate with Redis using HTTP/s address and Port configured in SigningHub Admin.

Item 

Description 

Redis App Name

Specify the name of Redis App. This can be any random name that will be used to identify this server in Redis console logs for monitoring or debugging.

Connection String

The following is a sample connection string for a Redis Server: 

[Redis Server Address]: [port], password=[Redis Server Password],ssl=False,abortConnect=False