On-Premises Guides
12 guides
Accessing your On-Prem Logs
The article provides a guide on locating on-premise Halo instance logs for troubleshooting. These logs are essential for issue resolution and are stored in the root directory of the IIS site under specific folders, typically organized by days.
Changing your Halo URLs
The article provides instructions for changing Halo agent and user portal URLs for on-premise installations. It requires access to IIS, the certificate store, SSL certificates, and DNS records configuration. Steps include updating IIS bindings with the new URL and corresponding certificate, configuring API and webapp URLs in Halo, and potentially updating the Self Service Portal config. Restarting the Halo site in IIS finalizes the update.
Checking your DB Size
The article provides a step-by-step guide to check the size of an on-premise Halo database. It includes a SQL query that retrieves database details such as schema names, table names, row counts, and space usage in megabytes and gigabytes. The query calculates total, used, and unused space for non-system tables. It includes joins on system catalog views for detailed storage information and orders results by total space.
Enabling Reference Tokens
Multiple New Portals with different branding for one customer [On-Prem]
The article provides a step-by-step guide on setting up multiple web portals with different branding for an on-premise customer. It involves copying the portal directory, configuring IIS with a new site and certificate, and setting up app integrations with the appropriate authorization methods. Additional modifications to the appsettings.json file, including setting a client ID, are necessary to complete the portal setup and branding.
On-Prem Instance to Instance Refresh
This article provides a detailed guide on refreshing a Halo on-premise instance from another on-premise instance, such as copying a production instance to a UAT/Dev instance. It involves gathering specific database information, backing up the source database, and restoring it to the destination instance after stopping it in IIS. It includes steps for setting necessary keys and URLs, and instructions for upgrading the database if needed. The process finishes by restarting the site in IIS.
On-Premise - Pre-requisites
For optimal performance of Halo on-premise deployment, use two separate servers for IIS Halo Application Hosting and SQL Server Database Hosting, each meeting specific hardware and OS requirements. Additional components like SQL Server Management Studio and various app installations are required. The servers must have internet access for license validation. Ensure necessary files are downloaded and configured, such as Dotnet Hosting and IIS Rewriter. Any special configurations or issues should be communicated prior to deployment to ensure proper preparation.
Password hashing work factor
The article discusses the concept of a password hashing work factor, which is the number of iterations a hashing algorithm performs per password. A higher iteration count increases computational cost and slows down attackers. The minimum recommended by OWASP is 600,000 iterations, but this should increase as hardware improves. The article explains how to adjust iterations using OpenSSL and provides guidance on setting the work factor to balance security with server performance, including code snippets and instructions for updating server configurations.
Providing your On-Prem Halo DB for Debugging
This article explains the process for providing a backup of your on-premise Halo database to the Halo development team for debugging, when requested. It involves generating a public key and receiving SFTP server credentials to upload the DB backup. Instructions include using SSMS to take the backup.
Restoring a DB Backup
This guide instructs on restoring a database backup for Halo on-premise. Ensure the backup's database version is the same or older than the Halo app version. Prerequisites include access to the DB server via a client like SSMS and a .bak file. The process involves stopping the Halo app in IIS, using SSMS to restore the DB, and upgrading the DB if there's a version change. Finally, ensure the application's URL matches in configurations. Troubleshoot by verifying DB user permissions post-restoration.
Setting up Monaco SQL Editor On-Prem
SFTP guide - including SSH Key pair generation and Public key transfer
This article provides a guide on generating and using SSH keys for Halo SFTP services. Users need to create an SSH key pair, where the private key acts as a password for SFTP connections. The public key must be passed to Halo for validation and user assignment. The ssh-keygen command is used to generate keys on UNIX, MacOS, and Windows 10+. Once validated, connection details are provided for use with SFTP clients like Putty or FileZilla. Instructions for setting up FileZilla using the SSH key are included.