1. Installation setup
The installation of the Identity Server is a key step in establishing secure and centralized authentication for your environment. It acts as the core component responsible for managing user identities, authentication processes, and access control. This article provides a step-by-step guide to installing the Identity Server, along with the necessary prerequisites and configuration guidelines to ensure a smooth and secure setup.
System requirements
Hardware requirements
- Operating System: Windows Server 2012, 2016, 2019, 2022
- Hard Drive: 512 GB to 1 TB Fast drive recommended – ideally SSD.
- CPU: Minimum of 4 cores, operating at 3 GHz or higher.
- RAM: At least 8 GB.
- Private mode Communication – Windows Server 2022 Build 20348 or later.
Network Prerequisites
- Required Allow-Listing (Domain)
- Identity Server domain
- If you use MFA (Multifactor Authentication) – https://mfa.visual-guard.com/
- Protocol & Ports : HTTPS/TLS over TCP port 443 (outbound) – Incase you use a customised port then ensure to whitelist that port number. This helps in communicating to any VG component or your business application.
- DNS Resolution: All servers should be able to resolve each other via the hostname and Fully Qualified Domain Name (FQDN)
- Latency & Performance: Ensure low network latency between application and repository.
- Proxy / VPN Considerations
- If a proxy is used then configure exceptions for Visual Guard services
- If VPN is used then ensure stable and uninterrupted connection and verify routing allows access to repository/database
- Testing Connectivity: Before deployment, validate:
- Database connectivity from application server
- API/service accessibility
- Port availability (telnet / test tools)
Software requirements
- Web browser with JavaScript support.
- .Net 8, you can download the hosting bundle from the ASP.NET Core Runtime 8.0.7 section from the official Microsoft website. (https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
- VGRepository
- Require SQL Server 2012 or later, with a minimum of the Standard Edition.
- Require Oracle Database with Oracle9i or later. Please ensure the Oracle Driver is installed.
- IIS with the necessary Windows features should be installed as described below.
Install Internet Information Services (IIS): IIS is a web server software package designed for Windows. It’s used for hosting websites and other content on the web. You can install it through the “Turn Windows features on or off” menu in the Control Panel. The below screenshot shows which functions should be checked and vice verse.


IIS Guidelines
The Visual Guard WebConsole needs to be installed on your server. Follow these steps for a successful installation:
Step 1: Go to Application Pool → Right-click on Application Pool → Add Application Pool → Enter Name → Set the .NET CLR version to No Managed Code → click [Ok].

Step 2: Navigate to Application Pools → Verify your Application is created.

Step 3: Right-click on Sites → Enter Site name → Select the Application Pool you created → Specify the physical path (preferably C:\inetpub\wwwroot\[name of the folder you have created]) → Adjust the port number if necessary → click [Ok].

Step 4: Select the Site → Under the IIS section → Open Authentication → Enable Windows Authentication.

Step 5: Go to the Site created –> right click and select Edit Permissions –> go to the security tab –> Select IIS_IUSRS –> allow all permissions –> click Apply and OK

SQL Server settings
To provide appropriate login rights to create a new repository, follow the below steps to be configured in the SQL server platform.
Step 1: Go to the user properties in the SQL server, select master under the default database –> Click OK

Step 2: Under the user properties, select Server roles –> Select dbcreator and public to provide roles rights –> Click OK

Installation Steps
Step 1: Download Visual Guard Identity Server setup and follow the installation wizard

Step 2: Enter the required information, Site, Application pool and click Next

Step 3: Installation process will begin

Step 4: Once installation is complete, you will be notified with a message confirming the successful setup. Please click “Close” to exit the setup.

Check the application root path –> Select ‘web.config’ , please make sure it contains the following values:
<aspNetCore processPath="dotnet" arguments=".\Novalys.VisualGuard.Tools.VGIdentityServer.dll" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdosut">
<environmentVariables />
</aspNetCore>
1.1 How to migrate from VGServer ?
The VGServer has been replace by Visual-Guard Identity Server.
VG Identity Server works with the bearer Token, the VGToken, which is contained inside of the claims.
We need to authenticate from VG Identity Server
The API has been updated.
Please refer to the following list to find out how to update the API:
- /Security/Principal/GetIdentity replace by /api/Principal/GetIdentity
- /Security/GetRoles replace by /api/Principal/GetCurrentRoles
- /Security/IsInRoleByName/ replace by /api/Principal/IsInRoleByName
- /Security/HasPermissionByName/ replace by /Security/HasPermissionById/
- /Security/GetPermissions replace by /api/Principal/GetCurrentPermissions
1.2 Configure HTTPS Binding
HTTPS binding is the configuration that allows a website hosted on a web server, like Microsoft IIS (Internet Information Services), to use the HTTPS protocol. HTTPS stands for Hypertext Transfer Protocol Secure, and it ensures that data transmitted between the web server and the client (like a web browser) is encrypted and secure from eavesdropping or tampering.
When you set up HTTPS binding in IIS, you’re telling the web server to listen for HTTPS requests on a specific IP address and port (usually port 443). This binding also requires an SSL/TLS certificate, which is used to encrypt the data. The certificate is linked to the binding, ensuring that any request to the site using HTTPS will be securely transmitted.
HTTPS binding is a key configuration step in securing web applications by enabling encrypted communication between the server and clients.
To configure an IIS website for HTTPS binding with a certificate specifically for the Visual Guard Identity Server, follow these steps:
1. Obtain an SSL Certificate
- Ensure you have a valid SSL certificate issued by a trusted Certificate Authority (CA). This certificate must include both the public and private keys.
2. Install the SSL Certificate on the Server
- Open IIS Manager on the server where Visual Guard Identity Server is installed.
- In the left-hand Connections pane, click on the server name.
- Double-click on Server Certificates in the middle pane.
- In the Actions pane on the right, click Import if you have the .pfx file or Complete Certificate Request if you have a .cer file.
- Browse to your certificate file, provide any required password (for .pfx), and complete the import process.
3. Configure HTTPS Binding for Visual Guard Identity Server
- In IIS Manager, expand the server node, then expand Sites, and select Visual Guard Identity Server site.
- Click on Binding in the right-hand Actions pane under Edit Site.
- In the Site Bindings window, click Add.
- In the Add Site Binding dialog:
- Type: Select https.
- IP address: Choose the appropriate IP address or leave it as All Unassigned.
- Port: Enter 443 (default port for HTTPS).
- Host name: Optionally specify the hostname if applicable.
- SSL certificate: Select the SSL certificate you imported earlier.
- Click OK to add the binding.

4. Enforce HTTPS on Visual Guard Identity Server (Optional)
- Select the Visual Guard Identity Server site in IIS Manager.
- Double-click SSL Settings in the feature view.
- Check the box labeled Require SSL to enforce HTTPS.
- Click Apply in the Actions pane on the right.

5. Restart the IIS Services
- After configuring HTTPS binding, restart IIS to apply the changes. Select the server node in IIS Manager and click Restart in the Actions pane.
6. Test the Configuration
- Open a web browser and navigate to your Visual Guard Identity Server using
https://yourdomain.com/identityserver. Ensure that the connection is secured by the certificate and that the site loads correctly over HTTPS.
By following these steps, you will ensure that the Visual Guard Identity Server is properly configured to use HTTPS, securing communication between users and the web application.
1.3 Update Identity Server
Updating the VG Identity Server is essential to ensure secure authentication, improved performance, and compatibility with the latest system enhancements. Regular updates help protect your environment from vulnerabilities while introducing new features and stability improvements. This article outlines the steps required to update the VG Identity Server, along with important prerequisites and best practices to ensure a smooth and reliable upgrade process.
Prerequisites
Before beginning the update process, ensure you have:
- Confirmed that your environment meets the system requirements
- Administrative access to the IIS server
- The same version of VG Desktop should be installed as the new VG Identity Server version
Update Procedure
Step 1: Download Visual Guard Identity Server Setup File
Download Visual Guard Identity Server setup for the version you want to deploy.
If needed, request it from your usual Visual Guard contact or support channel.
Step 2: Version Compatibility Check
Verify that you have the same version of VG Desktop installed as the new VG Identity Server version you plan to deploy.
Version mismatches can cause compatibility issues.
Step 3: Stop the Identity Server Service
- Open Internet Information Services (IIS) Manager
- Select your Site
- Click [Stop] to stop the VG Identity Server service

Step 4: Access Application Files
Click the [Explore] button in the Actions section to open the publish files directory.

Step 5: Backup and Clear Existing Files
- Create a backup of the current publish folder
- Delete all files and folders in the publish folder
Important: Always maintain a backup before proceeding with file deletion to enable rollback if needed.

Step 6: Deploy New Files
Copy all files and folders from the downloaded publish directory and paste them into the existing publish folder (application folder).
Step 7: Restart the Service
Return to IIS Manager and click [Start] to restart the VG Identity Server service

Step 8: Verify the Update
Click Browse* 0000(http) in the Browse Website section to verify that the updated application is running correctly.












































































































