> For the complete documentation index, see [llms.txt](https://docs.guardware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.guardware.com/setup-and-deploy/install-guardware-server/install-guardware-management-console.md). # Install GuardWare Management Console {% hint style="warning" %} Ensure you have acquired the GuardWare Management Console Installer from GuardWare or your Managed IT Service Provider before proceeding. {% endhint %} The GuardWare Management Console is the central platform that coordinates the operation of GuardWare DISCOVER, INSIGHT, and PROTECT across your organisation. From a single interface, you can deploy agents, define policies, schedule scans, monitor data activity, and receive alerts when anomalies or policy violations are detected. This guide walks through the complete installation process, covering all necessary dependencies and configurations. ## System Requirements Ensure the device hosting the Management Console meets the following requirements and has sufficient privileges to install required software and configure the server.

Organisation Size Operating System CPU Cores Memory (RAM) Disk Space Network Ports

Organisation Size	Operating System	CPU Cores	Memory (RAM)	Disk Space	Network Ports
Small to Medium (1–1,000 clients)	Microsoft Windows Server 2019 or later (64-bit), fully updated with all patches	8 cores	16 GB	500 GB–1 TB	`443` `3306` `6379`
Large (1,001–5,000 clients)	Microsoft Windows Server 2019 or later (64-bit), fully updated with all patches	12 cores	32 GB	2 TB	`443` `3306` `6379`
Enterprise (5,000+ clients)	Microsoft Windows Server 2019 or later (64-bit), fully updated with all patches	Contact GuardWare support	Contact GuardWare support	Contact GuardWare support	Contact GuardWare support

Small to Medium (1–1,000 clients)

Microsoft Windows Server 2019 or later (64-bit), fully updated with all patches

8 cores

16 GB

500 GB–1 TB

443

3306

6379

Large (1,001–5,000 clients)

Microsoft Windows Server 2019 or later (64-bit), fully updated with all patches

12 cores

32 GB

2 TB

443

3306

6379

Enterprise (5,000+ clients) Microsoft Windows Server 2019 or later (64-bit), fully updated with all patches Contact GuardWare support Contact GuardWare support Contact GuardWare support Contact GuardWare support

## Pre-Installation Requirements The following software dependencies must be installed on the Management Console host before proceeding. Each component supports a specific aspect of GuardWare's server functions. You can download the installer files from their official websites by jumping to the desired section below and following the links there.

Component	Purpose
Microsoft Visual C++ Redistributable	Required to run applications built with Visual C++ libraries, including runtime components used by MySQL and its associated services.
MySQL (v8.4.4 or higher)	Serves as the database backend for GuardWare. It stores configuration details, encryption metadata, user profiles, and other operational data.
Redis (8.0 or higher)	Used as an in-memory cache and message broker to support real-time processing and improve system performance.
OpenSSL (3.6.0 Light)	Provides SSL/TLS certificate generation for HTTPS access and cryptographic operations. Used to create self-signed certificates or prepare certificates for Azure integration.
IIS (Internet Information Services)	Required to run GuardWare components and handle all HTTPS requests.
IIS URL Rewrite Module	Ensures all incoming requests are routed correctly through GuardWare, enabling proper handling of application paths and APIs.
Application Request Routing	Acts as a reverse proxy between users and the GuardWare application, routing Management Console requests to the correct backend port and proxying WebSocket connections
7-Zip (26.01 or higher)	Required to compress and protect files generated by the server.

{% stepper %} {% step %} ## Install Microsoft Visual C++ Redistributable The Microsoft Visual C++ Redistributable contains runtime libraries required by MySQL and its associated services to function correctly on Windows. Without the Visual C++ Redistributable, the MySQL installation will fail, or MySQL services will not start, preventing GuardWare from accessing its database. 1. Download Microsoft Visual C++ Redistributable from [**Microsoft’s official website**](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version).

2. Double-click the Microsoft Visual C++ Redistributable installer file to begin the installation. 3. Read and accept the licence terms and conditions and click **Install**.

4. Click **Restart** to reboot the device and complete the installation process. {% endstep %} {% step %} ## Install and Configure MySQL MySQL is a relational database management system that serves as GuardWare's central data repository. Every time you modify configuration settings, manage user permissions, or perform operations through the Management Console, that information is written to and retrieved from the MySQL database. The database does not store actual files or sensitive data from your environment. 1. [**Visit MySQL**](https://downloads.mysql.com/archives/community/), download the installer file for MySQL (v8.4.4 or later). 2. Click **Download** to save the MSI installer.

3. Locate the MSI installer, double-click it to launch MySQL Server Setup, then click **Next**. 4. Read and accept the End User Licence Agreement (EULA) and click **Next.**

5. When selecting the setup type, you have the option to choose between:

Installation type	Description
Typical	Installs the server, client, and essential tools quickly. Provides everything GuardWare needs without extra components.
Complete	Includes all optional components, sample databases, and documentation. Larger footprint.

6. Select **Typical** or **Complete** and click **Next**.

7. Click **Install** to begin the installation.

8. Select **Run MySQL Configurator** to launch it automatically after clicking **Finish**, then proceed to step 10.

9. If **Run MySQL Configurator** was not selected, search for **MySQL Configurator** in **Search** and click **Open**.

10. Click **Next** on the Welcome screen.

11. Select a path to the data directory. You can browse the path by clicking the button beside the dialogue box. This is where MySQL will store all database files, including the GuardWare database. Ensure the selected location has sufficient space for database growth as scan history accumulates. Click **Next**.

12. In the **Type and Networking** window, keep the default settings and note down the assigned port number. The default port is **3306**. You will need this port number when configuring the GuardWare Server to connect to MySQL. Click **Next**.

13. The root account has full administrative privileges over all MySQL databases. Set a strong password and click **Next**.

{% hint style="info" %} You will require the **username (root)** and **password** created here during the GuardWare Management Console installation process. Store these credentials securely. {% endhint %} 14. In **Windows Service**, enable **Configure MySQL Server as a Windows Service** and **Start the MySQL Server at System Startup**, then click **Next**. This ensures MySQL starts automatically when the server boots, so GuardWare can always access the database without manual intervention.

15. Adjust file permission settings as required for your environment (default is **Yes, grant full access**), and click **Next**.

16. Skip the sample database creation and click **Next**.

17. Review the summary and click **Execute** to apply the configurations.

18. After configuration completes, click **Next** and click **Finish** to exit the configurator. MySQL is now installed and running as a Windows service, ready to store GuardWare's operational data. ### Add MySQL to System PATH After installing MySQL on Windows, the `bin` folder (e.g., `C:\Program Files\MySQL\bin`) must be added to the system PATH environment variable. PATH tells Windows where to look for executables when you type a command in Command Prompt. Without this, you would need to specify the full path each time. 1. Open **Run**, enter `sysdm.cpl`, and click **OK**.

2. Go to **Advanced** and click **Environment Variables.**

3. In the **System Variables** section, search for **Path** and click **Edit.**

4. Click **New** and enter the MySQL path `C:\Program Files\MySQL\MySQL Server 8.4\bin` to the system PATH environment variable.

5. Click **OK** on all windows to save the changes. 6. To verify MySQL is correctly added to PATH, open a new Command Prompt window and type `mysql --version`. The MySQL version will be displayed.

{% endstep %} {% step %} ## Install Redis Redis is an in-memory data store that GuardWare uses as a cache and message broker. It temporarily stores frequently accessed data so the Management Console can retrieve it without querying the MySQL database on every request. 1. [**Download Redis**](https://github.com/redis-windows/redis-windows/releases) version 8.0.0 or above.

2. Locate the zip file, right-click and select **Extract All...** 3. Save the folder to `C:\Program Files` directory and click **Extract**.

4. Rename the folder `Redis` for accessibility, as the name will be required to execute another command in Command Prompt. ### Add Redis to System PATH 1. Press `key + R` to open **Run** and type `sysdm.cpl` to open **System Properties**.

2. Go to **Advanced** and click **Environment Variables**.

3. Select **Path** in **System Variables** and click **Edit.**

4. Click **New,** enter the path of the **Redis** folder in the field `C:\Program Files\Redis` and click **OK** to save.

5. Click **OK** on all to close **System Properties**. 6. Open **Run** again, type `cmd` and press `Ctrl + Shift + Enter` to open the **Command Prompt with elevated access**. 7. Type or paste the following commands line-by-line and press **Enter** each time to execute: The first command installs Redis as a service, the second checks whether the service is running, and the third checks the installed version. {% code overflow="wrap" %} ```powershell "C:\Program Files\Redis\RedisService.exe" install -c "C:\Program Files\Redis\redis.conf" sc query Redis "C:\Program Files\Redis\redis-cli.exe" --version ``` {% endcode %}

8. Close the **Command Prompt** window. {% endstep %} {% step %} ## Install OpenSSL OpenSSL is a cryptographic toolkit used to generate and manage SSL/TLS certificates for secure communications. When uploaded to Azure Entra ID and associated with an App Registration, the certificate allows GuardWare to authenticate with Azure services without using client secrets. 1. Download [**Win32/64 OpenSSL for Windows**](https://slproweb.com/products/Win32OpenSSL.html) (Win64 OpenSSL v3.6.0 Light or higher recommended).

2. Locate the installer (`.msi` or `.exe`) and double-click to launch it. 3. Read and accept the licence agreement and click **Next**.

4. Select the installation directory (default: `C:\Program Files\OpenSSL-Win64\`) and click **Next**.

5. Select a location to store the program’s shortcuts and click **Next.**

6. In the **Select Additional Tasks** window, choose **The OpenSSL binaries (/bin) directory**. This copies the OpenSSL DLL files to the OpenSSL installation folder rather than the Windows system directory. Click **Next**.

7. Click **Install** to begin the installation.

8. Click **Finish** to exit the setup wizard. ### Add OpenSSL to System PATH After installing OpenSSL on Windows, the `bin` folder (e.g., `C:\Program Files\OpenSSL-Win64\bin`) must be added to the system PATH environment variable. PATH tells Windows where to look for executables when you type a command in Command Prompt. Without this, you would need to specify the full path to `openssl.exe` each time. Once added to PATH, you can run commands such as `openssl version` and the certificate generation commands required in later steps. 1. Press `key + R` to open **Run**, type `sysdm.cpl`, and click **OK**.

2. Go to **Advanced** and click **Environment Variables**

3. In the **System Variables** section, search for **Path** and click **Edit.**

4. Click **New** and enter the OpenSSL path `C:\Program Files\OpenSSL-Win64\bin` to the system PATH environment variable.

5. Click **OK** on all windows to save the changes. 6. To verify OpenSSL is correctly added to PATH, open a new Command Prompt window and type `openssl version`. The OpenSSL version will be displayed.

{% endstep %} {% step %} ## Install IIS Internet Information Services (IIS) is Microsoft's web server platform that hosts the GuardWare Management Console. IIS receives HTTPS requests from the browser and serves the web-based interface used to access the Management Console. {% hint style="success" %} Click the tabs below to view the relevant content, or use the links provided here to navigate to the desired section. * [**Install IIS on Windows Server**](#install-iis-on-windows-server) * [**Install IIS on Windows Desktop**](#install-iis-on-windows-alternative-option) {% endhint %} {% tabs %} {% tab title="Install IIS on Windows Server" %} 1. Click the **Start** menu, search for **Server Manager,** and open it. 2. Click **Add Roles and Features** on the home screen, or click **Manage** in the top-right corner, and select **Add Roles and Features.**

3. On **Before You Begin**, click **Next.**

4. On the **Select installation type**, select **Role-based or feature-based installation,** and click **Next.**

5. On **Server Selection**, click **Select a server from the server pool,** choose the server from the list, and click **Next**.

6. On **Server Roles**, select **Web Server (IIS)** and also select the **Include Management tools (if applicable)**. Click **Add Features** to close the window, and click **Next**.

7. Click **Next** on **Features.** 8. Click **Next** on **Web Server Role (IIS)**. 9. The following features are required for GuardWare to process dynamic content through CGI, handle API requests through ISAPI extensions, compress responses for better performance, log requests for auditing, and enforce security restrictions. Expand the **Role Services** under Web Server (IIS), and add the following features:

10. Click **Next** and select **Install** to begin the installation. Wait for the installation to complete, then click **Close**. 11. Verify by opening **Run**, typing `inetmgr` to launch IIS, or navigating to `http://localhost` in a browser to confirm the IIS welcome page loads.

{% endtab %} {% tab title="Install IIS on Windows Desktop (Alternative Option)" %} 1. Open **Run,** type `optionalfeatures`, and press **Enter**.

2. Expand **Internet Information Services**.

3. Select and add the following features:

4. Click **OK** to begin the installation. Wait for the installation to complete. 5. Verify by opening **Run**, typing `inetmgr` to launch IIS, or, navigating to `http://localhost` in a browser to confirm the IIS welcome page loads.

{% endtab %} {% endtabs %} {% endstep %} {% step %} ## Install the IIS URL Rewrite Module {% hint style="info" %} Ensure [**IIS is installed**](#install-iis) before proceeding with this step. {% endhint %} The IIS URL Rewrite Module routes all incoming requests through `index.php`, enabling correct handling of application paths and API calls. It is required for the GuardWare Management Console to function under IIS. 1. [**Download the IIS URL Rewrite**](https://www.iis.net/downloads/microsoft/url-rewrite) installer (64-bit).

2. Locate the `.msi` and double-click to launch it. 3. On the **IIS URL Rewrite Module 2 Setup** welcome screen, read and accept the licence agreement. 4. Click **Install** to begin the URL rewrite process and wait until it completes.

5. Click **Finish** to exit the setup wizard. {% endstep %} {% step %} ## Install Application Request Routing (ARR) {% hint style="info" %} Ensure [**IIS is installed**](#install-iis) before proceeding with this step. {% endhint %} Application Request Routing (ARR) is an IIS extension that acts as a reverse proxy between users and GuardWare. When a request is sent to the Management Console, ARR forwards it to the GuardWare application running on the appropriate backend port and returns the response to the user. It also proxies WebSocket connections, enabling real-time communication between the Management Console and connected agents. 1. [**Download ARR**](https://www.iis.net/downloads/microsoft/application-request-routing) **(64-bit)** from Microsoft's official website.

2. Locate the `.msi` and double-click to launch it. 3. Accept the Licence Agreement and click **Install**.

4. Click **Finish** to exit the setup wizard. {% endstep %} {% step %} ## Install 7-Zip 7-Zip is a file archiving tool that GuardWare uses to compress and protect server-generated files from direct modification. 1. [**Download 7-Zip**](https://www.7-zip.org/download.html) (64-bit).

2. Locate the `.exe` and double-click to launch it. 3. Select the installation directory and click **Install**.

4. Click **Close** to exit the setup. {% endstep %} {% step %} ## Install the GuardWare Management Console The GuardWare Management Console Setup prepares the runtime environment for GuardWare and connects to MySQL. Ensure all prerequisites listed above are installed and configured before proceeding. 1. Double-click the server installer file received from [**GuardWare**](mailto:sales@guardware.com.au) or your IT service provider, and click **Next**.

2. Read and accept the EULA and click **Next**.

3. Choose a folder to install the GuardWare Server and click **Next**.

### Fresh Installation {% hint style="info" %} If you have the Management Console installed and only wish to update it, jump to [**Update Management Console**](#update-management-console). {% endhint %} 1. If installing for the first time, select **Fresh Install** and click **Next**.

2. Enter the following information on the Configure Database Connection page:

Field	Particulars	Description
DB Host	`localhost`, domain name `db.example.com` or `IP address`	Database host address location that GuardWare connects to
DB Port	`3306` (most common)	Network endpoint number that a database server uses to listen for incoming connections
DB Name	Name of the specific database you want to connect to on a database server.	Ensure the DB Name is unique to avoid conflicts with any existing MySQL databases
DB Username	`root` (default)	Database user account name that GuardWare uses to log in to the database
Password	Enter password created during the MySQL setup	DB Password is the password associated with the DB Username. It is used to authenticate and allow access to the database.

3. Click **Test Connection** to validate the connection with the database and click **Next**. 4. If you have configured a password for Redis, enter it here and click **Next**.

5. Enter the Super Admin's name, email, and password. Store these credentials securely, then click **Next**.

6. Select **https** and enter the following information:

Field	Particulars
Domain Name	The website address that users type in a browser to access the GuardWare Management Console.
Certificate	SSL/TLS certificate used to secure and encrypt HTTPS connections
Certificate Password	Password to access the SSL/TLS private key (if it is encrypted), which may be set during key generation or certificate export.

7. Click **Install** to begin the process and wait for the installation to complete. Click **Finish** to exit the setup wizard.

### Update Management Console {% hint style="warning" %} Only select update if you have installed GuardWare on your device and wish to update it. If GuardWare is not installed, and you select **Update Existing Installation**, the server installation will fail. {% endhint %} 1. Select **Update Existing Installation.**

2. Click **Test Installation Path** to check and validate the Management Console installation path, and click **Next.** 3. Click **Install** and wait until the process completes.

4. Click **Finish** to exit the setup wizard. {% endstep %} {% step %} ## Updating the Licence (On-Prem Only) This process applies primarily to banks and other high-security environments where network and data access are tightly controlled, and internet connectivity is often restricted or prohibited entirely. The licence activates GuardWare and grants access to the Management Console. It also determines which GuardWare products and modules are enabled for the client, ensuring that only licensed and required products become available to the user. 1. Obtain the new licence file from GuardWare and rename it to `license.txt` if required. 2. Open File Explorer and navigate to `C:\inetpub\wwwroot\backend`. 3. Replace the existing `license.txt` file with the new licence file. {% endstep %} {% step %} ## Log in to the Management Console After installation, the Management Console automatically opens in your default browser. 1. To open the Management Console manually, use the URL that matches how the server was configured.

Access Method URL Format Notes

Access Method	URL Format	Notes
Local access	`https://localhost/gwapp/login` `https://localhost/gwapp/<org_name>/login`	Use this when accessing GuardWare locally on the server.
Access via configured domain	`https://<domain_name>/gwapp/login` `https://<domain_name>/gwapp/<org_name>/login`	Requires the domain to resolve to GuardWare's server IP via DNS or the hosts file.

Local access

https://localhost/gwapp/login

https://localhost/gwapp/<org_name>/login

Use this when accessing GuardWare locally on the server.

Access via configured domain

https://<domain_name>/gwapp/login

https://<domain_name>/gwapp/<org_name>/login

Requires the domain to resolve to GuardWare's server IP via DNS or the hosts file.

2. Navigate to the login URL and sign in with your organisation-provided credentials or Microsoft 365 account. 3. If signing in with email credentials for the first time: 1. Set up Two-Factor Authentication by scanning the QR code with an authenticator app (Google or Microsoft Authenticator) and entering the generated verification code. 2. Update your password when prompted. 4. Accept the EULA to proceed. Once logged in, the Management Console is ready to use. [**Proceed to deploy agents**](broken://pages/yPDNQmmov2zrBbmKHQFy), configure data classification policies, and set up your organisation's GuardWare environment. {% endstep %} {% step %} ## Enable the AIP Service for MIP Protection (For PROTECT only) {% hint style="info" %} To use MIP protection, your organisation must have a Microsoft **licence** that includes Microsoft Purview Information Protection (sensitivity labelling) capabilities, such as **Microsoft 365 E3, Microsoft 365 E5, Azure Information Protection P1/P2**. {% endhint %} Before GuardWare PROTECT can use Microsoft Information Protection (MIP) for classification and protection, the **Azure Information Protection (AIP) service** must be active in your tenant. The AIP service manages the encryption and labelling framework used by MIP to protect files. You can enable and verify the AIP service by running a few PowerShell commands with administrative privileges. 1. Open PowerShell as an administrator. 2. Run the following commands in order: ```powershell #1) Install the stable version known to work Install-Module AIPService -RequiredVersion 2.0.0.3 -Force # 2) Import explicitly Import-Module AIPService -RequiredVersion 2.0.0.3 -Force # 3) Connect & check (Sign in with Global Admin/Compliance Admin account) Connect-AipService Get-AipService | Format-List ``` If the service status returns **Enabled**, MIP is ready for use with PROTECT. ![](/files/f9f140c6b9df5907b03d5bb10e46a02839564e45) If the service status returns **Disabled,** run the following command to enable the service: ![](/files/36565b2bdc56bc7668460855e86eadd76a4d2139) {% endstep %} {% endstepper %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.guardware.com/setup-and-deploy/install-guardware-server/install-guardware-management-console.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.