Product/Version Based Full Update Instructions

Update Instructions:
From: GeoCore CE (Community Edition) DB Version 20.0.0
To: 20.0.0

1. Download the latest release from the Download Section on the website. Look for the download for Full Release - Community Edition.
2. Turn your site "off": In the admin panel, at Site Setup > General Settings change the setting Site On/Off Switch to off and save the changes.
3. Turn Geo cache Off: In the admin panel, at Site Setup > Cache change the setting Cache System to off if it is currently on, and save the settings.
4. Back up your current MySQL Database. Important Step! Do NOT skip!
5. Create a full File Backup of your current installation.
   
   Very Important! Don't skip this step either! We cannot stress the two backup instructions enough! These backups will be your only life line in the event that something goes wrong during the update. In addition, if you have made changes to files, the file backup will be there to make restoring those customizations much easier.
6. Locate the package you downloaded earlier, the file should be named something similar to:
   geocore-ce.zip
   
   If you can't find it, re-download it by following the applicable step above.
7. Un-zip the package to a location on your PC that is easy to locate.
8. FTP the files to your site, using an FTP program.
9. On your server, double check the file "permissions" to make sure the following directories and their contents are writable by the “apache user”. Consider this a "troubleshooting step" though, chances are you won't need to do anything special. But if you get errors about templates_c not being writable, you may need to adjust the permissions. The following folders and their contents need to be "writable" by the apache user.
   • _geocache/
   • templates_c/
   • user_images/
   • geo_templates/
10. Run the web-based update script located at upgrade/index.php using your favorite Internet browser, such as Firefox or Internet Explorer. For example, if your site was example.com, you would run
    http://example.com/upgrade/index.php
    in your browser.
11. The next step in the upgrade process will take place in a browser window. The software will perform a quick check of your server to ensure that the minimum requirements to run the software are met. You will see a page similar to the image below. If the software reports that your server does not meet the minimum requirements to run the software, you will need to contact your host to make any necessary changes in order to meet the minimum requirements.
    
12. "Check" the radio button to agree to the License Agreement. You should have already performed a "database backup" and a "File Backup" earlier in this upgrade process. If you did, "check" the radio button confirming that you have backed up the entire database, and then the "Continue" button.
13. The next screen(s) will be similar to the one below. The software will report your current version, as well as, the version you are upgrading to. Click on the "Run Listed Upgrades" button to apply the upgrade to your installation, and then when prompted, the "Finish" button to complete the process.
    
14. When you get to the last step in the Update Wizard it will give you a link to the admin panel, as well as, a link to front User Side of the software. (If you do not see these links the update is not yet complete!) Access your software's Admin Panel using the link on the last step.
15. From the admin login screen of the software, enter your admin "username" and "password" as you ordinarily would and click the "Login" button.
16. You should now see the Main Admin Panel screen for your software.
17. Custom Admin Folder Name: (ADMIN_LOCAL_DIR setting in config.php) If you have NOT changed your admin folder name, you can continue to the next step.
    
    + View Instructions
    If you have re-named the admin directory:

    IMPORTANT: ONLY do the following "mini-steps" if you have re-named the admin directory! These instructions will break things if you follow them when you have NOT re-named the admin directory.

    1. On your server, replace the contents of the re-named admin directory, with the contents of the new version admin folder. In other words, copy the contents of "admin" to "new_admin_dir", where "new_admin_dir" is what you re-named the folder to. If you don't do this step, you will be wondering why a lot of stuff is broken in your admin, since you will be using OLD admin files.
    2. Remove the original "admin/" directory if it still exists.
18. Custom geo_templates Folder Name: (GEO_TEMPLATE_LOCAL_DIR setting in config.php) If you have NOT changed the geo_templates folder name, you can continue to the next step.
    
    + View Instructions
    If you have re-named the geo_templates/ directory:

    IMPORTANT: ONLY do the following "mini-steps" if you have re-named the geo_templates directory! These instructions will break things if you follow them when you have NOT re-named the geo_templates directory.

    1. On your server, copy the entire contents of the geo_templates folder, into your own re-named folder. You will need make sure you replace all files. In other words, copy the contents of "geo_templaets" to "new_geo_templates_dir", where "new_geo_templates_dir" is what you re-named the folder to. If you don't do this step, you will be wondering why a lot of stuff is broken, since you will be using OLD default templates and template loading files.
    2. Remove the original "geo_templates/" directory.
19. Using CDN / Alternate Server for External Media: The software is able to load CSS, JS, and images from an external stand alone location independent of the main website.
    
    If you have not previously set this up, you can skip this step. Note that this is NOT a typical setup, usually only done by large sites that require load balancing or similar.
    
    + View Instructions
    If you have set up a stand-alone location for load balancing or other purposes, you will need to follow the additional steps below:

    IMPORTANT: ONLY do the following "mini-steps" if you have set up a stand-alone location to load geo_templates resources from! These instructions will break things if you follow them when you have NOT done this. If you are not sure, most likely you do not need to follow these instructions.

    1. First a quick note: If you have several different sites that all reference a "common" location for images and such, we recommend to only follow these steps once all locations have been updated to the latest version. (It will not work well to have different installations sharing common resources if those installations do not match version numbers)
    2. Follow the instructions located in the PHP source code file geo_templates/min.php, make sure to read the instructions from the new version (not your previous version), in case anything has changed. When copying files / folders as per the instructions, you will be overwriting files. Note that this is safe since it should only contain the default resources, any images or CSS or such that you have customized should be located in it's own template set folder within geo_templates.
    3. Note that this stand-alone ability is still very new and most likely has not been used very often. If you do run into any trouble, please let us know so we can fix it!
       
       Sites that would typically use this feature would also usually have their own developers, and while your developers could probably fix any snags in this feature themselves, we ask that you let us know about it so we can fix it in the base software as well. Thanks!
20. If you have turned off using the default.css file, you will need to follow the instructions below to add new CSS from the new version.
    
    
    NOTE: Disabling the default.css file is not typical. If you are not sure, you can check by:
    
    In the admin at Design > Settings, if the advanced setting Do NOT automatically include default.css is checked, you will need to follow the steps below.
    
    
    default.css Update Instructions +
    NOTE: These steps are meant for websites with a very highly customized CSS design that do not use the default.css and "overwrite" sections in a custom.css file, but instead the custom.css contains all required CSS and the setting to not use default.css is turned on. For such sites, almost every update will have new CSS for new features that will need to be copied into the custom CSS file and adjusted to match the custom design. The steps below will help walk you through this process.
    
    If you do not think your site is like this, we suggest turning off the setting to "do NOT automatically include default.css", that way it will use default.css from the new version and the steps below would not be necessary.

    1. Go through every single template change listed for every version between 20.0.0 and the latest release here.
    2. Look for changes to the file external/css/default.css, and for every change listed, apply that change to your own custom CSS file. If you have followed the recommendations in the user manual, this will be the file external/css/custom.css in your custom template set. Some sites may use a different CSS file, you would apply the changes to whatever you use for your main CSS file.
    3. You may need to make adjustments to the new CSS to fall in line with your custom design.
21. If you have custom system, module, or addon templates, follow the instructions below. Note that this is not typical, you can tell by viewing your template set folder and seeing if it has any "system", "module" or "addon" folders in them, or if Geodesic support has specifically instructed you to follow these steps.
    
    System Template Update Instructions +
    NOTE: Do you have a lot of templates in your system, module, or addon folders in your custom template set, but don't think all of them have changes in them? If so, follow these instructions before continuing, to make your template set more update friendly. Doing this will greatly reduce the amount of work you will need to do now and in future updates.
    
    Also make sure to always follow this tutorial when you need to customize a new system or module template.

    1. Go through every single template change listed for every version between 20.0.0 and the latest release.
       • Changes for versions from 7.0.0 to 19.02.0 in the legacy changelogs here.
       • Changes for versions Starting at vertion 20.0.0 in the github releases here
    2. Go through each listed file, and if you have that file in your custom template set, apply the changes as noted.
       
       For changes after version 19.02.0, you can use github to show "all" changes between the releases you need. Though it will include PHP changes as well, you will need to skip those and just pay attention to the changes to template files.
    3. If the changes listed look too complex to apply to your customized template, or if you cannot recognize where the changes are located in your custom template, read the tips here for help updating your custom template to be compatible with the latest version.
22. If you have any 3rd party addons, check with the addon's author to see if there are updates available for those addons. If so, update the addon(s), following any instructions provided by the 3rd party addon author.
23. In your admin, go to Addons > Manage Addons, and look for any Addons that might need to be updated, and click the link to "Upgrade to ###" as illustrated below.
    
    
    NOTE: When updating the addons, be sure to carefully read any messages displayed, as they may contain information or instructions you will need to know.
24. Turn your site "on": In the admin panel, at Site Setup > General Settings change the setting Site On/Off Switch to on and save the changes.
25. If you wish, turn Geo cache "on": In the admin panel, at Site Setup > Cache change the setting Cache System to on, and save the settings.
26. Delete the following folders and any contained files from your site:
    
    • pre_setup/
    • setup/
    • sql/
    • upgrade/
27. This concludes the update process. Your software should now be fully updated. Proceed to the "How this Software Works" section of the User Manual to learn how everything works.