[Summary view] [Print] [Text view]

   1      ##############################################
   2     ### MySource ------------------------------###
   3    ##- Upgrading Instructions -----------------##
   4   #-- Copyright Squiz.net ---------------------#
   5  ##############################################
   6  
   7  Herein lie instructions for upgrading one version of MySource to the
   8  next.
   9  
  10  ====
  11  Note
  12  ====
  13  
  14  To be safe, you should always delete every file in your cache
  15  directory after upgrading MySource. You may also need to manually
  16  reparse your site designs if there have been changes to the way
  17  these are processed.
  18  
  19  =======================
  20  2.10.x to 2.12.0
  21  =======================
  22  
  23  To upgrade from MySource version 2.10.x to any MySource version
  24  2.12.0 turn off the frontend and backend of your system in the 
  25  configuration tab. Extract the new files over the top of your MySource 
  26  directory; or extract it to a different one and copy your conf 
  27  and data folders over, after which you will need to reconfigure
  28  Apache to point to the new folder.
  29  
  30  Visit the .../_edit/upgrade_2.10.0_2.12.0.php script in your web
  31  browser before doing anything else. You will need to log in as
  32  root. Now choose the upgrade scripts to run from top to bottom.
  33  
  34  NOTE: When upgrading your core MySource and you own
  35  comercial modules you must obtain upgrades for your comercial modules
  36  as well to ensure proper functionality.
  37  
  38  Also see INSTALL file - MySource MySQL User requirements for information
  39  on possible MySource Mysql User grants changes and new browser requirements.
  40  
  41  =======================
  42  2.8.x to 2.10.0
  43  =======================
  44  
  45  To upgrade from MySource version 2.8.x to any MySource version
  46  2.10.0, extract the new files over the top of your MySource 
  47  directory; or extract it to a different one and copy your conf 
  48  and data folders over, after which you will need to reconfigure
  49  Apache to point to the new folder.
  50  
  51  Visit the .../_edit/upgrade_2.8.0_2.10.0.php script in your web
  52  browser before doing anything else. You will need to be logged in as
  53  root. Now choose the upgrade scripts to run from top to bottom.
  54  
  55  You should only run Comercial module upgrade scripts if you have that
  56  comerical module. NOTE: When upgrading your core MySource and you own
  57  comercial modules you must obtain upgrades for your comercial modules
  58  as well to ensure proper functionality.
  59  
  60  Also see INSTALL file - MySource MySQL User requirements for information
  61  on possible MySource Mysql User grants changes and new browser requirements.
  62  
  63  
  64  =======================
  65  2.8.0 to 2.8.1
  66  =======================
  67  
  68  To upgrade from MySource version 2.8.0 to 2.8.1 simply extract the
  69  new files over the top of the old ones. This is only a minor release
  70  so there are no upgrade scripts to run.
  71  
  72  =======================
  73  2.4.x to 2.8.0
  74  =======================
  75  
  76  To upgrade from MySource version 2.4.x to any MySource version
  77  2.8.x, extract the new tgz over the top of your MySource 
  78  directory; or extract it to a different one and copy your conf 
  79  and data folders over, after which you will need to reconfigure
  80  Apache to point to the new folder.
  81  
  82  Visit the .../_edit/upgrade_2.4.0_2.8.0.php script in your web
  83  browser before doing anything else. You will need to be logged in as
  84  root. This script should handle any housekeeping for you.
  85  
  86  Note that you can do partial upgrades from, for example, 2.7.1
  87  to 2.8.0 - however you will see database errors when running the
  88  upgrade script. These errors are simply due to the system being
  89  already partially upgraded from version 2.4.x - you do not need
  90  to worry about them.
  91  
  92  =======================
  93  2.2.x to 2.3.x or 2.4.x
  94  =======================
  95  
  96  To upgrade from MySource version 2.2.x to any MySource version
  97  2.3.x (BETA) or 2.4.x (Stable), extract the new tgz over the
  98  top of your MySource directory; or extract it to a different
  99  one and copy your conf and data folders over, after which you
 100  will need to reconfigure Apache to point to the new folder.
 101  
 102  Visit the .../_edit/upgrade_2.2.0_2.4.0.php script in your web
 103  browser before doing anything else. You will need to be logged in as
 104  root. This script should handle any housekeeping for you.
 105  
 106  Note that you can do partial upgrades from, for example, 2.3.9
 107  to 2.4.0 - however you will see database errors when running the
 108  upgrade script. These errors are simply due to the system being
 109  already partially upgraded from version 2.2.x - you do not need
 110  to worry about them.
 111  
 112  ==============
 113  2.0.2 to 2.2.0
 114  ==============
 115  
 116  To upgrade from MySource version 2.0.2 BETA to version 2.2.0, either
 117  extract the new tgz over the top of your MySource directory; or
 118  extract it to a different one and copy your conf and data folders
 119  over, after which you will need to reconfigure Apache to point to
 120  the new folder.
 121  
 122  Visit the .../_edit/upgrade_2.0.2_2.2.0.php script in your web
 123  browser before doing anything else. You will need to be logged in as
 124  root. This script should handle any housekeeping for you.
 125  
 126  
 127  ==============
 128  0.9.5 to 2.0.2
 129  ==============
 130  
 131  For the upgrade from MySource 0.9.5 to 2.0.2 (there were no public 
 132  releases between these two versions) an upgrade script has been included 
 133  to make life easier for you.
 134  
 135  This release involves a number of database  and files system changes to 
 136  accomodate certain new features including:
 137  
 138      * Reorganised data/ directory, maintaining security but increasing 
 139      response time.
 140      * Page status logging and the ability to schedule 
 141      page status changes into the future.
 142      * Added functionality to the 
 143      Custom Form and Redirect page templates, as well as all-new Pull 
 144      Content template.
 145  
 146  Create a new directory outside your existing MySource directory and 
 147  xxtract the TGZ file into it. From your existing MySource directory copy 
 148  the 'cache', 'conf' and 'data' directories into your new one. If you 
 149  can, dump your MySQL database(s) to a file, for backup purposes; in case 
 150  this upgrade just isn't for you. You shouldn't need it though, don't 
 151  worry. To dump a MySQL database:
 152  
 153  mysqldump -u <user> --password=<password> <db_name> >  backup.sql
 154  
 155  You can find the values of <user>, <password> and <db_name> in your 
 156  conf/mysource.conf file, or by looking in the Config tab in the backend.
 157  
 158  Alter your Apache configuration, or symlinks, so that you can access the 
 159  new MySource directory in a web browser rather than the old one. Try to 
 160  avoid *actually* accessing it (unless you want to see a pile of ugly red 
 161  errors), and just got straight to the upgrade script:
 162  
 163  http://myhost/path/to/mysource/_edit/upgrade_0.9.5_2.0.2.php
 164  
 165  ..or equivilant. This will require you to log in as root - hope you 
 166  remember that root password! It will also remind you to back up your 
 167  system, which if you've followed these instructions you already have 
 168  (since you dumped the database and copied the 'data' directory). Hit Yes 
 169  and sit patiently while the script gets your database and file system up 
 170  to scratch. When it is finished, hit the link and you should find 
 171  yourself in your backend. Don't run that script again.
 172  
 173  Now there are a few more details left to organise. Part of performance 
 174  improvements in the new release come from fewer files being piped 
 175  through MySource and being instead sent directly by Apache.
 176  
 177  This is where the process splits in two. If you ARE using MySource's 
 178  Virtual Paths feature and have set up AliasMatch lines in your Apache 
 179  configuration file (see INSTALL), you will need to add three more before 
 180  MySource 2.0.2 will function correctly. If you have, for example:
 181  
 182  AliasMatch "^/steve/mysource_test(/.*)?/_edit(.*)$" "MYSOURCE_PATH/web/edit$2"
 183  AliasMatch "^/steve/mysource_test(/.*)?$" "MYSOURCE_PATH/web/index.php"
 184  
 185  in your httpd.conf, change this to:
 186  
 187  AliasMatch "^/steve/mysource_test(/.*)?/__lib(.*)$" "MYSOURCE_PATH/web/__lib$2"
 188  AliasMatch "^/steve/mysource_test(/.*)?/__squizlib(.*)$" "MYSOURCE_PATH/squizlib$2" 
 189  AliasMatch "^/steve/mysource_test(/.*)?/__data(.*)$" "MYSOURCE_PATH/data/unrestricted$2"
 190  AliasMatch "^/steve/mysource_test(/.*)?/_edit(.*)$" "MYSOURCE_PATH/web/edit$2" 
 191  AliasMatch "^/steve/mysource_test(/.*)?$" "MYSOURCE_PATH/web/index.php"
 192  
 193  The __data (note: two (2) underscores (_'s)), __squizlib and __lib 
 194  aliases allow browser direct access to public content: that is, public 
 195  site designs, files attached to live, public pages, and common files 
 196  that come with MySource.
 197  
 198  If you ARE NOT using AliasMatching, and simply have a symlink pointing 
 199  to your web directory, you will need to set up some more symlinks.
 200  
 201  [Note: if you are no using AliasMatching OR Symlinks and simply have 
 202  your MySource directory in the DocumentRoot you are invalidating 
 203  MySource's security settings, granting people access to your entire data 
 204  directory, whether the data is restricted or not. MySource v2.0.2 cannot 
 205  function without the use of AliasMatching or symlinks.]
 206  
 207  Set up the symlinks (relative to the MySource root) 'web/__squizlib' 
 208  pointing to 'squizlib' and '__data' pointing to 'data/unrestricted'. 
 209  E.g.:
 210  
 211  [/home/mysource]$ cd web
 212  [/home/mysource/web]$ ln -s ../squizlib __squizlib
 213  [/home/mysource/web]$ ln -s ../data/unrestricted __data
 214  
 215  __lib will take care of itself.
 216  
 217  And that's it! Your new MySource system should be functioning like 
 218  normal. Be sure to organise your Apache configuration or linking so that 
 219  your new system appears at the old URLs.
 220  
 221  
 222  ==============
 223  0.9.4 to 0.9.5
 224  ==============
 225  
 226  There are two major changes that need to be taken into account when
 227  upgrading from MySource 0.9.4 to 0.9.5: the new menuing system; and
 228  the new internationalisation options.
 229  
 230  You can extract MySource 0.9.5 over the top of your old version; but
 231  you must ensure your database is upgraded. To do this, open
 232  db/web_ChangeLog.sql  You'll notice there is an entry for the upgrade
 233  from 0.9.4 to 0.9.5. Simply copy these lines and paste them into your
 234  MySQL client - make sure you are currently using your MySource web
 235  database.
 236  
 237  You must then reparse your site design. This is because of changes to
 238  the menuing system. If you're using the sample designs, simply upload
 239  the appropriate parse.html from the doc/samples/site_design directory
 240  into the Web -> Designs section of the backend.
 241  
 242  ==============
 243  0.9.3 to 0.9.4
 244  ==============
 245  
 246  The upgrade from 0.9.3 to 0.9.4 is insigificant, data-wise - involving
 247  mostly interface enhancements and bug fixes. However, there have been
 248  improvements to the site design areas that are not completely
 249  backwards-compatible.
 250  
 251  You will need to recreate your site design, or create a new one. Use
 252  the ferns_gif design if you want it to work in Netscape 4, or the PNG
 253  one if you hate GIFs. You can safely extract the tgz over the top of
 254  a 0.9.2 or .3 installation. To upgrade from an earlier 0.9x version,
 255  see the 0.9.1 to 0.9.2 section.
 256  
 257  ==============
 258  0.9.2 to 0.9.3
 259  ==============
 260  
 261  The upgrade from 0.9.2 to 0.9.3 is trivial, involving only a number of
 262  important, but not drastic bug fixes. You can safely extract the tgz
 263  over the top of a 0.9.2 installation. To upgrade from an earlier 0.9x
 264  version, see the 0.9.1 to 0.9.2 section.
 265  
 266  ==============
 267  0.9.1 to 0.9.2
 268  ==============
 269  
 270  There have been some changes to the web database between these
 271  releases. After unpacking the tgz file over your old MySource
 272  directory, you can  get rid of those pesky error messages, by looking
 273  in the the file db/web_ChangeLog.sql. Here you will find the
 274  appropriate SQL commands to upgrade the web database.
 275  
 276  To utilize Virtual Paths you will need to enable it under the Config
 277  tab and then create appropriate labels for all your pages. Don't
 278  worry, any pages you create from then on will have virtual paths
 279  assigned to them automatically.
 280  
 281  ==============
 282  0.9 to 0.9.1
 283  ==============
 284  
 285  To upgrade MySource from version 0.9 to 0.9.1 all you need do is
 286  unpack the tgz file over the top of your existing MySource
 287  directory.
 288   
 289