==
= Upgrading From Kete 1.0 to Kete 1.1 =
==
For detailed instructions on upgrading from Kete 1.0 to Kete 1.1, please refer to
the online documentation at
http://kete.net.nz/documentation/topics/show/177-upgrading-to-kete-11-release
You can safely ignore everything below here if you follow the online topic.
==
= Incremental Upgrade Instructions
==
Originally contributed by James Stradling <james@katipo.co.nz> - 2008-05-16
The following steps are only necessary if you continuously upgrade your code base to the latest Kete trunk.
Occasionally there are additional minor steps needed to update your Kete installation between revisions.
You can find these by scrolling down to the time where you last updated Kete, and going up through the additional steps.
GENERAL NOTE: If you have a lot of things to do, you could alternatively follow the upgrade guide mentioned above, which is
essentially a collection of all the commands used below into one step by step guide.
GENERAL NOTE: It is assumed you are upgrading from an earlier functional and unmodified trunk version. If not, be sure to preserve
the customizations you want to keep when you upgrade the code base.
GENERAL NOTE: Quite often you'll only have to do steps once to get the changes from multiple revisions. In other words,
if a step is listed from multiple revisions, you only have to do it once.
IMPORTANT NOTE: For any steps where you run, "rake db:migrate", it is a good idea to back up your database before you run that step.
GENERAL NOTE: if you are upgrading your production Kete instance rather than development, you'll add "RAILS_ENV=production" to all rake tasks.
GENERAL NOTE: if you are running in production mode, you may also want to do a "rake tmp:cache:clear" as your last step to any of these.
However, if you updated your code via a Capistrano deploy, this is probably not necessary.
== 2008/08/07 - Fixing Caching Issues
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. rake tmp:cache:clear (not necessary for capistrano deployments)
4. Start your Kete server again (mongrels, backgroundrb)
== 2008/08/01 - Making search for contributions by a user be limited to login, rather than non-unique user name
1. Stop your Kete server (mongrels).
2. Upgrade your code base
3. Start your Kete server again (mongrels)
4. Rebuild your search records (see other tasks below for summary under "Use the web interface to repopulate your Zebra database...")
== 2008/08/01 - Adding system setting for Syntax Highlighting support
1. Stop your Kete server (mongrels).
2. Upgrade your code base
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels)
== 2008/07/18 - Upgrading backgroundrb and packet gem
1. Upgrade your code base
2. Down/Upgrade to packet 0.1.7 (the next version is buggy). You can skip this step if you already have packet 0.1.7 installed.
$ gem uninstall packet --all
$ gem install packet --version 0.1.7
3. Edit config/backgroundrb.yml and update it to match the structure of config/backgroundrb.yml.example. Point the :memcached: section to the appropriate IP of the memcached server (default should usually suffice).
4. Run the database migration 'rake db:migrate'
5. Restart your Kete instance (mongrels)
6. Restart your Backgroundrb instance:
./script/backgroundrb stop
./script/backgroundrb start
== Trunk r1324 - support for basket list navigation in a left column, experimental
1. Stop your Kete server (mongrels).
2. Upgrade your code base
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels)
== Trunk r1322 - ticket #206 simple bulk import of related items
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the database migration 'rake db:migrate'
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels, backgroundrb)
== Trunk r1304 - Removal of foreign key constraint causing topic + related item deletion failure.
1. Upgrade your code base
2. Run the database migration 'rake db:migrate'
3. Restart your Kete instance (mongrels)
== Trunk r1254 - Adding OAI-PMH Repository functionality and significant refactoring of search. This is a big one if you have lots of items in Kete.
1. Upgrade your code base
2. Run the database migration 'rake db:migrate'
3. Stop your Kete instance (mongrels)
Next, You'll need to rebuild your Zebra indexes to have dates sort without error. Here's how:
4. Run this script to clear your public Zebra database: 'rake zebra:init'
5. Run this script to clear your private Zebra database: 'rake zebra:init ZEBRA_DB=private'
6. Run this script to stop your Zebra server: 'rake zebra:stop'
7. Run this script to start your Zebra server: 'rake zebra:start'
8. Run the kete upgrade steps with 'rake kete:upgrade'
8. Start your Kete server again (mongrels, backgroundrb)
9. Use the web interface to repopulate your Zebra databases with these steps:
* make sure you are logged into the site as as the default administrator or an account that has been designated as a "tech admin" and have javascript enabled in your browser.
* visit the following URLs (adjust for your site's URL) and let them click over (ajax update of page) until you get a "done"
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=StillImage
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=AudioRecording
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Video
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=WebLink
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Document
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Comment
* then double check that search results are good to go by clicking on "Browse" from any page or doing a search
== Trunk r1251 - Workaround for 'svn up' issue regarding public/javascripts and vendor/plugins/acts_as_licensed
1. Remove the folder public/javascripts
2. Remove the folder vendor/plugins/acts_as_licensed
3. Upgrade your code base
4. Restart your Kete instance (mongrels)
== Trunk r1237 - Bug fixes for tagging on private item versions.
1. Upgrade your code base
2. Run the database migration 'rake db:migrate'
3. Restart your Kete instance (mongrels)
== Trunk r1235 - Added system setting for the placeholder details used on public versions of items when no public version is available.
1. Upgrade your code base
2. Run the upgrade rake task 'rake kete:upgrade'
3. Restart your Kete instance (mongrels)
== Trunk r1225 - MySQL only, change column definitions to allow for larger amount of text
1. Upgrade your code base
2. Run the migrate rake task 'rake db:migrate'
== Trunk r1196 - Added HTTPS/SSL support
To update from r1196 or later, follow these instructions:
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the kete upgrade rake task 'rake kete:upgrade'
4. Start your Kete server again (mongrels, backgroundrb)
Note: You must have a web server and SSL certificate correctly configured
in order to take advantage of SSL features in this version. The SSL features are
disabled by default and can be enabled in the Server advanced settings in the
configuration assistant/reconfigure site controls.
== Trunk r1174 - Added per basket privacy control enable/disable preferences
To update from r1169 through r1173, all you need to do is the following:
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the database migration 'rake db:migrate'
4. Start your Kete server again (mongrels, backgroundrb)
If you are updating from an earlier version, please following the instructions for trunk r1169 below.
== Trunk r1169 - Content Licensing Controls Added
This version includes content licensing controls in addition to the privacy control functionality added in r1148.
The following instructions are for use when updating from a trunk version of Kete to a version r1169 or later.
NB: All commands must be made from the main Kete application directory.
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the database migration 'rake db:migrate'
NB: This adds new columns and tables in the kete database. If you have customized Kete or
need to reverse the upgrade, this may cause issues. See migrations 046 through 060 in
/db/migrate/ for an insight into the database schema changes made.
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels, backgroundrb)
Optionally, you can run rake acts_as_licensed:import_nz_cc_licenses to
add Creative Commons New Zealand licenses options to your Kete
instance. After that, you probably want to reconfigure your site in
Advanced Options > Server > Default Content License.
== Trunk r1107 - Search and Browse results sorting
You'll need to rebuild your Zebra indexes to have dates sort without error. Here's how:
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run this script to clear your public Zebra database: 'rake zebra:init'
4. Run this script to clear your private Zebra database: 'rake zebra:init ZEBRA_DB=private'
5. Run this script to stop your Zebra server: 'rake zebra:stop'
6. Run this script to start your Zebra server: 'rake zebra:start'
7. Start your Kete server again (mongrels, backgroundrb)
8. Use the web interface to repopulate your Zebra databases with these steps:
* make sure you are logged into the site as as the default administrator or an account that has been designated as a "tech admin" and have javascript enabled in your browser.
* visit the following URLs (adjust for your site's URL) and let them click over (ajax update of page) until you get a "done"
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=StillImage
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=AudioRecording
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Video
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=WebLink
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Document
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Comment
* then double check that search results are good to go by clicking on "Browse" from any page or doing a search
