Setting Up Web Access

The Web Console is a web-based application that allows end-users to manage their data, as well as to perform other useful operations such as reporting and management of virtual machines.

The Web Server and Web Console components are needed to set up your environment. By default, these components are automatically selected during the installation of the CommServe software on a production server where IIS is enabled.

If the CommServe computer did not have IIS enabled or if you want to install the Web Server and Web Console separately, select the setup configuration that meets your needs:

Method 1: Install Web Server and Web Console in the Same Computer

Use this procedure to install the Web Server and Web Console in a dedicated server in which no other CommCell component is installed.

Method 2: Install Web Server and Web Console on Different Computers

Use this procedure to Install the Web Server on a dedicated server and the Web Console on a computer outside the organization's network. This procedure sets up the Web Console in a perimeter network to provide global access for external users.

Method 1: Install Web Server and Web Console in the Same Computer

The following procedure describes the steps to install the Web Server and Web Console in the same computer.

Where to Install

To offload the CommServe host, install these components on a separate computer.

Ensure that IIS is enabled on the computer where the software will be installed.

The computer will be added as a client in the CommCell as soon as the installation completes successfully.

If you want to allow Single Sign On (SSO) for users from domains that are not trusted, ensure to install the Web Console on those domains. This applies when you have multiple domains in your environment where some of them are not trusted.

Before You Begin

System Requirements

Verify that the computer in which you wish to install the software satisfies the minimum requirements specified in the following:

Download Software Packages

Download the latest SnapProtect® software using the Download Manager application. The Download Manager bundles an installation package from the SnapProtect components that you chose to download. Use the installation package to launch the software installer on a client computer.

See Download Manager - Getting Started for instructions on creating an installation package.

Install Web Server and Web Console

  1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
  2. Run SetupAll.exe from the installation package that was created using the Download Manager.
  3. Click I accept the terms in the license agreement.

    Click Next.

  4. Click Custom.

    Click Next.

  5. Click Select components to install on this computer and click Next.

  6. Select the following components:
    • Expand Consoles and select Web Console.
    • Expand Server Modules and select Web Server.

    Click Next.

  7. Click Next.

  8. Verify the default location for software installation.

    Click Next.

    If necessary, click Browse... to change the default location.

    • Do not install the software to a mapped network drive
    • Do not use the following characters when specifying the destination path: / : * ? " < > | #
    • It is recommended that you use alphanumeric characters only

  9. Click Install.

    • The Search Advanced Document Type Support package is installed along with Web Server.
    • The Summary on your screen should list the components that you selected to install, and might look different from the example shown.

  10. Click Yes.

  11. Click Next.

  12. Enter the SQL Server System Administrator password.

    Click Next.

    • This is the password for the Administrator's account created by the SQL Server during installation. Note down this password because you will need it to log on to the SQL Server.
    • Make sure that you include special characters and numbers to create a strong password.

  13. Verify the default Installation Path for the Database Engine.

    Click Browse... to change the default location.

    Click Next.

    • This is the location where you want to set up the Microsoft SQL Server System databases.
    • The install program installs the SQL database instance.

  14. Verify the installation path for the Microsoft SQL Server.

    Click Browse to change the default location, and then click Next.

    This step might take several minutes to complete.

  15. Select one of the following:

    • If firewall configuration is not required, click Next.
    • If this computer and the CommServe is separated by a firewall, click Configure firewall services.

    For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.

  16. Enter the fully qualified domain name of the CommServe in the CommServe Host Name box.
    • Do not use space and the following characters when specifying the CommServe Host Name:

      \|`~!@#$%^&*()+=<>/?,[]{}:;'"

    Click Next.

  17. Enter the following:
    • The local (NetBIOS) name of the client computer is displayed in the Select a Client name list.

      If necessary you can also type a new (friendly) name for the client in this box. This name will be used in the CommCell and will also be displayed in the CommCell Console.

      Do not use spaces when specifying a new name for the client.

    • The default network interface name of the client computer is displayed if the computer has only one network interface (NIC card).

      If the computer has multiple network interfaces, select the interface name that is preferred for communication with the CommServe.

    Click Next.

    If a component is already installed on this computer, this screen will not be displayed; instead, the install program will use the same name as previously specified.

  18. Enter the user name and password of CommCell user that has Administrative capabilities.

    This step authenticates the credentials of the CommCell user and verifies the administrative capabilities to proceed with the installation.

  19. This screen will be displayed if the default port 80 used by the Web Console is used by another application.

    Specify the port number to be used by the Web Console in the Web console port number box. Write down the port number that you specified as it will be used to access the Web Console after installation

    Click Next.

    • Ensure that the port number you specify is not already used by another service or application.
    • The ComplianceSearch console port number option is not applicable for setting up the Web Console.

  20. Select Add programs to the Windows Firewall Exclusion List, to add CommCell programs and services to the Windows Firewall Exclusion List.

    Click Next.

    This option enables CommCell operations across Windows firewall by adding CommCell programs and services to Windows firewall exclusion list.

    It is recommended to select this option even if Windows firewall is disabled. This will allow the CommCell programs and services to function if the Windows firewall is enabled at a later time.

  21. Select one of the following:
    • Click Use Cell level Policy to inherit the global filter policy configuration set for the CommCell.
    • Click Always use Global Filters to apply the global filters policy to the default subclient regardless of the policy set for the CommCell.
    • Select Do not use Global Filters if you plan to define specific filters for the Agent.

    Click Next.

    This global filter policy can be used by end-users to perform backups of laptops or desktops using the Web Console.

  22. Select a storage policy from the Storage Policy list to allow the backups of this computer.

    Click Next.

  23. Verify the path to the SQL Server database files.

    Click Browse to change the default location.

    Click Next.

    • Ensure that the drive has at least 1GB of free space.
    • Do not specify a mapped network drive or a FAT drive.
    • Do not save the database files to a compressed drive.

  24. Click Finish.

    This screen will reflect the components you selected for install, and may look different from the example shown.

Congratulations - You have successfully installed the Web Server and Web Console

The Web Console provides access to many operations. In some cases, certain operations may require you to update the internal properties of the Web Console. Most of these properties reside in the <Software Installation Directory>\WebConsole\WEB-INF\classes\config.properties file. Except for this file, we do not recommend to modify any other file in the WebConsole directory.

Method 2: Install Web Server and Web Console on Different Computers

You can install these components on separate computers in the following scenario:

  • The Web Console needs to be set up on dedicated host located in the perimeter network, separate from the Web Server.
  • The Web Server is deployed on a different computer to offload the CommServe from web server processes.

Where to Install

Install the Web Server on a dedicated server in which no other CommCell component is installed and ensure that IIS is enabled.

Install the Web Console on a computer that can connect to the Web Server and CommServe.

The computer will be added as a client in the CommCell as soon as the installation completes successfully.

If you want to allow Single Sign On (SSO) for users from domains that are not trusted, ensure to install the Web Console on those domains. This applies when you have multiple domains in your environment where some of them are not trusted.

Before You Begin

System Requirements

Verify that the computer in which you wish to install the software satisfies the minimum requirements specified in the following:

Download Software Packages

Download the latest SnapProtect® software using the Download Manager application. The Download Manager bundles an installation package from the SnapProtect components that you chose to download. Use the installation package to launch the software installer on a client computer.

See Download Manager - Getting Started for instructions on creating an installation package.

Install the Web Server

  1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
  2. Run SetupAll.exe from the installation package that was created using the Download Manager.
  3. Click I accept the terms in the license agreement.

    Click Next.

  4. Click Custom.

    Click Next.

  5. Click Select components to install on this computer and click Next.

  6. Expand Server Modules and select Web Server.

    Click Next.

  7. Click Next.

  8. Verify the default location for software installation.

    Click Next.

    If necessary, click Browse... to change the default location.

    • Do not install the software to a mapped network drive
    • Do not use the following characters when specifying the destination path: / : * ? " < > | #
    • It is recommended that you use alphanumeric characters only

  9. Click Install.

    • The Search Advanced Document Type Support package is installed along with Web Server.
    • The Summary on your screen should list the components that you selected to install, and might look different from the example shown.

  10. Click Yes.

  11. Click Next.

  12. Enter the SQL Server System Administrator password.

    Click Next.

    • This is the password for the Administrator's account created by the SQL Server during installation. Note down this password because you will need it to log on to the SQL Server.
    • Make sure that you include special characters and numbers to create a strong password.

  13. Verify the default Installation Path for the Database Engine.

    Click Browse... to change the default location.

    Click Next.

    • This is the location where you want to set up the Microsoft SQL Server System databases.
    • The install program installs the SQL database instance.

  14. Verify the installation path for the Microsoft SQL Server.

    Click Browse to change the default location, and then click Next.

    This step might take several minutes to complete.

  15. Select one of the following:

    • If firewall configuration is not required, click Next.
    • If this computer and the CommServe is separated by a firewall, click Configure firewall services.

    For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.

  16. Enter the fully qualified domain name of the CommServe in the CommServe Host Name box.
    • Do not use space and the following characters when specifying the CommServe Host Name:

      \|`~!@#$%^&*()+=<>/?,[]{}:;'"

    Click Next.

  17. Enter the following:
    • The local (NetBIOS) name of the client computer is displayed in the Select a Client name list.

      If necessary you can also type a new (friendly) name for the client in this box. This name will be used in the CommCell and will also be displayed in the CommCell Console.

      Do not use spaces when specifying a new name for the client.

    • The default network interface name of the client computer is displayed if the computer has only one network interface (NIC card).

      If the computer has multiple network interfaces, select the interface name that is preferred for communication with the CommServe.

    Click Next.

    If a component is already installed on this computer, this screen will not be displayed; instead, the install program will use the same name as previously specified.

  18. Select one of the following options:

    • If you do not want to disable Windows Firewall, click Next.
    • If you want to disable Windows Firewall for all profiles, click Yes, disable Windows Firewall for all profiles and then click Next.

  19. Enter the user name and password of CommCell user that has Administrative capabilities.

    This step authenticates the credentials of the CommCell user and verifies the administrative capabilities to proceed with the installation.

  20. Select one of the following:
    • Click Use Cell level Policy to inherit the global filter policy configuration set for the CommCell.
    • Click Always use Global Filters to apply the global filters policy to the default subclient regardless of the policy set for the CommCell.
    • Select Do not use Global Filters if you plan to define specific filters for the Agent.

    Click Next.

  21. Select a storage policy from the Storage Policy list to allow the backups of this computer.

    Click Next.

  22. Verify the path to the SQL Server database files.

    Click Browse to change the default location.

    Click Next.

    • Ensure that the drive has at least 1GB of free space.
    • Do not specify a mapped network drive or a FAT drive.
    • Do not save the database files to a compressed drive.

  23. Click Yes.

  24. Click Finish.

    This screen will reflect the components you selected for install, and may look different from the example shown.

The Web Server is successfully installed. Proceed to install the Web Console on a separate computer outside the company network

Install the Web Console

  1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
  2. Run SetupAll.exe from the installation package that was created using the Download Manager.
  3. Click I accept the terms in the license agreement.

    Click Next.

  4. Click Custom.

    Click Next.

  5. Click Select components to install on this computer and click Next.

  6. Expand Consoles and select Web Console.

    Click Next.

  7. Verify the default location for software installation.

    Click Next.

    If necessary, click Browse... to change the default location.

    • Do not install the software to a mapped network drive
    • Do not use the following characters when specifying the destination path: / : * ? " < > | #
    • It is recommended that you use alphanumeric characters only

  8. Click Install.

    The Summary on your screen should reflect the components you selected for install, and may look different from the example shown.

  9. Click Yes.

  10. Click Next.

  11. Select one of the following:

    • If firewall configuration is not required, click Next.
    • If this computer and the CommServe is separated by a firewall, click Configure firewall services.

    For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.

  12. Enter the fully qualified domain name of the CommServe in the CommServe Host Name box.
    • Do not use space and the following characters when specifying the CommServe Host Name:

      \|`~!@#$%^&*()+=<>/?,[]{}:;'"

    Click Next.

  13. Enter the following:
    • The local (NetBIOS) name of the client computer is displayed in the Select a Client name list.

      If necessary you can also type a new (friendly) name for the client in this box. This name will be used in the CommCell and will also be displayed in the CommCell Console.

      Do not use spaces when specifying a new name for the client.

    • The default network interface name of the client computer is displayed if the computer has only one network interface (NIC card).

      If the computer has multiple network interfaces, select the interface name that is preferred for communication with the CommServe.

    Click Next.

    If a component is already installed on this computer, this screen will not be displayed; instead, the install program will use the same name as previously specified.

  14. This screen will be displayed if the default port 80 used by the Web Console is used by another application.

    Specify the port number to be used by the Web Console in the Web console port number box. Write down the port number that you specified as it will be used to access the Web Console after installation

    Click Next.

    • Ensure that the port number you specify is not already used by another service or application.
    • The ComplianceSearch console port number option is not applicable for setting up the Web Console.

  15. Select one of the following options:

    • If you do not want to disable Windows Firewall, click Next.
    • If you want to disable Windows Firewall for all profiles, click Yes, disable Windows Firewall for all profiles and then click Next.

  16. Select Add programs to the Windows Firewall Exclusion List, to add CommCell programs and services to the Windows Firewall Exclusion List.

    Click Next.

    This option enables CommCell operations across Windows firewall by adding CommCell programs and services to Windows firewall exclusion list.

    It is recommended to select this option even if Windows firewall is disabled. This will allow the CommCell programs and services to function if the Windows firewall is enabled at a later time.

  17. Select one of the following:
    • Click Use Cell level Policy to inherit the global filter policy configuration set for the CommCell.
    • Click Always use Global Filters to apply the global filters policy to the default subclient regardless of the policy set for the CommCell.
    • Select Do not use Global Filters if you plan to define specific filters for the Agent.

    Click Next.

  18. Select a storage policy from the Storage Policy list to allow the backups of this computer.

    Click Next.

  19. Select the computer where the Web Server is installed from the Select Web Server client name list.

  20. Click Finish.

    This screen will reflect the components you selected for install, and may look different from the example shown.

Congratulations - You have successfully installed the Web Server and Web Console. Proceed to perform Post-Installation Configurations.

The Web Console provides access to many operations. In some cases, certain operations may require you to update the internal properties of the Web Console. Most of these properties reside in the <Software Installation Directory>\WebConsole\WEB-INF\classes\config.properties file. Except for this file, we do not recommend to modify any other file in the WebConsole directory.