PortalGuard Upgrade Process
You want to upgrade your PortalGuard server to the latest version, and you are interested in the process.
Important Note: We recommend scheduling and performing an upgrade to your PortalGuard server with a Technical Support engineer. This typically involves scheduling a 1-2 hour meeting to perform the upgrade and test the functionality. The following steps are provided as a reference point for those who wish to know precisely what occurs during an upgrade. If you choose to upgrade PortalGuard on your own, we highly recommend that you perform the upgrade in a test/dev environment first to prevent any production issues.
- Upgrading your PortalGuard server requires modifying new UI files to match your previous changes. If you are not comfortable with this requirement, please schedule a support call by reaching out to firstname.lastname@example.org
Disclaimer: It is highly recommended that you take a snapshot or backup of the server prior to upgrading. If your environment utilizes the SQL backend, the 'pstar' database should be backed up as well.
Please be sure to read through all steps below and direct any questions to email@example.com - especially if you are attempting an upgrade without a scheduled meeting!
- Download the latest installation kit for PortalGuard.
- Extract the contents of the installation kit zip file to your PortalGuard server.
- Take a backup/snapshot of the PortalGuard server for redundancy.
- Open the extracted installation kit and navigate to the following location:
- '\PortalGuard_v126.96.36.199\Back-end Upgrade'
- NOTE: The version referenced above may vary based on when you download the install kit, but the path should remain the same.
- Run the 'PG_Updater.exe' application as Administrator.
- You can also view the details of what happens during the back-end upgrade by viewing the 'PG Back-end Upgrade Readme.pdf' file in this same location.
- This portion of the upgrade only takes a few moments and requires no downtime of the PortalGuard sever.
- For good measure, it is recommended that you go through each configuration within the PortalGuard Configuration Editor and Identity Provider Configuration Editor and edit/save each one to ensure the new defaults take effect.
- When you have saved each config again, run the 'Apply/Sync' function from both editors.
- Navigate to the 'Program Files\PistolStar\PortalGuard' folder on your PortalGuard Sever.
- Locate the '_Upgrade_InetPub_188.8.131.52' folder.
- Again, the version may vary, but the path structure will remain the same.
- This folder contains the new base (unmodified) UI that includes all required modifications for the new version of PortalGuard.
- The PortalGuard Back-end Upgrade Utility DOES NOT touch your existing user interface at all.
- Make a backup of the '_Upgrade_InetPub_184.108.40.206' folder.
- Modify the new UI Files to resemble your previous UI.
- Important Note: v220.127.116.11 of PortalGuard includes a significant UI overhaul. A simple merge will not be enough to bring your customizations over.
- A new branding guide will be added here as soon as it is available.
- If you are not comfortable modifying your UI, please reach out to firstname.lastname@example.org to schedule a support call to look at the environment together!
- Once the UI Files are modified as needed, they can be put in place:
- Copy the current UI as a quick backup.
- You can walk back the UI changes and still use PortalGuard, even with a newer version of the back-end - though certain new features will not function with the older UI in place.
- Delete the contents of the current 'inetpub\PortalGuard' folder.
- You may need to 'Try Again' several times during this action. If some of the files continue to be locked, run 'iisreset' from an elevated CMD and try again.
- Copy the new, modified UI Files into the 'inetpub\PortalGuard' folder that you just emptied.
- Open an elevated CMD and run the 'iisreset' command.
- Check the web.config files under the PortalGuard, Dashboard, Helpdesk and SSO folders for any modifications made for your PG instance. One example would be uncommenting the rewrite rules in the PortalGuard root folder.
- If you utilize the SQL Back-End: Navigate to the Installation Kit and enter the '\PortalGuard_v18.104.22.168\ADDINS\SQL Scripts\' folder.
- Copy the ' v6.5 - sso_page_customizations.sql ' file to your SQL Backend Server (or wherever you are able to run SSMS to access the 'pstar' database!
- If you haven't already, backup the 'pstar' database just in case.
- Execute the upgrade script to ensure your PortalGuard database has the latest functionality added with this version.
- IMPORTANT NOTE: If you were more than a single release behind, please contact email@example.com for a detailed update to your SQL Database, as you may still be missing tables or stored procedures.
- Navigate to the PortalGuard Website and Test!
REV. 02/2021 | PortalGuard