head	1.8;
access;
symbols;
locks; strict;
comment	@# @;


1.8
date	2008.01.22.03.21.30;	author TWikiContributor;	state Exp;
branches;
next	1.7;

1.7
date	2007.03.03.14.51.50;	author TWikiContributor;	state Exp;
branches;
next	1.6;

1.6
date	2007.02.05.00.18.38;	author TWikiContributor;	state Exp;
branches;
next	1.5;

1.5
date	2007.01.16.04.12.02;	author TWikiContributor;	state Exp;
branches;
next	1.4;

1.4
date	2006.06.25.16.26.27;	author TWikiContributor;	state Exp;
branches;
next	1.3;

1.3
date	2006.04.01.05.55.16;	author TWikiContributor;	state Exp;
branches;
next	1.2;

1.2
date	2006.02.01.12.01.20;	author TWikiContributor;	state Exp;
branches;
next	1.1;

1.1
date	2004.08.30.06.29.41;	author PeterThoeny;	state Exp;
branches;
next	;


desc
@none
@


1.8
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1200013119" format="1.1" version="8"}%
%STARTINCLUDE%
---+ TWiki Upgrade Guide

_This guide covers upgrading from a previous version of TWiki (such as Cairo or TWiki4.0) to TWiki 4.2_

%TOC%

---++ Overview

TWiki-4.0.0 was a major new release. TWiki-4.1.0 was a minor release without dramatic changes since 4.0.0. TWiki-4.2.0 is also a minor release containing a few new features that can be seen by the end user, a large number of bug fixes, and a face lift for the skin. It also contains some important updates under the hood to the way users are handled which enables new types of authentication and integration with other systems. The most important new feature is the QuerySearch feature.

---++ Upgrade Requirements

   * Please review the AdminSkillsAssumptions before you upgrade TWiki
   * Review TWiki:TWiki.TWikiUpgradeTo04x02 for latest information and experience notes.
   * To upgrade from a release prior to TWiki Release 01-Sep-2004, start with TWiki:TWiki.UpgradingTWiki on TWiki.org
   * To upgrade from a standard TWiki Release 01-Sep-2004 to the latest TWiki-4.X Production Release, follow the instructions below
   * Once the upgrade has been applied, an existing earlier installation will still be able to read all the topics, but should not be used to write. Make sure you take a backup!
   * Not all Plugins written for TWiki Release 01-Sep-2004 are fully supported with 4.X. Make sure the Plugins you use can be upgraded as well!

---++ Major Changes Compared to TWiki Release 01-Sep-2004 and TWiki Release 4.0.0

See TWikiReleaseNotes04x00, TWikiReleaseNotes04x01 and TWikiReleaseNotes04x02


#ManualUpgradeProcedure
---++ Upgrade Procedure

The following steps are a rough guide to upgrading only. It is impossible to give detailed instructions, as what you have to do may depend on whether you can configure the webserver or not, and how much you have changed distributed files in your current TWiki release.

The main steps are:

   1 Install the new TWiki version, configure it, and get it to work similar to the old version
   1 Install additional extensions (Plugins). Make sure to use the latest versions
   1 Copy all the non-default webs from the old installation to the new
   1 Copy the users from old installation to the new incl all their topics from Main
   1 Apply tailorings to your Skin (logos, menu bars etc)
   1 Apply preferences from old installation
   
---+++ Installation

   * Follow the installation instructions in INSTALL.html which you find in the root of the new installation. Install the new release in a new directory. Do not install on top of the old release.
   * Use the [[%SCRIPTURL{configure}%][configure]] script to configure TWiki.
      * If you are upgrading from a 4.x.x release, you can carry over the configure settings from the old release.
      * You need to run configure and save the configuration once when you upgrade as this will update the altered and added settings.
      * You can also choose to start with a fresh configuration and walk through all the settings using your old !LocalSite.cfg as a reference. This way you will not have old obsolete settings in the new !LocalSite.cfg.
      * If at any time during the installation you want to start over from fresh all you need to do is delete the =lib/LocalSite.cfg= file and re-run configure.
   * Additional resources
      * TWiki:TWiki.UpgradingTWiki04x00PatchReleases
      * TWiki:TWiki.InstallingTWiki#OtherPlatforms
      * TWiki:TWiki.ApacheConfigGenerator
      * TWiki:TWiki.SettingFileAccessRightsLinuxUnix
      * If you upgrade from an older TWiki your =lib/TWiki.cfg= from the old TWiki installation is a good resource for some of the settings you will need but you cannot reuse the old TWiki.cfg.
   * Make sure you have a working basic TWiki before you continue

---+++ Install Extensions

   * Note that not all extensions that worked in Cairo have been updated to work with TWiki4.X. Many Cairo plugins work fine. Some do not. Many plugins have been upgraded to work with TWiki4.0 and later.
   * From TWiki-4.1.0 the [[%SCRIPTURLPATH{"configure"}%][configure]] script which you ran during installation supports installation of additional plugins.
   * Manual installation is possible. Follow the instruction on the Plugin page at twiki.org.
   * Check the plugin topics from your old TWiki installation. There may be plugin settings that you want to transfer to the new TWiki installation.
     %BR% __%H% Hint:__ For an easier upgrade later on, set the plugin preferences settings in the [[%LOCALSITEPREFS%]] topic, not in the plugin topic. To identify the plugin, prefix the name of the setting with the capitalized name of the plugin. For example, to change the =DEFAULT_TYPE= setting of the CommentPlugin, create a =COMMENTPLUGIN_DEFAULT_TYPE= setting in <nop>%LOCALSITEPREFS%.
   * Typical plugin settings you may have altered.
      * CommentPlugin - Set DEFAULT_TYPE
      * EditTablePlugin - Set CHANGEROWS, Set QUIETSAVE, and Set EDITBUTTON
      * InterwikiPlugin - Set RULESTOPIC
      * InterWikis - If you added your own rules you should save this topic and not overwrite it.
      * SlideShowPlugin - Make sure you did not change the embedded 'Default Slide Template' If you did you should save it. It is a bad idea to do. It is better to define your own slide show templates as separate topics that do not get overwritten when you upgrade.
      * SmiliesPlugin - Did you add your own smileys? No real changes were made to the smilies topic October 2005 so you can just leave this topic as it is.
      * TablePlugin - Set TABLEATTRIBUTES   
   * Remember that a plugin must be activated in [[%SCRIPTURLPATH{"configure"}%][configure]].
   * To avoid having to re-apply plugin settings each time you upgrade a plugin or TWiki itself, define the altered plugin settings in =Main.TWikiPreferences= instead

---+++ Copy your old webs to new TWiki

   * When upgrading from Cairo or earlier it may be necessary to unlock the rcs files in data and pub directories from the old installation using the following shell commands:
      * =find data -name '*,v' -exec rcs -u -M '{}' \;=
      * =find pub -name '*,v' -exec rcs -u -M '{}' \;=
   * Copy your local webs over to the data and pub directories of the new install. Do not copy the default webs: TWiki, Main, Trash, Sandbox, _default, and _empty.
   * Make sure all data and pub files and directories are owned by the webserver user.
   * __Note:__ TWiki's WebChanges topics depend on the file timestamp. If you touch the .txt files make sure to preserve the timestamp, or to change them in the sequence of old file timestamps.

---+++ Copy Users And Their Topics From Main Web

   * Copy all the topics from the Main web and corresponding pub/Main directories from the old TWiki to the new TWiki but do not overwrite any of the new topics already inside the new Main directory!
   * Manually merge all the users from the old =Main.TWikiUsers= topic to the new TWiki. If you upgrade from Cairo you can simply use the old file and add the missing new system users to the list of users. If you upgrade from TWiki-4.0.X simply use the old topic. Starting from 4.2.0 TWiki no longer ships with a =Main.TWikiUsers= topic. When you register the first user TWiki now checks for an existing =Main.TWikiUsers= and if it does not exist it gets created.
   * If you use =data/.htpasswd= for authentication copy this file from the old TWiki to the new.
      * If you upgrade from Cairo and you are using the Htpasswd login manager, then note that email addresses for users have moved out of user topics and into the password file. There is a script that performs this extra upgrade step for you - see =tools/upgrade_emails.pl=.
   * The old sandbox web may have a lot of useful topic and users may use it actively for drafts. Manually select the topics (remember the corresponding pub directories) from the old Sandbox web and copy them to the new TWiki. Decide if you want to overwrite the sandbox homepage and left menu bar or keep the new.
   * If you added or removed fields from the user topic form you may also have tailored =TWiki.TWikiRegistration=. Make sure you either reuse the registration topic from the old installation or apply the same field changes to the new =TWiki.TWikiRegistration= topic.
   * Starting from 4.2.0 TWiki ships with =NewUserTemplate= and =UserForm= in the TWiki web. If you choose to tailor anything you are strongly adviced to copy =NewUserTemplate= and =UserForm= to the Main web and tailor the Main web copies. TWiki will look for the =NewUserTemplate= in the Main web first and if it does not exist it uses the default from the TWiki web. By creating a =Main.NewUserTemplate= and its =Main.UserForm= you will not loose your tailorings next time you upgrade TWiki.
   * Make sure all data and pub files and directories are owned by the webserver user.

---+++ Apply Customizations To The Skin

   * Not many of the old Cairo skins work well with TWiki4.X.
   * Add Logos, update top bar and left bar as required.
   * Apply any desired changes to style sheets and templates. The default PatternSkin has been totally rewritten since Cairo and once more in 4.0.2. Since then changes to PatternSkin have been minor and you may be able to carry over most simpler tailorings directly from 4.0.2-4.0.5.
   * Additional resources:
      * TWiki:TWiki.UpgradingTWiki04x00PatchReleases
      * PatternSkinCustomization
      * PatternSkinCssCookbook      
   
---+++ Apply Preferences From Old Installation

   * Transfer any customized and local settings from [[%SYSTEMWEB%.TWikiPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). Per default this is =Main.TWikiPreferences=. This avoids having to write over files in the distribution on a later upgrade.
   * If you changed any of the topics in the original TWiki distribution, you will have to transfer your changes to the new install manually. There is no simple way to do this, though a suggestion is to use 'diff' to find changed files in the =data/TWiki= of the old and new TWiki installation, and transfer the changes into the new TWiki install. If you can run a GUI on your server, you may find that using a visual diff tool like !WinMerge, meld, kdiff3, xxdiff, etc. is helpful.
   * Compare the =WebPreferences= topics in the old TWiki Installation with the default from the new TWiki installation and add any new Preferences that may be relevant.
   * Compare the =WebLeftBar= topics in the old TWiki Installation with the default from the new TWiki installation and add any new feature that you desire.

---++ Customization of Special Pages

Some pages in the TWiki web are meant to be customized after choice of authentication. If you do not use the internal TWiki password manager the topics that contains the features for changing and resetting passwords and changing the email address should be changed to a note describing how to perform these tasks in your organization. If you have made such customizations remember to replace these topics in the TWiki web with the tailored versions from your old installation. The topics are:

   * =TWiki.ChangePassword=
   * =TWiki.ResetPassword=
   * =TWiki.ChangeEmailAddress=

---++ Upgrading from Cairo to TWiki4 (additional advice)

---+++ Favicon

TWiki4's PatternSkin introduces the use of the favicon feature which most browsers use to show a small icon in front of the URL and for bookmarks.

In TWiki4 it is assumed that each web has a favicon.ico file attached to the !WebPreferences topic. When you upgrade from Cairo to TWiki4 you do not have this file and you will get flooded with errors the error log of your web server. There are two solutions to this.

   * Attach a favicon.ico file to !WebPreferences in each web.
   * Preferred: Change the setting of the location of favicon.ico in !TWikiPreferences so all webs use the favicon.ico from the TWiki web. This is the fastest and easiest solution.

To change the location of favicon.ico in !TWikiPreferences to the TWiki web add this line to Main.TWikiPreferences

<verbatim>
   * Set FAVICON = %PUBURLPATH%/%SYSTEMWEB%/%WEBPREFSTOPIC%/favicon.ico
</verbatim>

---+++ !TWikiUsers topic in Main web

Your Cairo [[Main.TWikiUsers][Main.TWikiUsers]] topic will work in TWiki4 but you will need to ensure that these 4 users from the default TWiki4 version of !TWikiUsers are copied to the existing !TWikiUsers topic. !TWikiGuest is probably already there but the others are new
   * *TWikiContributor* - placeholder for a TWiki developer, and is used in TWiki documentation
   * *TWikiGuest* - guest user, used as a fallback if the user can't be identified
   * *TWikiRegistrationAgent* - special user used during the new user registration process
   * *UnknownUser* - used where the author of a previously stored piece of data can't be determined


You additionally need to ensure that !TWikiUsers has the =Set ALLOWTOPICCHANGE = !TWikiAdminGroup, !TWikiRegistrationAgent=. Otherwise people will not be able to register.

---++ Important Changes since 4.0.5

---+++ Supported Perl version

TWiki 4.0.5 worked on Perl version 5.6.X. Reports from users has shown that unfortunately TWiki 4.1.0 does not support Perl versions older then 5.8.0. It is the goal that TWiki should work on at least Perl version 5.6.X but none of the developers have had access to Perl installations older than 5.8.0.

Since TWiki 4.1.0 has some urgent bugs the development team decided to release TWiki 4.1.1 without resolving the issue with Perl 5.6.X. We will however address this and try and resolve it for a planned 4.1.2 release. The TWiki community is very interested in contributions from users that have fixes for the code which will enable TWiki to run on older versions of Perl.

See the [[http://twiki.org/cgi-bin/view/Codev/WhatVersionsOfPerlAreSupported][WhatVersionsOfPerlAreSupported]] topic to keep up to date with the discussion how to get back support for earlier Perl versions.

---+++ Template spec changed

Until TWiki 4.0.5 TWiki.TWikiTemplates the text inside template definition blocks (anything between %<nop>TMPL:DEF{"block"}% and %<nop>TMPL:END% was stripped of leading and trailing white space incl new lines.

This caused a lot of problems for skin developers when you wanted a newline before or after the block text.

From TWiki 4.1.0 this has changed so that white space is no longer stripped. Skins like !PatternSkin and !NatSkin have been updated so that they work with the new behavior. But if you use an older skin or have written your own you will most likely need to make some adjustments.

It is not difficult. The general rule is - if you get mysterious blank lines in your skin, the newline after the %<nop>TMPL:DEF{"block"}% needs to be removed. Ie. the content of the block must follow on the same line as the TMPL:DEF.

The spec change have the same impact on CommentPlugin templates where you may have to remove the first line break after the TMPL:DEF. See the CommentPluginTemplate for examples of how comment template definitions should look like in TWiki-4.1.X

An example: A !CommentPlugin template that adds a comment as appending a row to a table. Before the spec change this would work.

<verbatim>
<verbatim>
%TMPL:DEF{OUTPUT:tabletest}%%POS:BEFORE%
|%URLPARAM{"comment"}%| -- %WIKIUSERNAME% - %DATE% |
%TMPL:END%
</verbatim>
</verbatim>

From Twiki 4.1.0 the old template definition will add an empty line before the new table row. To fix it simply remove the new line before the table.

<verbatim>
<verbatim>
%TMPL:DEF{OUTPUT:tabletest}%%POS:BEFORE%|%URLPARAM{"comment"}%| -- %WIKIUSERNAME% - %DATE% |
%TMPL:END%
</verbatim>
</verbatim>

The advantage of the spec change is that now you can add leading and trailing white space including new lines. This was not possible before.

---++ Important Changes since 4.1.0

---+++ New location for session and other temporary files

*An upgrader upgrading to 4.1.1 should note the following important change*

The directory for passthrough files and session files have been replaced by a common directory for temporary files used by TWiki. Previously the two configure settings ={PassthroughDir}= and ={Sessions}{Dir}= were by default set to =/tmp=. These config settings have been replaced by ={TempfileDir}= with the default setting value =/tmp/twiki=. If the =twiki= directory does not exist twiki will create it first time it needs it.

It is highly recommended no longer to use the tmp directory common to other web applications and the new default will work fine for most. You may want to delete all the old session files in /tmp after the upgrade to 4.1.1. They all start with cgisess_. It is additionally highly recommended to limit write access to the ={TempfileDir}= for security reasons if you have non-admin users with login access to the webserver just like you would do with the other webserver directories.

---++ Important Changes since 4.1.2

---+++ New WYSIWYG Editor

TWiki now ships with a new WYSIWYG editor based on !TinyMCE replaces the Kupu based editor.%BR% !TinyMCE is not a perfect Wysiwyg editor but it is magnitudes better than the Kupu editor

The !WysiwygPlugin that drives the engine behind both !TinyMCE has additionally been heavily improved so that less TWiki Applications are negatively affected by editing WYSIWYG

When !TinyMCEPlugin is enabled the Edit button per default becomes WYSIWYG editing mode. A new Raw Edit link has been added to enable application developers to edit the good old way

The WYSIWYG button has been removed.

---+++ NEWTOPICLINKSYMBOL removed

The NEWTOPICLINKSYMBOL preference which was deprecated in 4.1 has now been removed from the code. If you want to control the appearance of new links, you can use NEWLINKFORMAT.

---+++ !UserForm and !NewUserTemplate Customization

When a new user registers on TWiki his user topic is created based on the =NewUserTemplate= and =UserForm=.

The =NewUserTemplate= was located in the TWiki web and the =UserForm= in the Main web. When upgrading TWiki these were some of the topics you had to take care not to overwrite.

From 4.2.0 the =UserForm= and =NewUserTemplate= are distributed in the TWiki web. If you create the two in the Main web the Main web version will be used instead. So if you tailor the user topic format or the form then you should always copy the two files to the Main web and modify the ones in the Main web. When you later upgrade TWiki your tailored template and form will not be overwritten.

---+++ !TWikiUsers no longer distributed

The =Main.TWikiUsers= topic contains all the registered users. It is a topic you do not want to overwrite when you upgrade TWiki.

From 4.2.0 this file is no longer included in the TWiki distribution. When you register the first time TWiki creates the =Main.TWikiUsers= topic in the Main web if it does not exist already. This means that you can now upgrade TWiki without risk of overwriting the important =TWikiUsers= topic.

   * For new installers this makes no difference at all
   * For upgraders this is one less problem to worry about as your important !Main.TWikiUsers topic now no longer gets overwritten when upgrading.
   
---+++ New =working= directory

A new directory =working= which per default is located in the twiki root, has been introduced which contains:

   * registration_approvals - with 4.2.0 it is moved to here from the data directory)
   * tmp - so we now avoid having to fight with special access rights and /tmp directory that gets cleaned out when booting.
   * work_areas - with 4.2.0 it is moved to here from the pub directory. Configure automatically moved the directory when you upgrade.

Note: Remember to restrict access to this new directory when you upgrade.

The configuration setting ={WorkingDir}= defines the container directory for temporary files, extensions' work areas, and intermediate registration data.  The default is =working= under your installation root.

Take care for that change if you run your own routine to delete obsolete session files, which will now be found under =working/tmp/cgisess*=.
   
---+++ New Internal Admin Login

TWiki 4.2 introduces a new _Internal Admin Login_ feature which uses "admin" (configurable) as username and the password used for configure to become temporary administrator. When you do a new installation you need to use this feature as !Main.TWikiAdminGroup is now access restricted by default to avoid security attacks during the hours an installation may take. From configure there is a link to the !TWikiAdminGroup topic and on !TWikiAdminGroup the step by step instructions are written in a yellow box. Our advice is not to remove this help text in case you need it later.

%STOPINCLUDE%

__Related Topics:__ AdminDocumentationCategory, TWiki:TWiki.UpgradingTWiki, TWiki:TWiki.UpgradingTWiki04x00PatchReleases, TWiki:TWiki.InstallingTWiki#OtherPlatforms, TWiki:TWiki.ApacheConfigGenerator, TWiki:TWiki.SettingFileAccessRightsLinuxUnix
@


1.7
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="KennethLavrsen" date="1170592351" format="1.1" reprev="1.2" version="7"}%
d3 1
a3 1
---+!! TWiki Upgrade Guide
d5 1
a5 1
_This guide covers upgrading from a previous version of TWiki (such as Cairo or TWiki4.0) to TWiki 4.1__
d11 1
a11 1
TWiki-4.0.0 was a major new release. TWiki-4.1.0 is a minor release without dramatic changes since 4.0.0
d16 1
a16 1
   * Review TWiki:TWiki.TWikiUpgradeTo04x00x00 for latest information and experience notes.
d24 1
a24 1
See TWikiReleaseNotes04x00 and TWikiReleaseNotes04x01
d45 4
a48 1
      * If you are upgrading from a 4.0.x release, carry over the configure settings from the old release.
d54 1
a54 1
      * Your =lib/TWiki.cfg= from the old TWiki installation is a good resource for some of the settings you will need but you cannot reuse the old TWiki.cfg.
d65 1
a65 1
      *  CommentPlugin - Set DEFAULT_TYPE
d70 1
a70 1
      * SmiliesPlugin - Did you add your own smileys? No smileys were added 4.0.0 and 4.0.2 so you can just leave this topic as it is.
d73 1
d81 3
a83 1
   
d87 1
a87 1
   * Manually merge all the users from the old =TWiki.TWikiUsers= topic to the new TWiki. If you upgrade from Cairo you can simply use the old file and add the missing new system users to the list of users. If you upgrade from TWiki-4.0.X simply use the old topic.
d89 1
a89 1
      * If you upgrade from Cairo and you are using the Htpasswd login manager, then note that email addresses for users have moved out of user topics and into the password database. There is a script that performs this extra upgrade step for you - see =tools/upgrade_emails.pl=.
d91 3
d107 2
a108 2
   * Transfer any customized and local settings from [[%TWIKIWEB%.TWikiPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). Per default this is =Main.TWikiPreferences=. This avoids having to write over files in the distribution on a later upgrade.
   * If you changed any of the topics in the original TWiki distribution, you will have to transfer your changes to the new install manually. There is no simple way to do this, though a suggestion is to use 'diff' to find changed files in the =data/TWiki= of the old and new TWiki installation, and transfer the changes into the new TWiki install.
d112 8
d134 1
a134 1
   * Set FAVICON = %PUBURLPATH%/%TWIKIWEB%/%WEBPREFSTOPIC%/favicon.ico
d193 1
a193 1
---+++ New location for session files
d195 1
a195 1
An upgrader upgrading to 4.1.1 should note the following important change
d201 50
@


1.6
log
@buildrelease
@
text
@d1 1
a1 2
%META:TOPICINFO{author="KennethLavrsen" date="1170592351" format="1.1" reprev="1.2" version="6"}%
%TOC%
d3 3
a5 1
---# TWiki Upgrade Guide
d7 1
a7 1
_Upgrade from the previous TWiki 01-Sep-2004 Production Release to TWiki-4.X_
@


1.5
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1168726854" format="1.1" version="5"}%
d130 54
a186 1

@


1.4
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1147664322" format="1.1" version="4"}%
d6 1
a6 1
_Upgrade from the previous TWiki 01-Sep-2004 Prodcution Release to TWiki-4.0.0_
d10 1
a10 1
TWiki-4.0.0 is a major new release. You can chose between an automated upgrade using a script or a manual update.
d17 1
a17 1
   * To upgrade from a standard TWiki Release 01-Sep-2004 to the latest TWiki-4.0.0 Production Release, follow the instructions below
d19 1
a19 1
   * Not all Plugins written for TWiki Release 01-Sep-2004 are fully supported with Dakar. Make sure the Plugins you use can be upgraded as well!
d21 1
a21 1
---++ Major Changes Compared to TWiki Release 01-Sep-2004
d23 1
a23 45
See TWikiReleaseNotes04x00.

---++ Automated Upgrade Procedure

If you would prefer to do things manually, *or if you made custom modifications to distributed files* (except topics), then skip to the [[#ManualUpgradeProcedure][manual upgrade procedure]] below.

The upgrade script is called ="UpgradeTwiki"=, and is found in the root of the distribution. It can be run by any user, though you will need to make sure you correct the permissions so that the webserver user can write all files in the new installation when you have finished. The upgrade script does *not* write to your existing installation.

The upgrade script will upgrade the *TWiki core only*. Plugins will need to be upgraded separately.

Note: To upgrade from a Beta, *do not* use !UpgradeTWiki. Instead follow the steps outlined in [[#Upgrading_a_Beta][Upgrading a Beta]], below.

It will:

   * Create a new TWiki installation, placing the files from the distribution there as appropriate
   * Where possible, merge the changes you've made in your existing topics and attachments into the new twiki
   * Where not possible, it will tell you, and you can inspect those differences manually
   * Create new configuration files for the new TWiki based on your existing configuation information
   * Set the permissions in the new TWiki so that it should work straight away
   * Attempt to setup authentication for your new TWiki, if you are using .htaccess in the old one
   * Tell you what else you need to do

To perform the upgrade, you need to:

   * Check first if there is a newer =UpgradeTwiki= script available, see TWiki:Codev.UpgradeTWiki
   * Create a new directory for your new installation: Let's call this =distro/=
   * Put the distribution zip file in =distro/=
   * Unzip it
   * Choose a directory for the new installation.  I will call this =new_twiki=.  This directory must not already exist.
   * Change directory to =distro/= and run: %BR%
     =./UpgradeTwiki &lt;full path to existing_twiki's setlib.cfg&gt; &lt;full path to new_twiki&gt;=
   * confirm your system settings by pointing your browser to the =configure= script

Assuming all goes well, =UpgradeTwiki= will give you the final instructions.

Visit TWiki:Codev.KnownIssuesOfTWiki04x00x00 and fix known issues that apply to you.

There are a few points worth noting:

   * =UpgradeTwiki= may not be able to merge all the changes you made in your existing TWiki into the new installation, but it will tell you which ones it couldn't deal with
   * =UpgradeTwiki= creates the new installation in a new directory tree. It makes a complete copy of all your existing data, so:
      * Clearly you need to point it to a location where there is enough space
      * If you have symlinks under your =data/= directory in your existing installation, these are reproduced as actual directories in the new structure.   It is up to you to pull these sub-directories out again and re-symlink as needed
   * =UpgradeTwiki= doesn't deal with custom templates or Plugins, you will have to reinstall these in the new installation.
   * If you are using the Htpasswd login manager, then note that email addresses for users have moved out of user topics and into the password database. There is a script that performs this extra upgrade step for you - see =tools/upgrade_emails.pl=.
d27 1
a27 1
---++ Manual Upgrade Procedure
d31 70
a100 28
   1 Follow the installation instructions, and install the new release in a new directory.
   1 Copy your local webs over to the data and pub directories of the new install
      * You could also use softlinks to link the web directories in data and pub to the old installation area
   1 Unlock the rcs files in data and pub directories from the old installation using the following shell commands:
      * =find data -name '*,v' -exec rcs -r -u -M '{}' \;=
      * =find pub -name '*,v' -exec rcs -r -u -M '{}' \;=
   1 Examine your old TWiki.cfg, and for each local setting, set the corresponding value in the =configure= interface for the new install.
      *  If you can't use =configure=, then copy the *new* =TWiki.cfg= to =LocalSite.cfg=, and edit =LocalSite.cfg=. Remove all the settings that you didn't change in your previous install, and change the remaining settings to the values from your *old* TWiki.cfg.
   1 Transfer any customized and local settings from [[%TWIKIWEB%.TWikiPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). This avoids having to write over files in the distribution.
   1 If you changed any of the topics in the original TWiki distribution, you will have to transfer your changes to the new install manually. There is no simple way to do this, though the following procedure may help:
      1 Install a copy of the original TWiki release you were using in a temporary directory
      1 Use 'diff' to find changed files, and transfer the changes into the new Dakar install.
      1 Install updated plugins into your new area.
   1 Point your webserver at the new install.
   1 Visit TWiki:Codev.KnownIssuesOfTWiki04x00x00 and fix known issues that apply to you.
   1 If you are using the Htpasswd login manager, then note that email addresses for users have moved out of user topics and into the password database. There is a script that performs this extra upgrade step for you - see =tools/upgrade_emails.pl=.

You are *highly* recommended *not* to change any distributed files if you can avoid it, to simplify future upgrades!

---++ Upgrading a Beta
*If* you followed the recommendations and avoided modifying any distributed files, then this is quite straightforward:
   1 Follow the installation instructions, and install the new release in a new directory.
   1 Copy your local webs over to the data and pub directories of the new install
      * Be careful to copy over the user topics and TWikiUsers.txt in the Main web
   1 Copy over your =bin/LocalLib.cfg= and =lib/LocalSite.cfg= files
   1 Copy over any local files you created (such as .htpasswd and .htaccess files)
   1 Point your webserver at the new install.
*If* you changed any of the distributed files, you will have to continue from Step 5 above.
d111 1
a111 1
   * Change the setting of the location of favicon.ico in !TWikiPreferences so all webs use the favicon.ico from the TWiki web. This is the fastest and easiest solution.
d119 11
d132 1
a132 1
__Related Topics:__ AdminDocumentationCategory, TWiki:TWiki.UpgradingTWiki
@


1.3
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1127433585" format="1.1" version="3"}%
d23 1
a23 1
See TWikiReleaseNotes04x00x00.
d104 17
@


1.2
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1127433585" format="1.1" version="2"}%
d14 6
a19 6
	* Please review the AdminSkillsAssumptions before you upgrade TWiki
	* Review TWiki:TWiki.TWikiUpgradeTo04x00x00 for latest information and experience notes.
	* To upgrade from a release prior to TWiki Release 01-Sep-2004, start with TWiki:TWiki.UpgradingTWiki on TWiki.org
	* To upgrade from a standard TWiki Release 01-Sep-2004 to the latest TWiki-4.0.0 Production Release, follow the instructions below
	* Once the upgrade has been applied, an existing earlier installation will still be able to read all the topics, but should not be used to write. Make sure you take a backup!
	* Not all Plugins written for TWiki Release 01-Sep-2004 are fully supported with Dakar. Make sure the Plugins you use can be upgraded as well!
d37 7
a43 7
	* Create a new TWiki installation, placing the files from the distribution there as appropriate
	* Where possible, merge the changes you've made in your existing topics and attachments into the new twiki
	* Where not possible, it will tell you, and you can inspect those differences manually
	* Create new configuration files for the new TWiki based on your existing configuation information
	* Set the permissions in the new TWiki so that it should work straight away
	* Attempt to setup authentication for your new TWiki, if you are using .htaccess in the old one
	* Tell you what else you need to do
d47 8
a54 8
	* Check first if there is a newer =UpgradeTwiki= script available, see TWiki:Codev.UpgradeTWiki
	* Create a new directory for your new installation: Let's call this =distro/=
	* Put the distribution zip file in =distro/=
	* Unzip it
	* Choose a directory for the new installation.  I will call this =new_twiki=.  This directory must not already exist.
	* Change directory to =distro/= and run: %BR%
	  =./UpgradeTwiki &lt;full path to existing_twiki's setlib.cfg&gt; &lt;full path to new_twiki&gt;=
	* confirm your system settings by pointing your browser to =cgi-bin/configure=
d62 6
a67 5
	* =UpgradeTwiki= may not be able to merge all the changes you made in your existing TWiki into the new installation, but it will tell you which ones it couldn't deal with
	* =UpgradeTwiki= creates the new installation in a new directory tree. It makes a complete copy of all your existing data, so:
		* Clearly you need to point it to a location where there is enough space
		* If you have symlinks under your =data/= directory in your existing installation, these are reproduced as actual directories in the new structure.	It is up to you to pull these sub-directories out again and re-symlink as needed
	* =UpgradeTwiki= doesn't deal with custom templates or Plugins, you will have to reinstall these in the new installation.
a68 1
If you use it, and would be kind enough to add your experiences to TWiki:Codev.UpgradeTWiki, it would be much appreciated.  The report of your experience will help to make =UpgradeTwiki= more robust.
d75 16
a90 15
	1 Follow the installation instructions, and install the new release in a new directory.
	1 Copy your local webs over to the data and pub directories of the new install
		* You could also use softlinks to link the web directories in data and pub to the old installation area
	1 Unlock the rcs files in data and pub directories from the old installation using the following shell commands:
		* =find data -name '*,v' -exec rcs -r -u -M '{}' \;=
		* =find pub -name '*,v' -exec rcs -r -u -M '{}' \;=
	1 Examine your old TWiki.cfg, and for each local setting, set the corresponding value in the =configure= interface for the new install.
		*  If you can't use =configure=, then copy the *new* =TWiki.cfg= to =LocalSite.cfg=, and edit =LocalSite.cfg=. Remove all the settings that you didn't change in your previous install, and change the remaining settings to the values from your *old* TWiki.cfg.
	1 Transfer any customized and local settings from [[%TWIKIWEB%.TWikiPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). This avoids having to write over files in the distribution.
	1 If you changed any of the topics in the original TWiki distribution, you will have to transfer your changes to the new install manually. There is no simple way to do this, though the following procedure may help:
		1 Install a copy of the original TWiki release you were using in a temporary directory
		1 Use 'diff' to find changed files, and transfer the changes into the new Dakar install.
		1 Install updated plugins into your new area.
	1 Point your webserver at the new install.
	1 Visit TWiki:Codev.KnownIssuesOfTWiki04x00x00 and fix known issues that apply to you.
d96 6
a101 4
	1 Follow the installation instructions, and install the new release in a new directory.
	1 Copy your local webs over to the data and pub directories of the new install
	1 Copy over your =bin/setlib.cfg= and =lib/LocalLib.cfg= files
	1 Point your webserver at the new install.
@


1.1
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1093847381" format="1.0" version="1.1"}%
d6 1
a6 1
_Upgrade from the previous TWiki 01-Feb-2003 production release to TWiki 01-Sep-2004_
d10 1
a10 1
This guide describes how to upgrade from TWiki 01-Feb-2003 to TWiki 01-Sep-2004. This is a major new release. You can chose between an automated upgrade using a script or a manual update.
d15 5
a19 3
	* To upgrade from a 01-Feb-2003 standard installation to the latest 01-Sep-2004 TWiki Production Release, follow the instructions below
	* __NOTE:__ To upgrade from a *pre-01-Feb-2003* TWiki, start with %TWIKIWEB%.TWikiUpgradeTo01Feb2003
	* 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
d21 1
a21 1
---++ Major Changes Compared to TWiki 01-Feb-2003
d23 1
a23 11
	* Automatic upgrade script, and easier first-time installation
	* Attractive new skins, using a standard set of CSS classes, and a TWikiSkinBrowser to help you choose
	* New easier-to-use save options
	* Many improvements to SEARCH
	* Improved support for internationalisation
	* Better topic management screens
	* More pre-installed Plugins: CommentPlugin, EditTablePlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, SpreadSheetPlugin, TablePlugin
	* Improved Plugins API and more Plugin callbacks
	* Better support for different authentication methods
	* Many user interface and usability improvements
	* And many more enhancements, see the complete change log at TWikiHistory
d25 1
d27 1
a27 1
---++ Automated Upgrade Procedure from 01-Feb-2003 to 01-Sep-2004 Release
d29 1
a29 2
With the 01-Sep-2004 Release, for the first time, comes a helper script for upgrading from a previous version. This feature is currently at beta stage, it has only been sanity tested under Unix. It should be worth giving it a try, it won't mess up your existing
TWiki installation because it leaves that untouched.
d31 1
a31 1
If you would prefer to do things manually than trust a beta script, skip to the [[#ManualUpgradeProcedure][manual upgrade procedure]] below.
d33 1
a33 1
The upgrade script is called ="UpgradeTwiki"=, and is found in the root of the distribution.
d38 1
a38 1
	* Where possible, merge the changes you've made in your existing topics into the new twiki
d47 1
a47 1
	* Check first if there is a newer =UpgradeTwiki= script available, see TWiki:Codev.UpgradeTwiki
d53 2
a54 1
	  =./UpgradeTwiki &lt;full path to new_twiki&gt;=
d58 2
d66 1
a66 2
	* =UpgradeTwiki= doesn't deal with custom templates or Plugins, you will have to reinstall these in the new installation
	* If you have done tricky stuff with $OS in your existing =TWiki.cfg= file, then you will need to manually examine the new =TWiki.cfg= file and possibly put your tricky changes in there manually
d68 1
a68 1
If you use it, and would be kind enough to add your experiences to TWiki:Codev.UpgradeTwiki, it would be much appreciated.  The report of your experience will help to make =UpgradeTwiki= more robust.
d71 1
a71 1
---++ Manual Upgrade Procedure from 01-Feb-2003 to 01-Sep-2004 Release
d73 1
a73 1
The following steps describe the upgrade assuming that =$TWIKIROOT= is the root of your current 01-Feb-2003 release.  As written this will require some downtime.  A process for switching over without downtime is described at the end of this section.
d75 25
a99 71
	1. *Back up and prepare*:
		* Back up all existing TWiki directories =$TWIKIROOT/bin=, =$TWIKIROOT/pub=, =$TWIKIROOT/data=, =$TWIKIROOT/templates=, =$TWIKIROOT/lib=
		* Create a temporary directory and unpack the ZIP file there
	1. *Update files in TWiki root*:
		* Overwrite all =*.html= and =*.txt= files in =$TWIKIROOT= with the new ones
	1. *Update template files*:
		* Overwrite all template files in =$TWIKIROOT/templates= with the new ones
			* If you have customized your templates, make sure to merge those changes back to the new files
		* If you have customized skins or loaded new skins, make sure to merge or apply those changes to the new files
		* Change to *view* templates and skins:
			* Add =%<nop>BROADCASTMESSAGE%= somewhere on the top of the rendered HTML page (see the new =view.tmpl= for reference)
		* Changes to *edit* templates and skins:
			* Change the form action from =preview= to =save=: %BR%
			  =&lt;form name="main" action="%<nop>SCRIPTURLPATH%/<b>save</b>%<nop>SCRIPTSUFFIX%/%<nop>WEB%/%<nop>TOPIC%" method="post"&gt;=
			* Change the topic action to the following: %BR%
			  =%<nop>TMPL:DEF{"topicaction"}%= %BR%
		=&lt;input type="submit" class="twikiSubmit" name="action" value="Cancel" id="cancel" /&gt;= %BR%
		=&lt;input type="submit" class="twikiSubmit" name="action" value="Preview" id="preview" /&gt;= %BR%
		=&lt;input type="submit" class="twikiSubmit" name="action" value="Checkpoint" id="checkpoint" /&gt;= %BR%
		=&lt;input type="submit" class="twikiSubmit" name="action" value="QuietSave" id="quietsave" /&gt;= %BR%
			  =&lt;input type="submit" class="twikiSubmit" name="action" value="Save" id="save" /&gt;%<nop>TMPL:END%=
	1. *Update script files*:
		* Overwrite all script files in =$TWIKIROOT/bin= with the new ones.
			* If necessary, rename the scrips to include the required extension, e.g. =.cgi=
		* Edit =$TWIKIROOT/bin/setlib.cfg= and point =$twikiLibPath= to the __absolute__ file path of =$TWIKIROOT/lib= 
		* Edit your existing =$TWIKIROOT/bin/.htaccess= file to include a directive for the new =rdiffauth= script:%BR%
		  =&lt;Files "rdiffauth"&gt;= %BR%
		  =&nbsp; &nbsp; require valid-user= %BR%
		  =&lt;/Files&gt;=
		* Pay attention to the file and directory permissions, the scripts need to be executable, e.g. =chmod 775 $TWIKIROOT/bin/*=
			* Certain hosted environments require a =755= (do so if you get a "Premature end of script headers" messages in the Apache error log)
		* For Windows hosts, make sure the correct path to the perl interpreter is changed in the first line of every script file. See also [[WindowsInstallCookbook#Editing_the_CGI_scripts][WindowsInstallCookbook]]
	1. *Update library files*:
		* Overwrite the =TWiki.cfg= configuration file in =$TWIKIROOT/lib= with the new one
		* Restore the configuration values from the backup. You typically need to configure just the ones in the section "variables that need to be changed when installing on a new server"
		* Overwrite the =TWiki.pm= library in =$TWIKIROOT/lib= with the new one
		* Copy and overwrite all subdirectories below =$TWIKIROOT/lib= with the new ones. Make sure to preserve any extra Plugins you might have in =$TWIKIROOT/lib/TWiki/Plugins= 
		* Pay attention to the file and directory permissions, the library files should not be executable but the directory files should be, e.g. =chmod 664 `find -type f $TWIKIROOT/lib`= (for files) and =chmod 775 `find -type d $TWIKIROOT/lib`= (for directories)
	1. *Update data files*:
		* Run the =bin/testenv= script from the browser (e.g. =http://localhost/bin/testenv=) to verify if the cgi-scripts are running as user =nobody=. In case not:
			* The =*,v= RCS repository files delivered with the installation package are locked by user =nobody= and need to be changed to the user of your cgi-scripts, for example =www-data=
			* Run the =testenv= script from your browser; in the %BROWN% *Fix* %ENDCOLOR% line you can <u>relock</u> all the rcs files *(recommended)*
			* Alternatively, execute the shell script commands described in [[TWikiInstallationGuide#StepTwo]]
		* In the temporary =twiki/data/TWiki= directory where you unzipped the installation package:
			* Remove the files you do *not* want to upgrade: =InterWikis.*=, =TWikiRegistration.*=, =TWikiRegistrationPub.*=, =WebPreferences.*=, =WebStatistics.*= and all =WebTopic*= files
		* Rename in the temporary directory the file =$TWIKIROOT/data/TWiki/TWikiPreferences.*= to =TWikiPreferencesSave.*=.
		* Move all remaining =*.txt= and =*.txt,v= files from the temporary =data/TWiki= directory to your =$TWIKIROOT/data/TWiki= directory, overwriting the existing ones
		* Merge your original =TWikiPreferencesSave.txt= settings into =$TWIKIROOT/data/TWiki/TWikiPreferences.txt=. Notable changes are:
			* New WIKIWEBMASTERNAME setting to avoid notifications being trapped by spam filters
			* New ATTACHFILESIZELIMIT setting for maximum size of FileAttachments in KB, 0 for no limit
			* New READTOPICPREFS and TOPICOVERRIDESUSER settings to allow override Preference settings in topics
			* Changed FINALPREFERENCES:
				* <nop>Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER
		* Move the =data/_default= directory from the temporary location to your =$TWIKIROOT/data= directory
		* Make sure that the directories and files below =$TWIKIROOT/data= are writable by your cgi-script user
	1. *Adapt the other webs (all other than =TWiki= and =_default=)*:
		* Add WebLeftBar topic. See WebLeftBarExample for a clean example, and TWiki.WebLeftBarCookbook for more information. (WebLeftBar is used by the TWiki.PatternSkin skin)
		* Add WebSearchAdvanced topic, which has this one line: %BR%
		  =%<nop>INCLUDE{"%<nop>TWIKIWEB%.WebSearchAdvanced"}%=
		* Consider changing WebPreferences settings:
			* New NOAUTOLINK setting to prevent automatic linking of WikiWords and acronyms
			* Changed FINALPREFERENCES:
				* <nop>Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
	1. *Update pub files*:
		* Move all subdirectories below =pub/TWiki= from your temporary directory into your =$TWIKIROOT/pub/TWiki= directory
		* Make sure that the directories and files below =$TWIKIROOT/pub/TWiki= are writable by your cgi-script user
		* Move all files in =pub/icn= directory from the temporary location to your =$TWIKIROOT/pub/icn= directory
	1. *Verify installation*:
		* Execute the =$TWIKIROOT/bin/testenv= script from your browser (e.g. =http://localhost/bin/testenv=) to see if it reports any issues; address any potential problems
		* Test your updated TWiki installation to see if you can view, create, edit and rename topics; upload and move attachments; register users
		* Test if the installed Plugins work as expected. You should see the list of installed Plugins in [[%TWIKIWEB%.WebHome]]
d101 1
a101 3
*Note:* These steps assume a downtime during the time of upgrade. You could install the new version in parallel to the existing one and switch over in an instant without affecting the users. As a guideline, install the new version into =$TWIKIROOT/bin1=, =$TWIKIROOT/lib1=, =$TWIKIROOT/templates1=, =$TWIKIROOT/data/TWiki1= (from =data/TWiki=), =$TWIKIROOT/pub/TWiki1= (from =pub/TWiki=), and configure =TWiki.cfg= to point to the same data and pub directory like the existing installation. Once tested and ready to go, reconfigure =$TWIKIROOT/bin1/setlib.cfg= and =$TWIKIROOT/lib1/TWiki.cfg=, then rename =$TWIKIROOT/bin= to =$TWIKIROOT/bin2=, =$TWIKIROOT/bin1= to =$TWIKIROOT/bin=. Do the same with the =lib=, =templates= and =data/TWiki= directories.

---++ Known Issues
d103 1
a103 5
	* Check TWiki:Codev/KnownIssuesOfTWiki01Sep2004 for known issues of TWiki 01-Sep-2004 production release

-- TWiki:Main.PeterThoeny - 29 Aug 2004 %BR%

%STOPINCLUDE%
@
