Note: SentryOne Portal requires SentryOne software version 20.0 or above.
What is SentryOne Portal?
SentryOne Portal is a browser-based option for accessing your SentryOne environment data that uses your existing SentryOne database. It replaces the previous mobile applications and Cloud Sync options.
Additional Information: See the SentryOne Portal article.
Before installing SentryOne Portal on-premises, ensure your credentials and machine(s) meet the System Requirements as well as the security and additional requirements listed below:
- The SentryOne Portal requires the use of SQL Server Authentication for the SentryOne Portal service account to connect to the SentryOne database.
- The SQL Server account must have read, write, and execute access to the SentryOne database.
- Accounts logging into the SentryOne Portal through a browser must have access to the Windows Server hosting SentryOne Portal.
- Chrome and Edge are the recommended browsers for using SentryOne Portal.
- Configured SentryOne database (version 20.0 or greater) that's accessible by the web server
- For information about configuring a SentryOne database, see the SentryOne Installation article.
- Latest SentryOne.Monitor.WebClient.Web artifact or the latest version of the Enterprise Platform Installer
- The preferred IP address and port that SentryOne Portal should use to listen for HTTP traffic
- The SentryOne Portal service can only listen to HTTP traffic. If you want to use HTTPS, you need to setup a reverse proxy through IIS or other reverse proxy solution.
- If you plan to change the binding address or port, ensure that there isn't already something listening to that address and port on the machine.
- It's recommended to set the IP address to 127.0.0.1 if you're planning to route requests through IIS or other reverse proxy on the same machine as the service. This will prevent external requests from directly reaching the service.
Installing SentryOne Portal
Where can SentryOne Portal be Installed?
SentryOne Portal can be installed on-premises with a self-hosted configuration as a service.
Note: SentryOne Portal cannot run as an Internet Information Services (IIS) site. IIS may only be used as a reverse proxy to the SentryOne Portal service for SSL and request filtering. See the IIS Reverse Proxy Configuration section below for details.
Install SentryOne Portal using Setup Wizard
Follow the instructions in the SentryOne Installation article.
Install SentryOne Portal using EPI
IIS Reverse Proxy Configuration (Optional)
Additional Information: The following steps cover the process required to set up IIS as a reverse proxy to the SentryOne Portal service for SSL and request filtering. For information about IIS administration, see IIS.net.
IIS Reverse Proxy Prerequisites
The following modules must be installed before configuring your reverse proxy:
Note: These required modules are not installed by default.
IIS Reverse Proxy Instructions
Configure a reverse proxy in IIS to host SentryOne Portal by completing the following steps:
1. Create a website with your desired outward bindings. If you want to use HTTPS, this is where you will register your SSL certificate. Point the site to the default IIS directory.
Note: The default IIS directory is often C:\inetpub\wwwroot. The Application Pool settings wont have an effect on the behavior of this site because it will not be executing code. You can set the .NET CLR version to No Managed Code, but this is not required.
2. Open the Home window for the new site, and select the URL Rewrite feature.
3. Select the Add Rule action from the right window pane, and then select Reverse Proxy rule from the Inbound and Outbound Rules category.
4. Enter the IP address and port of the service in the Inbound Rules server name input. Ensure that Enable SSL Offloading is selected. Select OK to save the rule.
Note: Localhost:9991 is the default IP address.
Success: IIS now routes all requests to the website to the SentryOne Portal service.
SentryOne Portal Configuration Utility
Important: The SentryOne Portal Configuration Utility cannot be used with the EPI version of SentryOne. To make changes using EPI, you must uninstall SentryOne Portal (via uninstallmp), then reinstall using the installmp command with the new settings.
Changes to your SentryOne Portal configuration must be made through the Portal Configuration Utility (PCU).
Accessing the PCU
- Navigate to the MonitorPortal directory in your SentryOne installation. The default path is C:\Program Files\SentryOne\<Version>\MonitorPortal. In this example, it is C:\Program Files\SentryOne\2020.0\MonitorPortal.
- Locate the SentryOne.Monitor.WebClient.ConfigurationUtility file and use the Run as administrator option to open it.
Using the PCU
The PCU allows you to change database, network, security, and web server binding-related properties for SentryOne Portal. Select the Verify & Save button to apply any changes.
The PCU also provides an option to stop/start the SentryOne Portal service (SentryOneMonitorPortal in Windows Services).
Additional Information: For more information about the settings in the Advanced Properties:
- Port: See the Setting the Connection Properties topic from Microsoft Docs for more information on the portNumber property.
- Packet Size: See the Configure the network packet size Server Configuration Option topic from Microsoft Docs for additional information on SQL Server network pack sizes.
- Encrypt Network Traffic: See the Enable Encrypted Connections to the Database Engine topic from Microsoft Docs.
- Trust Server Certificate: See the Setting the Connection Properties topic from Microsoft Docs for more information on the trustServerCertificate property.
- Multi Subnet: See the Setting the Connection Properties topic from Microsoft Docs for more information on the multiSubnetFailover property.
DEPRECATED: Installing SentryOne Portal On Premises Manually
- SentryOne Portal must be installed outside of the user's directory.
- These steps are included only for users who do not have the current release of SentryOne with the installation built in. It was added to the installer in version 2020.8. If you have version 2020.8 or later, you must use the EPI or Setup Wizard instructions to install it.
After you have ensured that your machine meets the prerequisite requirements, you can begin installing SentryOne Portal. Install SentryOne Portal on your machine manually by completing the following steps:
1. Unzip the SentryOne.Monitor.WebClient.Web artifact at the desired location on the machine hosting SentryOne Portal.
2. Update the appSettings.json file in the root of the project with the correct connection string for the client’s database.
3. Run the service install script OnPremServiceInstall.ps1 as administrator. Enter the IP address and port that you want to bind the service to in the appropriate prompt.
Note: To use integrated authentication for the database connection, you need to change the account that the SentryOne portal service is running under in the Windows Services Control panel after installation. The default account is LocalSystem.