Skip to main content

Configure IIS and Deploy WebReports

Garrick Guillory
Updated

After Internet Information Services (IIS), the ASP.NET Hosting Bundle, and the WebReports database have been prepared, configure IIS and deploy the WebReports application.

This article covers:

  • Creating the WebReports application pool
  • Configuring the IIS website
  • Configuring HTTPS
  • Deploying the WebReports application files
  • Configuring appsettings.json
  • Launching and registering WebReports

Before You Begin

Before continuing, verify that:

  • Internet Information Services (IIS) is installed.
  • The ASP.NET Hosting Bundle is installed.
  • Your Microsoft SQL Server or MySQL database is configured.
  • You have a valid SSL certificate for the WebReports server.
  • You have the WebReports license information for your organization.
  • You have downloaded the latest WebReports installation package.

For the complete installation sequence, see:

Installing WebReports on Windows

Step 1: Open IIS Manager

  1. Open Control Panel.
  2. Go to System and Security > Windows Tools.
  3. Open Internet Information Services (IIS) Manager.

Step 2: Create the WebReports Application Pool

  1. In IIS Manager, expand the server.
  2. Select Application Pools.
  3. Right-click in the Application Pools pane and select Add Application Pool.

  1. Enter a name for the application pool.

    Example:

    WebReports

  2. Set .NET CLR version to:

    No Managed Code

  3. Click OK.

Step 3: Configure the WebReports Website

  1. Expand Sites.

  2. Select the website that will host WebReports.

    You can use Default Web Site or a separately created IIS website.

  3. In the Actions pane, select Basic Settings.
  1. Next to Application pool, click Select.
  2. Select the WebReports application pool created in the previous section.
  3. Click OK.
  4. Click OK again to save the website settings.

Step 4: Configure the Application Pool

  1. Select Application Pools.
  2. Right-click the WebReports application pool and select Recycling.
  1. Clear Regular time intervals.
  2. Click Next, and then click Finish.
  3. Right-click the WebReports application pool again and select Advanced Settings.
  4. Configure the following settings:
    • Start Mode: AlwaysRunning
    • Idle Time-out (minutes): 0
    • Idle Time-out Action: Suspend
  5. Click OK.

Step 5: Configure Authentication

If your WebReports environment will use Windows Authentication:

  1. Select the WebReports website in IIS Manager.
  2. Open Authentication.
  3. Enable Windows Authentication.
  4. Disable Anonymous Authentication.

If your WebReports environment does not use Windows Authentication, leave the authentication settings appropriate for your configured WebReports authentication method.

Step 6: Configure HTTPS

  1. Select the website that will host WebReports.
  2. In the Actions pane, select Bindings.

  1. Click Add.
  2. Configure the binding:
    • Type: https
    • IP address: Select the appropriate server IP address.
    • Port: 443, unless your environment requires a different HTTPS port.
    • Host name: Enter the DNS name used to access WebReports.
    • SSL certificate: Select the certificate assigned to WebReports.
  1. Click OK.

If an appropriate SSL certificate is not available, obtain one from your organization's Certificate Authority (CA) or certificate provider before making WebReports available to users.

Remove the HTTP Binding

If WebReports should only be accessible using HTTPS:

  1. Select the existing HTTP binding on port 80.
  2. Click Remove.
  3. Confirm the removal.
mceclip28.png

Step 7: Download and Unblock WebReports

Download the latest WebReports installation package:

Download the Latest WebReports Version

Before extracting the ZIP file, verify that Windows has not blocked it:

Unblock WebReports Files

Step 8: Deploy the WebReports Application Files

  1. Extract the WebReports installation package.
  2. Open the extracted WebReportsInstall folder.
  3. Select all files and folders.
  4. Copy the contents into the physical directory configured for the WebReports IIS website.

mceclip3.png

Copy the contents of the WebReportsInstall folder into the website directory rather than copying the parent folder itself.

Step 9: Configure the WebReports Database Connection

Open the appsettings.json file located in the WebReports application directory using a text editor.

Locate the DefaultConnection configuration and enter the connection information for the database platform used by WebReports.

Microsoft SQL Server

If WebReports uses Microsoft SQL Server, configure the connection with the SQL Server information created during database setup, including:

  • Server and instance
  • Database
  • User ID
  • Password
  • Database type: MSSQL

For SQL Server configuration instructions, see:

Configuring WebReports SQL Server Using SSMS

MySQL

If WebReports uses MySQL, configure:

  • Server name or IP address
  • Port
  • Database
  • User ID
  • Password
  • Connection timeout
  • Database type: MYSQL

Configure Pooling according to the WebReports requirements for your MySQL environment.

For MySQL setup instructions, see:

Installing MySQL

mceclip0.png

Save a backup copy of appsettings.json before making configuration changes.

Step 10: Configure WebReports Registration

In appsettings.json, enter the registration information provided with your WebReports license:

  • LicenseKey
  • CompanyID
mceclip6.png

If you do not have your WebReports license information, contact BridgeWorks Support.

Step 11: Configure the WRXValue

Configure a unique WRXValue in appsettings.json.

The WRXValue is used when WebReports communicates with VDM and must match the value configured in the WebReports connection profile in VDM.

For more information, see:

WRXValue

mceclip3.png

Step 12: Configure Authentication Settings

If WebReports will use Windows Authentication, configure the authentication setting in appsettings.json for Windows Authentication and enter the applicable domain and user information for your environment.

mceclip0.png

If Windows Authentication is not being used, configure the authentication method required for your WebReports environment.

Note: VDM API connections require AllowAPIKeysForVDM to be enabled in the WebReports appsettings.json file. Current WebReports installations set this value to true by default. If a VDM API connection is not working, verify that this setting has not been changed.

Note: The WebReports database connection string includes a Connect Timeout setting. Current installations use a default value of 60 seconds. If WebReports is experiencing database connection delays, review this value along with the WebReports logs before making changes.

Step 13: Configure Connection String Encryption

WebReports can use an encrypted database connection string to avoid storing database credentials in plain text.

For instructions on creating an encrypted connection string, see:

Encrypting Your WebReports Connection String in VDM

After creating the encrypted connection string, configure the EncryptedConnection setting appropriately in appsettings.json.

Step 14: Launch WebReports

  1. Return to IIS Manager.
  2. Select the WebReports website.
  3. In the Actions pane, click Browse Website.

  1. Verify that the WebReports application loads successfully.

Troubleshooting: If WebReports does not start or load correctly after deployment, review the WebReports application logs for startup errors. Also confirm that the IIS application pool identity has the required permissions to write to the WebReports application folders. For additional troubleshooting, see WebReports Logs Overview.

Step 15: Sign In and Register WebReports

Sign in to WebReports using the administrator credentials provided for your deployment.

If your deployment uses an initial or default administrator password, change it immediately after signing in.

If Windows Authentication is configured, WebReports may authenticate the current Windows user automatically instead of displaying the standard sign-in page.

Complete the WebReports registration using the license information provided by BridgeWorks.

Next Steps

After WebReports is running successfully:

  • Verify that administrators can sign in.
  • Confirm that the WebReports database connection is working.
  • Verify HTTPS access using the production WebReports URL.
  • Complete the required WebReports application settings for your environment.

For additional setup, see the Configuration and Management sections of the WebReports Help Center.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.