| |
TWiki Upgrade Guide |
|
<
< | Upgrade from the previous TWiki 01-Sep-2004 Prodcution Release to TWiki-4.0.0 |
>
> | Upgrade from the previous TWiki 01-Sep-2004 Production Release to TWiki-4.X |
| | Overview |
|
<
< | TWiki-4.0.0 is a major new release. You can chose between an automated upgrade using a script or a manual update. |
>
> | TWiki-4.0.0 was a major new release. TWiki-4.1.0 is a minor release without dramatic changes since 4.0.0 |
| | Upgrade Requirements
|
|
<
< |
- To upgrade from a standard TWiki Release 01-Sep-2004 to the latest TWiki-4.0.0 Production Release, follow the instructions below
|
>
> |
- 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 Dakar. Make sure the Plugins you use can be upgraded as well!
|
>
> |
- 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 |
>
> | Major Changes Compared to TWiki Release 01-Sep-2004 and TWiki Release 4.0.0 |
| | |
|
<
< | 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 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, 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:
./UpgradeTwiki <full path to existing_twiki's setlib.cfg> <full path to new_twiki>
- 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.
|
>
> | See TWikiReleaseNotes04x00 and TWikiReleaseNotes04x01 |
| |
|
|
<
< | Manual Upgrade Procedure |
>
> | 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. |
|
<
< |
- Follow the installation instructions, and install the new release in a new directory.
- 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
- 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 '{}' \;
- 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.
- Transfer any customized and local settings from TWiki.TWikiPreferences to the topic pointed at by {LocalSitePreferences} (Main.TWikiPreferences). This avoids having to write over files in the distribution.
- 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:
- Install a copy of the original TWiki release you were using in a temporary directory
- Use 'diff' to find changed files, and transfer the changes into the new Dakar install.
- Install updated plugins into your new area.
- Point your webserver at the new install.
- Visit TWiki:Codev.KnownIssuesOfTWiki04x00x00 and fix known issues that apply to you.
- 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:
- Follow the installation instructions, and install the new release in a new directory.
- 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
- Copy over your
bin/LocalLib.cfg and lib/LocalSite.cfg files
- Copy over any local files you created (such as .htpasswd and .htaccess files)
- Point your webserver at the new install.
If you changed any of the distributed files, you will have to continue from Step 5 above. |
>
> | The main steps are:
- Install the new TWiki version, configure it, and get it to work similar to the old version
- Install additional extensions (Plugins). Make sure to use the latest versions
- Copy all the non-default webs from the old installation to the new
- Copy the users from old installation to the new incl all their topics from Main
- Apply tailorings to your Skin (logos, menu bars etc)
- 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 configure script to configure TWiki.
- If you are upgrading from a 4.0.x release, carry over the configure settings from the old release.
- Additional resources
- 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 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.
 Hint: For an easier upgrade later on, set the plugin preferences settings in the Main.TWikiPreferences 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 Main.TWikiPreferences.
- 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 smileys were added 4.0.0 and 4.0.2 so you can just leave this topic as it is.
- TablePlugin - Set TABLEATTRIBUTES
- Remember that a plugin must be activated in configure.
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.
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
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.
- 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 database. 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.
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:
Apply Preferences From Old Installation
- Transfer any customized and local settings from TWiki.TWikiPreferences to the topic pointed at by {LocalSitePreferences} (Main.TWikiPreferences). 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.
- 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.
|
| | Upgrading from Cairo to TWiki4 (additional advice) |
| | 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.
|
|
<
< |
- 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.
|
>
> |
- 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 TWikiPreferences |
| |
- Set FAVICON = /twiki/pub/TWiki/WebPreferences/favicon.ico
|
|
>
> | TWikiUsers topic in Main web
Your Cairo 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. |
| | |
|
<
< | Related Topics: AdminDocumentationCategory, TWiki:TWiki.UpgradingTWiki |
>
> | Related Topics: AdminDocumentationCategory, TWiki:TWiki.UpgradingTWiki, TWiki:TWiki.UpgradingTWiki04x00PatchReleases, TWiki:TWiki.InstallingTWiki#OtherPlatforms, TWiki:TWiki.ApacheConfigGenerator, TWiki:TWiki.SettingFileAccessRightsLinuxUnix |
| | |