WebReports runs on a Windows Server as a browser-accessible application hosted by Internet Information Services (IIS). This guide explains what the installation components do and the order in which to prepare them, configure WebReports, and verify the installation.
WebReports uses either Microsoft SQL Server or MySQL for its application database. Complete the common steps below and choose the database branch that matches your deployment.
Existing installation? Follow Update WebReports to the Latest Version before replacing files in a working environment.
What You Are Installing
| Component | What it does | Why it is needed |
|---|---|---|
| IIS | Hosts the WebReports website and its HTTPS bindings. | Provides the Windows web-hosting configuration used to receive browser requests. |
| ASP.NET Core Hosting Bundle | Provides the .NET runtime and ASP.NET Core Module used with IIS. | Allows IIS to start and host the WebReports application. |
| Application database | Stores WebReports configuration, users, scheduling information, and other application data. | Supports WebReports operations. It serves a different purpose from the data sources queried by reports. |
| WebReports application package | Supplies the application files deployed to the IIS website's physical directory. | Contains the WebReports application; its environment-specific settings must be configured for your installation. |
| HTTPS certificate and DNS name | Identify the website and protect browser traffic. | Allow users to reach the intended WebReports site over HTTPS. |
The installation sequence is: IIS → Hosting Bundle → application database → download and unblock → deploy and configure → folder permissions → first launch and verification.
The linked articles provide the detailed screen-by-screen instructions. Return to this guide after each task to continue in order.
Before You Begin
- Review WebReports Deployment Requirements and Network Architecture for the supported Windows Server, database, runtime, browser, capacity, and network requirements.
- Confirm that you have administrative access to the Windows Server and appropriate access to the selected database server.
- Choose the WebReports DNS name, HTTPS port, and application directory. Obtain a valid certificate from a trusted Certificate Authority (CA) for the DNS name users will use.
- Confirm that the server can obtain the installation downloads and reach the application database, reporting data sources, and any enabled email, identity, or API services.
- Have the WebReports license and registration information provided by BridgeWorks available.
- Decide which authentication method the deployment will use. Windows Authentication requires the applicable IIS role service and matching WebReports settings.
Demo examples: The names WR-DEMO-SRV, WebReportsDemo, C:\inetpub\WebReportsDemo, and https://webreports.demo.example.com can be used when documenting a test installation. Substitute your approved server, database, path, and URL when performing a real installation. These names are illustrative, not working endpoints or credentials.
Step 1: Install IIS
Install the Web Server (IIS) role and its management tools on the Windows Server. IIS supplies the web host; the WebReports website and application pool are configured later in this sequence.
Follow Install Internet Information Services (IIS) for WebReports. Enable Windows Authentication only if that is the method chosen for this deployment.
Before continuing: Confirm the IIS role installation completed successfully and that IIS Manager opens.
Step 2: Install the ASP.NET Core Hosting Bundle
Install the supported ASP.NET Core 10 Hosting Bundle required by the WebReports release. The bundle supplies the runtime and IIS hosting module; installing IIS alone does not supply these components.
Follow Download and Install the ASP.NET Hosting Bundle. Install IIS first. If the Hosting Bundle was installed before IIS, repair the bundle after IIS is installed. Complete the required server or IIS service restart before testing the site. Microsoft explains the installation order and restart requirement in its ASP.NET Core hosting guidance for IIS.
Before continuing: Confirm the supported bundle installation or repair completed successfully and that its restart instructions have been completed.
Step 3: Prepare the WebReports Application Database
Choose one of the following database branches. A supported existing database server can be used; you do not need to install a second database engine just for WebReports if the existing server meets the deployment requirements.
The WebReports application database stores the application's own information. Preparing it does not automatically create connections to the separate business databases used by reports.
Microsoft SQL Server
3A: Prepare SQL Server and the Administration Tools
If a supported SQL Server instance is not already available, install it before continuing. SQL Server Management Studio (SSMS) is the administration tool used by the linked configuration guide; it is separate from the database engine.
See Microsoft SQL Server 2025 Express & SSMS Installation. Choose the edition and capacity appropriate for the workload using the deployment requirements article.
3B: Configure SQL Server for WebReports
Follow Configuring WebReports SQL Server Using SSMS to prepare the WebReports database and its dedicated application login.
Record for deployment: SQL Server address and instance, database name, application login, and its password. Store credentials securely and confirm the application server can reach the database endpoint.
MySQL
3A: Prepare MySQL and the Administration Tools
If a supported MySQL server is not already available, follow Install MySQL for WebReports. MySQL Server is the database engine; MySQL Workbench is a graphical administration tool. Prepare a separate database account for WebReports rather than using the root account for routine application access.
3B: Review MySQL Data Storage Settings
Review Configure MySQL Data Storage Settings for WebReports. Larger reports or exports may require packet-size adjustments. Apply changes when the workload requires them; the example values are not mandatory settings for every installation.
Record for deployment: MySQL server address, port, intended application database name, application account, and its password. Store credentials securely and confirm the application server can reach the database endpoint.
Step 4: Download and Prepare the WebReports Package
- Obtain the official ZIP using Download the Latest WebReports Version.
- Before extracting the trusted ZIP, follow Unblock WebReports Files. If Windows does not display an Unblock option, continue as described in that article.
- Extract the package to a staging folder so its application files are ready to deploy.
The ZIP contains the WebReports application files. Downloading or extracting it does not configure IIS, the database connection, or registration.
Before continuing: Confirm the extracted application files are available, including appsettings.json, and identify the physical directory that the IIS website will use.
Step 5: Configure IIS and Deploy the Application
Use Configure IIS and Deploy WebReports for the detailed deployment steps. Complete the IIS, file deployment, and application configuration sections before the first launch.
During this stage:
- Create or select the WebReports application pool and configure the website to use it.
- Set the website's physical path to the intended WebReports application directory and configure its HTTPS binding and certificate.
- Copy the contents of the extracted application folder into that physical directory.
- Configure
appsettings.jsonwith the selected application database connection and matching database type, plus the license and registration values provided for the installation. - Configure the authentication method and any applicable VDM integration settings described by the deployment guide.
Before continuing: Confirm the website points to the directory containing the deployed application files and that the connection information matches the database prepared in step 3. Keep a backup of the completed environment-specific configuration.
Step 6: Configure Folder Permissions Before First Launch
The IIS worker process must be able to access the application files and write to the locations WebReports uses for logs and uploaded branding. Missing permissions can prevent these operations even when the website and database connection are configured correctly.
Follow Configure IIS Folder Permissions for WebReports for the actual deployment directory. Confirm the application identity, required permissions, and folder scope for your environment with the deployment administrator.
Before continuing: Confirm the intended IIS identity has the required access to the actual WebReports folders. Complete this task before using the first-launch steps in the deployment guide.
Step 7: Start, Sign In, and Verify WebReports
Return to the first-launch and sign-in sections of Configure IIS and Deploy WebReports.
- Start the WebReports website and application pool in IIS.
- Open the configured HTTPS URL in a supported browser. Confirm that the certificate matches the intended site and that WebReports loads.
- Sign in using the administrator access prepared for the deployment. If an initial administrator password was supplied, change it as directed. Windows Authentication may sign in the current Windows user automatically.
- Complete or verify WebReports registration using the information provided by BridgeWorks.
- Confirm the application can use its application database and review the application logs for startup or connection errors.
- After configuring a reporting connection and making a test report available, run that report and verify its results. A successful sign-in alone does not verify access to a reporting data source.
- Verify log creation and, if used, a branding upload. Test email and scheduled processing after those features have been configured.
If startup fails, confirm the IIS site and application pool are running, the supported Hosting Bundle is installed, the database endpoint is reachable, and appsettings.json contains the correct values and valid formatting. See WebReports Logs Overview for log guidance.
After Installation
Use Configuration for settings such as registration, email, branding, and application options. Use Management to set up users, roles, reporting connections, and report definitions. Complete those environment-specific tasks before making reports available to users.
Retain the deployment details, completed configuration, and backup information so the installation can be supported and updated consistently.
Comments
0 comments
Please sign in to leave a comment.