docs: add info about the rs.net installer #270
Conversation
|
The draft is ready. Waiting for the installer to become ready for testing so that I can address the comments that were left inside the draft. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the new dedicated RS.NET installer introduced in 2025 Q4. Previously, RS.NET was bundled with the .NET Framework installer, but now has its own MSI installer.
- Creates a new troubleshooting knowledge base article for manual RS.NET Service Agent configuration
- Updates the main installation guide to reference the new RS.NET installer
- Replaces the existing RS.NET installation documentation with comprehensive instructions for the dedicated installer
- Fixes a minor spelling error and adds version configuration variables
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| knowledge-base/manual-configuration-rs-net-service-agent.md | New troubleshooting guide for manual Service Agent configuration when automatic setup fails |
| implementer-guide/setup/system-requirements.md | Corrects spelling of "Runtime" in ASP.NET Core requirements |
| implementer-guide/setup/installation.md | Adds note about new RS.NET installer and download instructions for .NET Framework version |
| dotnet-docs/windows-installation.md | Complete rewrite of RS.NET installation guide for the new dedicated installer |
| _config.yml | Adds version configuration variables for documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
petar-i-todorov
requested review from
dnikolov-prg,
pironska,
todorarabadzhiev and
yordan-mitev
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
ighristov
left a comment
ighristov
left a comment
There was a problem hiding this comment.
Thanks for the efforts, Pepi! The article is comprehensive and cover a lot of info. I've added a few suggestions that hopefully would improve it further.
dotnet-docs/windows-installation.md
Outdated
| - [ASP.NET Core Hosting Bundle](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-8.0) for IIS deployment is installed. | ||
|
|
||
|  | ||
| > The installation wizard displays a warning if the ASP.NET Core Hosting Bundle is not available. Ignoring it makes the installed Report Server non-functional. |
There was a problem hiding this comment.
I would use a modal verb here: "...might make the installed RS non-functional", because we've had scenarios on few OS-es where the ASP.NET Core hosting bundle was installed, but the installer failed to detect it.
Also, can we extend the sentence, adding that the ASP.NET Core bundle can be installed after installing the RS.NET or it might confuse the clients?
| 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. | ||
|
|
||
| ### Initialization process | ||
| When you first access RS.NET, you will be prompted to configure storage and register an administrator user. |
There was a problem hiding this comment.
"...and download the generated encryption keys that will secure your sensitive Report Server assets" or smth like this?
| When upgrading from the combined MSI installer (versions prior to 2025 Q4), environment variables (such as encryption keys) are automatically migrated to the newly selected user option (for example, `RSUserNET` if creating a dedicated Windows user). | ||
|
|
||
| If the agent is working, the result must be __HTTP ERROR 401 - Unauthorized__. | ||
| >caution The RS.NET installer does not support automatic backup. Make sure to perform a [manual storage backup]({%slug storage-backup%}#manual-backup) before upgrading to avoid data loss. |
There was a problem hiding this comment.
"Make sure" sounds a bit ominous. I'll use "consider" here.
Also, in the future we WILL add automatic backup, so maybe it's a good idea to modify the sentence like "does not support automatic backup yet", or simply add "Automatic backup will be supported in a future release".
|
|
||
| 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`. | ||
| When upgrading from the combined MSI installer (versions prior to 2025 Q4), environment variables (such as encryption keys) are automatically migrated to the newly selected user option (for example, `RSUserNET` if creating a dedicated Windows user). |
There was a problem hiding this comment.
Along with the environment variables, we will migrate also:
- the storage configuration (the info where the RS storage assets are kept);
- the storage itself, in case the old RS installation have used FileStorage.
The old assets location created by the combined installer will not be deleted by the migration logic.
Closes https://github.com/telerik/reporting/issues/5202.