"SfR Fresh" - the SfR Freeware/Shareware Archive

Member "webapp/update/readme.txt" of archive opencms_7.0.5_src.zip:

    1             
    2             Instructions for updating OpenCms 6.x/7.x to OpenCms 7.0.5
    3 
    4 
    5                                     WARNING:
    6 
    7                              UPDATE AT YOUR OWN RISK
    8 
    9 The OpenCms update wizard and these instructions are distributed in the hope 
   10 that they will be useful, but WITHOUT ANY WARRANTY; without even the implied
   11 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   12 
   13 Alkacon Software does not guarantee that there will be no damage to your 
   14 existing OpenCms installation when using this upgrade wizard.
   15 
   16 IMPORTANT: Before using this upgrade wizard, make sure you have a full backup 
   17 of your OpenCms installation and database.
   18 
   19 
   20 Follow the following steps to update from OpenCms 6.x/7.x to OpenCms 7.0.5:
   21 
   22 
   23 1. Shutdown your OpenCms servlet container
   24 
   25 The OpenCms upgrade requires that you shut down OpenCms first. You can use the 
   26 Broadcast message tool in the 'Administration' view to inform users before the 
   27 server is shut down.
   28 
   29 
   30 2. Extract the OpenCms upgrade file 'opencms_upgrade_to_7.0.5.zip' to 
   31    your web application directory
   32 
   33 If you extracted the file to an external directory, copy the folders 'update'
   34 and 'WEB-INF' to the OpenCms webapp directory. Be sure that the files 'opencms.tld'
   35 and 'lib/opencms.jar' are replaced with the new version from the archive before you 
   36 continue. Be also sure that after unpacking the tomcat user has write permissions on 
   37 the whole web application directory.
   38 Be also aware that the 'web.xml' might be overwritten.
   39 
   40 
   41 3. Enable the upgrade wizard
   42 
   43 To do so, set the property 
   44 wizard.enabled=true
   45 in the config file WEB-INF/config/opencms.properties.
   46 
   47 3.a. Disable search index update
   48 
   49 By default, during the update before installing the new modules, all your search
   50 indexes will be rebuild, this is needed because we updated to the latest Lucene
   51 search engine version which has a different index format.
   52 Depending on your system, this may take too long. So you can disable it and, then
   53 later after the Update, you can rebuild your indexes one by one from the 
   54 Administration view. To disable it, edit the /update/cmsupdate.ori file, find
   55 lines 10-11:
   56 ---
   57 # Rebuild search indexes
   58 rebuildAllIndexes
   59 ---
   60 and delete them or comment them out.
   61 
   62 4. Restart your OpenCms servlet container
   63 
   64 OpenCms will not start because the wizard in enabled. 
   65 
   66 
   67 5. Execute the OpenCms update wizard
   68 
   69 Open the URL $SERVER_NAME/$CONTEXT_NAME/update/ in your Browser, e.g.
   70 
   71 http://yourserver:8080/opencms/update/
   72 
   73 The update wizard should appear, which looks very similar to the OpenCms setup
   74 wizard. Make sure to read the instructions and the disclaimer on the start 
   75 page. Then execute the wizard which guides you through the update process.
   76 
   77 You will need the Admin password to continue with the upgrade.
   78 
   79 When asked to select the modules to update you should definitely select all
   80 org.opencms.editors.* and org.opencms.workplace.* modules. You only require 
   81 the org.opencms.frontend.* modules if you have installed them before on your 
   82 OpenCms server.
   83 
   84 Here the site selection is only important for the org.opencms.frontend.* modules,
   85 so it should be the site where you have installed these modules. This is by default:
   86 /sites/default/
   87 
   88 After you confirmed the module selection, you should see the status report of the 
   89 module import. This report is also written to WEB-INF/logs/update.log. Check this 
   90 file for errors and exceptions after installation. There should be no exceptions
   91 caused by the upgrade if everything went as expected. Some exceptions may occur 
   92 in case you have an advanced OpenCms installation with many customized classes.
   93 
   94 The update wizard will also do a full rebuild of all your search indices, and 
   95 purge the JSP repository.
   96 
   97 The wizard will finish similar to the setup wizard. After the final confirmation,
   98 the wizard will be locked again (in the opencms.properties file).
   99 
  100 
  101 6. Shutdown and restart your OpenCms servlet container
  102 
  103 Note: to be sure all jsp files work correctly please delete the servlet containers
  104 work directory (ie. ${TOMCAT_HOME}/work/Catalina/localhost/opencms/) and the 
  105 OpenCms' jsp repository (ie. ${OPENCMS_HOME}/WEB-INF/jsp/)
  106 
  107 You should now be able to log into the OpenCms workplace as before.
  108 
  109 
  110 7. After restarting
  111 
  112 You might need to uninstall no longer supported legacy (OpenCms version 5 and 6)
  113 modules, like:
  114 - org.opencms.legacy (which includes the old workflow engine)
  115 - org.opencms.editors.htmlarea (discontinued HtmlArea WYSIWYG editor)
  116 - org.opencms.editors.ledit (discontinued text editor for Internet Explorer)
  117 - org.opencms.editor.msdhtml (discontinued Microsoft ActiveX WYSIWYG editor)
  118 
  119 
  120 IMPORTANT: PLEASE READ THIS
  121 
  122 * The upgrade wizard will replace all VFS resources of the updated modules
  123 * If you made modifications to the modules, these changes will be lost
  124 * In this case export the changed module resources before starting the update
  125 * Hint: You can use the "Resource changed since" feature in the the Database 
  126   Administration to export all the changes you have done after installing 
  127   OpenCms
  128 
  129 --------------------------------------
  130 Important Notes for 6.x Updates only: 
  131 
  132 The first step is a database update, please notice that until now this is working
  133 and has been tested only for MySQL versions 4.1 and 5.0, and for Oracle versions 
  134 9i and 10g. And it should also work for PostgreSQL, but it is not implemented for
  135 MsSQL.
  136 
  137 This process is very time and space consuming, for instance, for a system with 
  138 3,128 resources it takes about 5 minutes, but an update of a system with 120,000+ 
  139 resources takes about 2 hours (without historical data).
  140 
  141 By default, this process deletes all historical data. But you can decide to keep
  142 them, but this is not recommended since it is not really possible to convert the
  143 data to the new schema, so that the converted data might be unusable any how, 
  144 and second, the process might be more than 10 times slower if this option is 
  145 activated.
  146 
  147 The database update process writes report which is very technical, it is just to
  148 give you an idea of what is going on and if there is a problem, logging almost 
  149 any SQL statement send to the database, this report is also written to a log file 
  150 under /WEB-INF/logs/db-update.log.
  151 
  152 You should expect some exceptions while converting user data, so some user 
  153 settings may get lost, but this is unfortunately inevitable.
  154 
  155 Additionally the automatic configuration files update from OpenCms 6.x to OpenCms 
  156 7.0.x is working, for all configuration files, except the opencms-workplace.xml file, 
  157 since it has been completely restructured.
  158 Before continuing you need to get an OpenCms 7.0.x opencms-workplace.xml configuration 
  159 file. One is provided under update/config, but you will need to manually copy it to 
  160 your WEB-INF/config/ folder. This procedure is to prevent that your changes get lost,
  161 but you are the responsible for customizing this configuration file again.
  162 
  163 If you decide not to update this configuration file, the update will NOT work.