SigningHub Desktop Web

Make the following changes in the appsettings.Production.json json file to configure Application Settings for SigningHub Desktop Web.

---

Client ID and Secret for authentication:

The SigningHub API requires both a Client ID and Client Secret to authenticate and authorise the SigningHub web application. The following section in appsettings.production.json is mandatory and is automatically configured by the SigningHub installer during installation:

"Credentials": {
  "ClientId": "[Client_ID]",
  "ClientSecret": "[Client_Secret]"}

---

SigningHub API URL:

The URL of the SigningHub API must be specified in appsettings.Production.json. This URL is also configured by the SigningHub installer during installation:

"Services": {
  "Authentication": "[Signinghub_API]"}

---

Client App configuration:

The URL of the SigningHub API and SigningHub Desktop Web must be specified in the env.js. This env.js file can be found at the following path: \web\wwwroot\assets\env.js

window['env']['baseURL'] = '[API_URL]';
window['env']['localGatewayURL'] = '[WEB_URL]';

1. Please update the below-mentioned placeholders for Client App Configuration:

   1. [API_URL]: To be replaced with the URL of the SigningHub API

   2. [WEB_URL]: To be replaced with the URL of the SigningHub Desktop Web

---

Proxy Handling for API Communication:

SigningHub now supports proxy-aware deployments by allowing proxy settings to be configured directly in the appsettings.Production.json file. This ensures the SigningHub Web Gateway can communicate with the API through a proxy when required. The following configuration section can be used:

"Proxy": {
  "Enabled": false,
  "BypassLocal": true,
  "Address": "[PROXY_URL]",
  "Username": "",
  "Password": ""
}

By default, Enabled is set to false, meaning the application connects directly to the API without using a proxy. To enable proxy support, set Enabled to true and provide the necessary proxy address and credentials. The BypassLocal flag is set to true by default to skip proxy routing for local API addresses (e.g., localhost). If local traffic should also go through the proxy, set this flag to false, and ensure that the proxy server is accessible locally.

---

Disable Basic Deep Linking:

In certain cases—such as when the SigningHub mobile application is not installed on your device—attempting to open SigningHub links from email on browsers may result in an error message or pop-up. This happens because the mobile web attempts to invoke the SigningHub mobile app via universal links.

To provide a smoother experience for users accessing SigningHub on mobile browsers without the mobile app installed, basic deep linking can be disabled by setting the following configuration in appsettings.Production.json:

"AppSettings": {
  "DisableBasicDeepLinking": "true"
}

When this option is enabled (true), browsers will no longer attempt to open the SigningHub mobile app via universal link redirection, thus avoiding the error messages and fallback behaviour.