Skip to Content

Vinyl upgrade guide


This is the instruction guide for upgrading an existing installation of Vinyl from 3.2+ to 3.3. If you are installing Vinyl for the first time, please refer to the installation instructions for your Vinyl version and server system. If you are upgrading from an earlier version of Vinyl, there are significant upgrade instructions. Please refer to the Vinyl 3.2 Upgrade Guide and upgrade to Vinyl 3.2 first.

This guide assumes that the root directory for the currently installed version of Vinyl is C:\inetpub\wwwroot\Vinyl and that the system already has the prerequisite software and framework installed and configured.


  1. .NET Prerequisites:

    • .NET 6.0 is required for Vinyl 3.3+. This prerequisite should be checked if you are upgrading from Vinyl 3.2 or earlier.

    • To check if .NET 6.0 is installed:

  2. Crystal Reports Prerequisites:

    • Vinyl requires Crystal Reports runtime installed on the app server

    • Crystal Reports SP21 is the minimum for Vinyl 3.3, and SP21-SP32 are supported

Enable Crystal Reports

On Windows systems, Vinyl supports Crystal Reports. Crystal Reports is hosted out-of-process in a COM server. Follow these steps to register the Crystal Reports COM server.

  1. Launch Windows PowerShell as an administrator.

  2. Switch to the Scripts directory beneath the Vinyl installation directory.

  3. Run the RegisterCrystalReports.ps1 script.

Upgrade instructions

Preparing for upgrade

  1. Make a note of the current Vinyl version you are running, in case you need to restore to this version.

  2. Stop IIS. You can do this by entering the IIS Manager, selecting the appropriate web server, and clicking the Stop button at the top right of the Actions pane.

  3. Backup your database(s) in case you need to recover them later.

Deploying new software

  1. Download the archive (

  2. After moving the file to the web server, ensure that the "mark of the web" (MOTW) is removed from the zip file, by right clicking on the file and checking properties and selecting "Unblock" if necessary.


  3. Move the contents of your previous Vinyl root directory to a backup folder.

  4. Extract the new archive to a temporary directory (e.g. C:\Vinyl-3.3.xxxxx)

  5. Copy the entire contents of the temporary directory to the Vinyl application root directory (e.g. C:\inetpub\wwwroot\Vinyl).

  6. Copy the Connection.xml file from your backup directory into the Vinyl directory.

  7. If you have any customizations in appsettings.json file, copy these over from the backup folder into the Vinyl directory.

  8. Copy the Keys directory from your backup into the new folder as well.

  9. Delete the temporary directory you created.


  1. Open the IIS Manager.

  2. Expand the Vinyl folder.

  3. Right click the data folder and choose the Edit Permissions... option.

  4. Select the Security tab.

  5. Click the Edit button to launch the Permissions for data dialog box.

  6. Click the Add... button to launch the Select Users or Groups dialog box.

  7. Provide the name IIS AppPool\Vinyl in the bottom field.

  8. Check Allow Full Control in the Permissions field, then click the OK button to close the Permissions for data dialog box.

  9. Click the OK button to close the data Properties dialog box.

  10. Repeat steps 3-9 for the logs and keys directories as well.

  11. Restart IIS by selecting the server and clicking the Start button in the Actions pane.

Suggested test sequence

  1. Launch your web browser.

  2. Navigate to http://localhost/Vinyl/.

  3. Vinyl will automatically update the database(s). The system will begin responding normally once the upgrade is complete.


An upgrade that takes 5 minutes is normal; larger upgrades might take longer, and smaller upgrades might run faster.