diff options
Diffstat (limited to 'TWiki')
| -rw-r--r-- | TWiki/TWikiUpgradeGuide.mdwn | 71 |
1 files changed, 54 insertions, 17 deletions
diff --git a/TWiki/TWikiUpgradeGuide.mdwn b/TWiki/TWikiUpgradeGuide.mdwn index 69624b8a..91f25466 100644 --- a/TWiki/TWikiUpgradeGuide.mdwn +++ b/TWiki/TWikiUpgradeGuide.mdwn @@ -2,23 +2,33 @@ # <a name="TWiki_Upgrade_Guide"> TWiki Upgrade Guide </a> -_Upgrade from TWiki 01-Dec-2000 to TWiki 01-Sep-2001 (previous to new full release)_ +_Upgrade from TWiki 01-Dec-2000 or TWiki 01-Sep-2001 to TWiki 01-Dec-2001 (previous to new full release)_ ## <a name="Overview"> Overview </a> -The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements to the last full version (01-Dec-2000). The file system set-up is almost identical, but much of the underlying data structure and processes is new. With all the changes, the upgrade procedure is straightforward, and your existing page data is imported directly. +This guide describes how to upgrade either from TWiki 01-Dec-2000 or TWiki 01-Sep-2001 to TWiki 01-Dec-2001. + +* The latest version of TWiki (01-Dec-2001) is a small incremental release over the 01-Sep-2001 version. +* The 01-Sep-2001 version involves several major new features and numerous enhancements to the last full version (01-Dec-2000). The file system set-up is almost identical, but much of the underlying data structure and processes is new. With all the changes, the upgrade procedure is straightforward, and your existing page data is imported directly. ## <a name="Upgrade_Requirements"> Upgrade Requirements </a> -* To upgrade from a 01-Dec-2000 standard installation to the new, next generation 01-Sep-2001 TWiki Production Release, follow the instructions below. +* To upgrade from a 01-Dec-2000 or 01-Sep-2001 standard installation to the latest 01-Dec-2001 TWiki Production Release, follow the instructions below. * **_NOTE:_** To upgrade from a **pre-01-Dec-2000** TWiki, start with %TWIKIWEB%.TWikiUpgradeTo01Dec2000. * To upgrade from a Beta of the new release, or if you made custom modifications to the application, read through all new reference documentation, then use the procedure below as a guideline. +## <a name="Major_Changes_from_TWiki_01_Sep_"> Major Changes from TWiki 01-Sep-2001 </a> + +The latest 01-Dec-2001 release includes the following new features and enhancements compared to the 01-Sep-2001 release: + +* **[[TWIKIWEBFormattedSearch]]** - New `format=""` parameter in <code>%SEARCH\{\}%</code> variable for database like reporting. +* Various bug fixes + ## <a name="Major_Changes_from_TWiki_01_Dec_"> Major Changes from TWiki 01-Dec-2000 </a> -The 01-Sep-2001 release includes the following new features and enhancements: +The 01-Sep-2001 release includes the following new features and enhancements compared to the 01-Dec-2000 release: * **[[TWIKIWEBTWikiPlugins]]** - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the [[TWIKIWEBTWikiPlugins]]. * %TWIKIWEB%.InterwikiPlugin (preinstalled) - Link to external sites with text aliases, `SiteAlias:Page`; rules are defined in [[InterWikis]]. (Get more Plugins from the TWiki:Plugins web.) @@ -42,7 +52,7 @@ The TWiki directory structure remains the same, with one exception, the TWiki co <table border="1" cellpadding="1" cellspacing="0"> <tr> <th bgcolor="#99CCCC"><strong>From TWiki 01-Dec-2000:</strong></th> - <th bgcolor="#99CCCC"><strong>To TWiki 01-Sep-2001:</strong></th> + <th bgcolor="#99CCCC"><strong>To TWiki 01-Dec-2001:</strong></th> </tr> <tr> <td><code>twiki/bin/wikicfg.pm</code></td> @@ -72,7 +82,34 @@ The TWiki directory structure remains the same, with one exception, the TWiki co A new `twiki/lib/TWiki/Plugins` directory contains the new Plugin modules. -## <a name="Standard_Upgrade_Procedure"> Standard Upgrade Procedure </a> +## <a name="Standard_Upgrade_Procedure_from_"> Standard Upgrade Procedure from 01-Sep-2000 to 01-Dec-2001 Release </a> + +This incremental update can be performed easily. + +The following steps describe the upgrade assuming that `$TWIKIROOT` is the root of your current 01-Sep-2000 release. + +1. Back up and prepare: + * Back up all existing TWiki directories `$TWIKIROOT/bin`, `$TWIKIROOT/pub`, `$TWIKIROOT/data`, `$TWIKIROOT/templates`. + * Create a temporary directory and unpack the ZIP file there. +2. Update files in TWiki root: + * Overwrite all `*.html` and `*.txt` files in `$TWIKIROOT` with the new ones. +3. Update template files: + * Overwrite all template files in `$TWIKIROOT/templates` with the new ones. +4. Update script files: + * Overwrite all script files in `$TWIKIROOT/bin` with the new ones. +5. Update library files: + * Overwrite the `TWiki.pm` library in `$TWIKIROOT/lib` with the new one. + * Overwrite all `*.pm` library files in `$TWIKIROOT/lib/TWiki` and `$TWIKIROOT/lib/TWiki/Plugins` with the new ones. +6. Update data/TWiki files: (in case you want the updated docs) + * Using your browser, merge the new TWiki.TWikiRegistration topic (or TWiki.TWikiRegistrationPub in case you used that one) into your existing TWiki.TWikiRegistration topic. + * In the temporary `twiki/data/TWiki` directory where you unzipped the installation package: + * Remove the files you do **not** want to upgrade: `TWikiPreferences.*`, `TWikiWebsTable.*`, `WebNotify.*`, `WebPreferences.*`, `WebStatistics.*` and all `WebTopic*` files. + * In case the cgi-scripts are not running as user `nobody`: The `*,v` RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. `www-data`. A simple way to switch the locker of the RCS files is to use sed: <br />`for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done` + * Move all remaining `*.txt` and `*.txt,v` files from the temporary `data/TWiki` directory to your `$TWIKIROOT/data/TWiki` directory. +7. Update pub/TWiki files: + * Move the new `pub/TWiki/TWikiDocGraphics` directory into your `$TWIKIROOT/pub/TWiki` directory. + +## <a name="Standard_Upgrade_Procedure_from_"> Standard Upgrade Procedure from 01-Dec-2000 to 01-Dec-2001 Release </a> The idea is to have the new and old installation work in parallel so that you can test the new installation before switching over. That way you can make the switch on your live TWiki installation within one minute without affecting the users. @@ -83,9 +120,9 @@ The idea is to have the new and old installation work in parallel so that you ca </tr> <tr> <th bgcolor="#99CCCC"><strong>Current 01-Dec-2000:</strong></th> - <th bgcolor="#99CCCC"><strong>New 01-Sep-2001:</strong></th> + <th bgcolor="#99CCCC"><strong>New 01-Dec-2001:</strong></th> <th bgcolor="#99CCCC"><strong>Obsolete 01-Dec-2000:</strong></th> - <th bgcolor="#99CCCC"><strong>New 01-Sep-2001:</strong></th> + <th bgcolor="#99CCCC"><strong>New 01-Dec-2001:</strong></th> </tr> <tr> <td><code>twiki/templates/</code></td> @@ -116,9 +153,9 @@ The idea is to have the new and old installation work in parallel so that you ca </tr> </table> -Alternatively you could move the existing installation away, install the 01-Sep-2001 release into it's place and move your webs and pub files back. +Alternatively you could move the existing installation away, install the 01-Dec-2001 release into it's place and move your webs and pub files back. -Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-Sep-2001 release, importing your original page data and related files: +Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-Dec-2001 release, importing your original page data and related files: ### <a name="Pre_Upgrade_Preparation"> Pre-Upgrade Preparation </a> @@ -129,7 +166,7 @@ The following steps describe the upgrade on Unix. Windows setup is very similar. ### <a name="Step_1_Backup_amp_Unpack"> Step 1: Backup & Unpack </a> 1. Back up all existing TWiki directories `twiki/bin`, `twiki/pub`, `twiki/data`, `twiki/templates`. -2. Create a temporary directory and unpack the ZIP file there: <br />`mkdir -p ~/tmp/`<br />`cp -p ~/downloads/TWiki20010901.zip ~/tmp/`<br />`cd ~/tmp/`<br />`unzip ~/tmp/TWiki20010901.zip` +2. Create a temporary directory and unpack the ZIP file there: <br />`mkdir -p ~/tmp/`<br />`cp -p ~/downloads/TWiki20011201.zip ~/tmp/`<br />`cd ~/tmp/`<br />`unzip ~/tmp/TWiki20011201.zip` ### <a name="Step_2_Upgrade_TWiki_document_fi"> Step 2: Upgrade TWiki document files </a> @@ -174,7 +211,7 @@ The following steps describe the upgrade on Unix. Windows setup is very similar. ### <a name="Step_8_Update_topics"> Step 8: Update topics </a> -You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Sep-2001 installation. Pointing your browser to the old installation for edit-copy-edit-paste operations is recommended, so that users don't get surprised by meta data content showing up in topics. +You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Dec-2001 installation. Pointing your browser to the old installation for edit-copy-edit-paste operations is recommended, so that users don't get surprised by meta data content showing up in topics. 1. Remember that you now have two TWiki webs: * The original `TWiki` web. @@ -213,16 +250,16 @@ You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 0 ### <a name="Step_10_Switch_over_to_new_insta"> Step 10: Switch over to new installation </a> -In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL. +In this step, you move the working 01-Dec-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL. -1. Test your new 01-Sep-2001 installation under `twiki/bin/2/view` to make sure everything works as expected. +1. Test your new 01-Dec-2001 installation under `twiki/bin/2/view` to make sure everything works as expected. * **_NOTE:_** Don't worry about the Plugins, they'll work after the switch. 2. Edit `$TWIKIROOT/bin/2/TWiki.cfg` and remove the `/2` from `$scriptUrlPath` and `$templateDir`, ex: <br />`$scriptUrlPath = "/twiki/bin";`<br />`$templateDir = "/home/httpd/twiki/templates";` 3. Rename the `TWiki2` web to `TWiki`, including attachments, ex: <br />`cd $TWIKIROOT/data`<br />`mv TWiki TWiki1`<br />`mv TWiki2 TWiki`<br />`cd $TWIKIROOT/pub`<br />`mv TWiki TWiki1`<br />`mv TWiki2 TWiki` 4. Rename the `templates2` directory to `templates`, ex: <br />`cd $TWIKIROOT`<br />`mv templates templates1`<br />`mv templates2 templates` 5. Move the `lib` directory one level up from `$TWIKIROOT/bin/lib` to `$TWIKIROOT/lib`, ex: <br />`cd $TWIKIROOT`<br />`mv bin/lib .` 6. Copy content of `bin/2` to `bin`, ex: <br />`cd $TWIKIROOT/bin`<br />`cp -p bin/2/* .`<br />`cp -p bin/2/.htaccess .` -7. Point your browser to the original URL and make sure the relocated 01-Sep-2001 installation works as expected: check browsing, searching and user registration. +7. Point your browser to the original URL and make sure the relocated 01-Dec-2001 installation works as expected: check browsing, searching and user registration. 8. Clean up and remove obsolete directories: * Remove directory `$TWIKIROOT/bin/2` * Remove directory `$TWIKIROOT/templates1` @@ -259,6 +296,6 @@ In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-20 ## <a name="Known_Issues"> Known Issues </a> -* Check TWiki:Codev/KnownIssuesOfTWiki01Sep2001 for known issues of TWiki 01 Sep 2001 (production release) +* Check TWiki:Codev/KnownIssuesOfTWiki01Dec2001 for known issues of TWiki 01 Dec 2001 (production release) --- [[JohnTalintyre]] - 18 Jul 2001 <br /> -- [[MikeMannix]] - 12 Sep 2001 <br /> -- [[PeterThoeny]] - 02 Oct 2001 <br /> +-- [[JohnTalintyre]] - 18 Jul 2001 <br /> -- [[MikeMannix]] - 12 Sep 2001 <br /> -- [[PeterThoeny]] - 03 Dec 2001 <br /> |