Skip Navigation Links.
MISSING BANNER

Upgrade to Version 4.10.1 from 4.10.0 or 4.9.0

 

For a test site running on your machine, you can certainly run the Installer MSI, which will perform an in-place upgrade for you. However, for production sites, I would recommend following the steps below. The first step the MSI runs during the upgrade is a removal of the previous version, and I do not feel comfortable doing that to the instances that I have running in production.

These instructions are specific to upgrading SobekCM from version 4.9.0 or 4.10.0 to version 4.10.1.  If you already upgraded to 4.10.0, then some of these steps ( particulartly, step 2 in the preparing and the web.config  changes in step 2 of the upgrade ) may have already been completed.

Preparing for your Upgrade

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

  1. Download and unzip the upgrade package at: http://sobekrepository.org/software/download
  2. Before your upgrade, you may want to apply for a Google Map API key since it is required to use the Google mapping features in this new version. Instructions are here: http://sobekrepository.org/software/config/googlemaps
  3. Cleanup the mySobek templates
    • Ensure that any custom metadata templates you created are in the mySobek/templates/user folder and subfolders. The folder structure under the user folder should be identical to the default folder. However, we will never overwrite your templates in the user folder during an upgrade.
    • Also delete any stray folders under the mySobek/templates folder. Under that folder should only be the default and user subfolders.
  4. Once you are ready to do the upgrade, stop your builder service from running
  5. Perform a backup on your SQL database
  6. Backup the following folders from your web:
    • Files in the main web folder
    • bin subfolder
    • config subfolder
    • default subfolder
    • mySobek subfolder
  7. You may also want to backup your builder application, since this version includes changes to that.

Performing the Upgrade

The upgrade process for this version is standard and is essentially used for all SobekCM upgrades, except for one suggested change on the web.config file.

  1. Upgrade your database instance by running the SQL upgrade script against your database.  If you did not upgrade from version 4.9.0 first, run the appropriate SQL script in the SQL subfolder.
  2. Upgrade the web application:
    • On your web server, delete the bin, config, and default subfolder. Be absolutely sure not to delete the design subfolder.
    • Copy over all the files from the appropriate web folder ( either Web64 for 64-bit machines, or Web32 for 32-bit machines).
    • Add to the top of your web.config, the following lines that will help with calls directly to the engine from the web application. You can also see where these lines site in the Web_config.template file you will see at the root of your web application. (You can delete this template once you are done with the upgrade)
    • If you are running shibboleth or otherwise had modified configuration files, copy those back into the config/user subfolder under the web application. Only copy back config files that you are actually using.
    • If you are running the builder on a different server, you will need to provide access to the engine endpoints for that server, by IP address.  Take the add_builder_server_ips.config file from the config/samples folder and put the IP address for your server where 10.20.0.50 currently resides.  Then, drop that configuration file into your config/user folder under the web application.  
    • Test the web application as it should function correctly now.
  3. Upgrade and restart the SobekCM Builder:
    • On the builder server, copy the files from the Builder folder and overlay your existing files.
    • You may want to update the configuration file for the Builder. The old configuration files will still work for now, but if you look in the config folder under the Builder now, you will see a template for the new style. We suggest switching to this style as soon as possible.
    • Restart the builder

After the Upgrade

After the upgrade, you will want to add the Google Map API Key, if you created one, and ensure all your custom templates are working correctly. The types/subtypes which appear in the template files has changed in some instances. You can see the ones under the Template Elements option, under UI Configuration in the new System-Wide Settings screen.