diff --git a/dotnet-docs/windows-installation.md b/dotnet-docs/windows-installation.md index c5c3edb6..76439a2a 100644 --- a/dotnet-docs/windows-installation.md +++ b/dotnet-docs/windows-installation.md @@ -1,7 +1,7 @@ --- title: Installation on Windows -page_title: Installing ReportServer.NET on Windows -description: "Learn about the specifics, recommendations, and available approaches for installing the Telerik Report Server for .NET on Windows." +page_title: Installing Report Server for .NET on Windows +description: "Learn how to install Telerik Report Server for .NET on Windows using the dedicated MSI installer, including prerequisites, step-by-step installation, and troubleshooting." slug: dotnet-installation-on-windows tags: installation,dotnet,windows published: True @@ -10,48 +10,67 @@ position: 2 # Report Server for .NET: Installation on Windows -The Report Server for .NET (`RS.NET`) is currently distributed along with the installer for the .NET Framework 4.6.2. By default, the installer does not install RS.NET. Users must click `Customize` to install RS.NET. +Starting with 2025 Q4, a dedicated Report Server for .NET (RS.NET) installer is available. This article explains how to install RS.NET on Windows and covers the available installation scenarios. -## Installation Process +> Prior to 2025 Q4, RS.NET was distributed with the [.NET Framework 4.6.2 installer]({%slug installation%}). If you use an older version that features this combined installer, make sure to click **Customize** during installation to include RS.NET. -The RS.NET is an ASP.NET Core web application and its installation on the IIS requires the `ASP.NET Core Hosting Bundle` as explained in the Microsoft article [Host ASP.NET Core on Windows with IIS](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-8.0). The installation wizard will show a warning if the module is not installed. The user can continue the installation even when the module is not found. +## Prerequisites ->note Known issue: the detection returns false negative results on machines having `Windows 11`, `Windows Server 2016` and `Windows Server 2022`. This is fixed and will be included in our next release. +Before installing RS.NET, ensure that you have the following components installed: -The installer will configure the ports for installing the RS.NET and RS.NET Service Agent, taking the available ports from 80 upwards: +- [IIS (Internet Information Services)](https://www.iis.net/) +- [.NET 8 and ASP.NET Core 8 Runtimes](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) +- [ASP.NET Core Hosting Bundle](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-8.0) for IIS deployment -![Use the button Customize to allow installing the Report Server for .NET](../images/rs-net-images/rs-customize.png) +If IIS, .NET 8 Runtime, or ASP.NET Core 8 Runtime are missing, the installer interrupts the process and shows a message explaining what needs to be installed before proceeding. In the case where the ASP.NET Core Module for IIS is not present, the installer shows a warning but allows the installation to continue, since this module can be added later without affecting the initial setup. -## Installed Assets +## Downloading the Installer -The __RS.NET__ is installed in `{Installation Folder}\Telerik Report Server\Telerik.ReportServer.Web.NET`. The cross-platform distribution of RS.NET is in the `_non-windows` subfolder. +To download the RS.NET installer: -The __RS.NET Service Agent__ is installed in `{Installation Folder}\Telerik Report Server\Services\.NET`. The cross-platform distribution of RS.NET Service Agent is in the '_non-windows' subfolder. +1. Navigate to [Downloads | Your Account](https://www.telerik.com/account/downloads). +1. Click **Progress® Telerik® Report Server**. +1. Select the desired version from the dropdown menu, then locate and click `Telerik_ReportServer_NET_{Your Version}.msi` to download the installer. -## Configuration +## Installing Report Server for .NET -### Automatic Configuration on Windows +To install RS.NET for the first time: -The installation wizard will do the initial configuration of _RS.NET_ and _RS.NET Service Agent_ on Windows, making them ready-to-run. +1. Double-click the downloaded MSI file to start the installer. +1. Read and accept the license agreement. +1. Optionally, choose **Customize** to customize the installed options, then click **Next**. -If the automatic configuration fails, please, get familiar with the [initialization process](#initialization-process) and follow the [instructions for manual configuration](#manual-configuration-on-windows). + >caution The RS.NET installer currently does not include SDK examples. Those will be added in future releases. -### Initialization process +1. Choose a user option and click **Next**. Creating a dedicated Windows user (`RSUserNET`) is recommended for security purposes. For more information about the available user options, see [ReportServerUser, LocalSystem Identity and Dedicated Users]({%slug installation%}#reportserveruser-localsystem-identity-and-dedicated-users). +1. Click **Install** to proceed with the installation. -1. When the Report Server is started for the first time, the user is supposed to pass the _Configure Storage_ and _Register Administrator_ pages. The settings from these pages are stored in a file named `ReportServerAdmin.json`. -1. Next, the RS.NET checks its `appsettings.json` configuration file for the key __InitialAgentUrl__. If the installation has passed successfully, the key must exist and must have a valid value like __http://localhost:84__. This is where the MSI installation file for Windows has registered the __RS.NET Service Agent__. -1. The RS.NET calls the above URL and passes the storage settings to its Service Agent. They are saved in the file `ServiceAgent.json` in the RS.NET Service Agent's directory. If such a file does not exist, the agent was not initialized or registered in the IIS. +By default, the installation directory is `C:\Program Files (x86)\Progress\Telerik Report Server .NET`. You can change this location during the **Customize** step of the installation. Within this directory: -### Manual Configuration on Windows +- RS.NET is installed at `\Telerik.ReportServer.Web`. +- RS.NET Service Agent is installed at `\Services`. -1. Delete the file `\Services\.NET\ServiceAgent.json` from RS.NET Service Agent's folder if it exists. -1. Test whether the RS.NET Service Agent responds by calling the RS.NET Service Agent endpoint `/api/system/isalive` from the browser. By default, this would be the URL `http://localhost:84/api/system/isalive`. +The installer automatically creates IIS applications on port 81 (RS.NET) and port 82 (RS.NET Service Agent). If these ports are unavailable, it assigns the next available ones. - If the agent is working, the result must be __HTTP ERROR 401 - Unauthorized__. +When you first access RS.NET, you will be prompted to configure storage and register an administrator user. During this setup, you will also be asked to download [encryption keys]({%slug security%}#encryption) that secure your sensitive RS.NET assets. - If the agent is not working, the result should be __404 - Not Found__. +## Upgrading Report Server for .NET -1. Open RS.NET's `appsettings.json` configuration file and add/edit the key `"InitialAgentUrl": "http://localhost:84"`. The value in the example assumes the RS.NET Service Agent is running on port _84_. Change the URL based on your settings. -1. Restart the RS.NET and RS.NET Service Agent. -1. Check the RS.NET's _Configuration_ -> _ServiceAgent_ page. The entry `"DefaultServiceAgent" : "http://localhost:84"` should now be present. The URL may differ, depending on your settings. -1. To use the RS.NET Service Agent, ensure the _Mail Server_ settings in _Configuration_ page are valid. +To upgrade RS.NET from a previous version, download and run a new installer file and follow the [installation steps](#installing-report-server-for-net). + +When upgrading from the combined MSI installer (versions prior to 2025 Q4), the installer automatically migrates: +- Environment variables (such as encryption keys) to the newly selected user option (for example, `RSUserNET` if creating a dedicated Windows user). +- Storage configuration and assets (when using `FileStorage`) to the new RS.NET location. + +The original RS.NET assets created by the combined installer remain on your system and are not automatically removed. + +>caution The RS.NET installer does not support automatic backup. When upgrading from one RS.NET installer version to another, consider performing a [manual storage backup]({%slug storage-backup%}#manual-backup) before upgrading to prevent data loss. Automatic backup functionality will be added in a future release. + +## Troubleshooting + +If scheduled tasks, data alerts, or email functionality is not working, the [Report Server Agent]({%slug service-agent%}) connection may not have been configured automatically. See [Manual Configuration of RS.NET Service Agent Connection]({%slug manual-configuration-rs-net-service-agent%}) for detailed steps on how to do this manually. + +For issues like missing or corrupt files, use the installer's repair functionality: + +1. Run the same MSI installer again and click **Next**. +2. Select **Repair** to start the process. diff --git a/implementer-guide/setup/installation.md b/implementer-guide/setup/installation.md index 7a375dd1..09783a58 100644 --- a/implementer-guide/setup/installation.md +++ b/implementer-guide/setup/installation.md @@ -10,9 +10,11 @@ position: 200 # Report Server Installation +>note This article covers the installation of Telerik Report Server for .NET Framework 4.6.2. Starting with **2025 Q4**, Report Server for .NET (RS.NET) has a dedicated MSI installer. For RS.NET installation instructions, check the [Report Server for .NET Installation on Windows]({%slug dotnet-installation-on-windows%}) article. + The Report Server web application is installed by a Windows MSI installer, which deploys two applications: a website named _Telerik Report Server_, automatically registered with its own application pool in the machine's IIS, and a non-UI application named _Telerik.ReportServer.ServiceAgent_, registered as a Windows Service. The Report Server web application is accessible by default on HTTP port 83 and the Service Agent on HTTP port 82. -## ReportServerUser, LocalSystem Indentity and Dedicated Users +## ReportServerUser, LocalSystem Identity and Dedicated Users ### ReportServerUser diff --git a/implementer-guide/setup/system-requirements.md b/implementer-guide/setup/system-requirements.md index 14c92da5..8bcf7cc8 100644 --- a/implementer-guide/setup/system-requirements.md +++ b/implementer-guide/setup/system-requirements.md @@ -21,7 +21,7 @@ position: 100 - **Operating System** - Windows or Linux platform - **Web Server** - ASP.NET Core web server, e.g. IIS 7+, Kestrel. If **IIS** is used, the [ASP.NET Core Module (ANCM) for IIS](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/aspnet-core-module) must be installed. -- **Runtimes** - [ASP.NET Core 8+ Runtim](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) +- **Runtimes** - [ASP.NET Core 8+ Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) ## Client diff --git a/knowledge-base/manual-configuration-rs-net-service-agent.md b/knowledge-base/manual-configuration-rs-net-service-agent.md new file mode 100644 index 00000000..1a767c25 --- /dev/null +++ b/knowledge-base/manual-configuration-rs-net-service-agent.md @@ -0,0 +1,52 @@ +--- +title: Manual Configuration of RS.NET Service Agent Connection +description: "Learn how to manually configure the connection between Report Server for .NET and its Service Agent when automatic configuration fails." +type: troubleshooting +page_title: Manual Configuration of RS.NET Service Agent Connection +slug: manual-configuration-rs-net-service-agent +tags: rs.net,service-agent,configuration,troubleshooting,installation +res_type: kb +--- + +## Environment + + + + + + + + + + + + +
ProductProgress® Telerik® Report Server
Product Version2025 Q4
+ +## Description + +During RS.NET installation, the installer automatically configures the connection between the RS.NET web application and the RS.NET Service Agent. However, if the automatic configuration fails, you may need to [manually configure this connection](#solution). In case the automatic configuration fails, opening `http://localhost:82/api/system/isalive` in the browser returns `404`. + +> For versions prior to 2025 Q4 that relied on a combined installer for both RS and RS.NET, the RS.NET Service Agent is likely hosted on port 84 instead, and the URL should be `http://localhost:84/api/system/isalive`. + +The automatic RS.NET configuration and initialization process involves the following steps: + +1. When RS.NET starts for the first time, you go through the **Configure Storage** and **Register Administrator** pages. As a result, the settings are stored in the `ReportServerAdmin.json` file. +1. RS.NET checks its `appsettings.json` configuration file for the `InitialAgentUrl` key. This should contain a valid URL like `http://localhost:82` where the Service Agent is registered. +1. RS.NET calls the Service Agent URL and passes storage settings to it. These are saved in `ServiceAgent.json` in the Service Agent's directory. + +## Solution + +If the automatic configuration fails, configure the connection manually by following these steps: + +1. Delete the file `{Installation Folder}\Telerik Report Server .NET\Services\ServiceAgent.json` from RS.NET Service Agent's folder if it exists. +1. Test whether the RS.NET Service Agent responds by calling the RS.NET Service Agent endpoint `/api/system/isalive` from the browser. By default, this is the URL `http://localhost:82/api/system/isalive`. +1. Open RS.NET's `appsettings.json` configuration file and add/edit the key `"InitialAgentUrl": "http://localhost:82"`. The value in the example assumes the RS.NET Service Agent is running on port _82_. Change the URL based on your settings. +1. Restart the RS.NET and RS.NET Service Agent. +1. Check the RS.NET's **Configuration** -> **ServiceAgent** page. The entry `"DefaultServiceAgent" : "http://localhost:82"` should now be present. The URL may differ, depending on your settings. +1. To use the RS.NET Service Agent, ensure the **Mail Server** settings in **Configuration** page are valid. + +## See Also + +* [Report Server for .NET Installation on Windows]({%slug dotnet-installation-on-windows%}) +* [Troubleshooting Report Server for .NET]({%slug troubleshoot-report-server-net%}) \ No newline at end of file