SobekCM Repository Community Help
SobekCM Repository

Upgrade to Version 5.0.0 from 4.11.0

 

These instructions are specific to upgrading SobekCM from version 4.11.0 to version 5.0.0.   Ensure your instance is fully upgraded to 4.11.0 before upgrading.

Preparing for your Upgrade

Before you embark in the upgrade, you should prepare by looking at the steps below. This includes:

  1. Pull the latest code from GitHub and build it, just like you would for a new install.
  2. Once you are ready to do the upgrade, stop your builder service from running
  3. Perform a backup on your SQL database
  4. Backup the your web server application
  5. You may also want to backup your builder application, since this version includes changes to that.
  6. Ensure you have .NET 10 Hosting Bundle installed on all the necessary machines ( builder and web ) since this version upgrades to .NET 10. 

Upgrading the Web App

Before you begin, be sure to stop the old website through IIS. And get a copy of the built, release application ready. Okay, time to upgrade!

  1. Remove old folders that need to accept new default and executables
    • Remove the /config/default folder
    • Remove the /default folder
    • Remove the /bin folder
    • Remove the /obj folder
    • Remove all the files from the root folder of the website (leaving the remaining subfolders there)
  2. Copy over all the files, overlaying any files if it asks
  3. IIS changes
    • Change /content virtual directory to an application using the same application pool as the main app
    • Change the app pool to "No Managed Code"
  4. Run the applicable database scripts to upgrade your database to 5.0
  5. Change the connection string to ensure it includes ;TrustServerCertificate=True;Encrypt=False;. This can actually happen before the upgrade.
  6. Add the following web.config under the actual content folder: 
    <configuration>
  <system.webServer>
    <handlers>
      <remove name="aspNetCore" />
    </handlers>
    <staticContent>
      <remove fileExtension=".jp2" />
      <mimeMap fileExtension=".jp2" mimeType="image/jp2" />
    </staticContent>
  </system.webServer>
</configuration>

This should do it... turn back on the site and test it!

Installing and Configuring the new Solr/Lucene Indexes

The new version can run on the old solr/lucene indexes (most likely something around solr 7?). It is recommended to upgrade to Solr10 as soon as you can, as there are some advantages in the solr/jvm stack.

On the machine that will house your solr/lucene indexes:

  1. Solr Executable
    1. Install a recent version of Java Development Kit ( I used the latest build on version 8 )
    2. Download a recent version of solr/lucene.  It must be at least version 7.1.0.  You should be able to use any version 7.1.0 or newer though.
    3. The new version uses Jetty rather than Tomcat, so it can be put anywhere on you system.  I generally put it directly under the root drive ( like C:\solr-7.1.0, but you can put it anywhere convenient)
    4. Test solr by navigating to the bin directory under the solr directory in admin command prompt and typing 'solr start'
    5. Then you should be able to open a browser to http://localhost:8983 and see the solr admin screen.
  2. SobekCM Configuration and Data folders
  3. Building the new Index

 

Previous Version Upgrade Information

Below is information for upgrading to previous versions.

If you are needing to make a large jump in version, you may need to read each individual step upgrade below.