Warning: This page has not been updated in over over a year and may be outdated or deprecated.
installation:migration_notes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
vufind2:migration_notes [2014/09/23 10:28] – [Migrating from VuFind 2.x to 2.y] emaijala | installation:migration_notes [2018/12/19 17:03] – [VuFind Migration Notes] demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== VuFind | + | ====== VuFind Migration Notes ====== |
- | This page provides notes on upgrading to VuFind | + | This page provides notes on upgrading to the latest |
- | ===== Migrating from VuFind 2.x to 2.y ===== | + | ===== Migrating from VuFind 2.x or Newer to the Latest Release |
- | Upgrading from one minor version of VuFind 2 to another | + | Upgrading from VuFind 2.x or newer is relatively easy, assuming that you isolate all of your changes to the [[configuration: |
- | Note that if you have made customizations to your Solr schema or configuration, | + | :!: Note that if you have made customizations to your Solr schema or configuration, |
- | Always make a backup before upgrading, just to be on the safe side!! | + | :!: Always make a backup before upgrading, just to be on the safe side!! |
+ | |||
+ | ==== Step-by-Step ==== | ||
Starting with VuFind 2.1, after unpacking the new VuFind, you should follow these steps to be sure your database and configurations are fully updated: | Starting with VuFind 2.1, after unpacking the new VuFind, you should follow these steps to be sure your database and configurations are fully updated: | ||
- | | + | |
- | | + | - :!: If you are simply downloading the new version rather than using Git, it is safer to delete non-customized files before unpacking, to ensure that obsolete files do not remain as part of your installation -- this is particularly important for the solr/vendor directory. |
- | | + | - If you are installing from Git rather than a downloaded archive, run " |
- | | + | - Make sure that the config/ |
+ | | ||
+ | - Visit < | ||
+ | | ||
+ | | ||
- | It is also strongly recommended that you check the [[..: | + | :!: It is also strongly recommended that you check the [[..: |
- | Note that Java 1.7 is required starting | + | :!: It is usually a good idea to reindex your records in Solr after an upgrade, assuming you are running a Solr-based VuFind instance. |
+ | |||
+ | :!: If you have to maintain a significant number of custom templates, [[http:// | ||
+ | |||
+ | :!: If you upgrade by reinstalling the DEB package instead of simply unpacking a .zip or .tar.gz archive, be aware that some defaults (particularly in local/ | ||
+ | |||
+ | :!: Make sure that your system meets the [[installation: | ||
+ | |||
+ | === Special Notes on Upgrading with PostgreSQL === | ||
+ | |||
+ | VuFind' | ||
+ | |||
+ | < | ||
+ | |||
+ | === Special Notes on Upgrading from 2.x to 3.x === | ||
+ | |||
+ | VuFind 2.x uses Solr 4 while VuFind | ||
+ | |||
+ | Before unpacking the 3.x distribution on top of 2.x, it is recommended that you follow these steps: | ||
+ | |||
+ | - Delete vufind.sh/ | ||
+ | - Rename your existing solr directory to solr_old (this way you can easily revert if you have problems with the upgrade; after successfully reindexing your data and testing your upgraded VuFind, you can remove the solr_old directory). | ||
===== Migrating from VuFind 1.x ===== | ===== Migrating from VuFind 1.x ===== | ||
+ | |||
+ | :!: You should not upgrade directly from VuFind 1.x to VuFind 3.0 or newer. If you still have a 1.x instance, it is recommended that you upgrade from VuFind 1.x to the latest VuFind 2.x release, and then from there to the newest version. | ||
Although you have the highest chances of a smooth upgrade process if you migrate from the most recent 1.x release of VuFind, you can skip intermediate steps if you want to -- VuFind 2's upgrade process should be able to handle migration from most versions in the 1.x series. | Although you have the highest chances of a smooth upgrade process if you migrate from the most recent 1.x release of VuFind, you can skip intermediate steps if you want to -- VuFind 2's upgrade process should be able to handle migration from most versions in the 1.x series. | ||
Line 27: | Line 56: | ||
* Make sure that VuFind 1 is running -- the upgrade script will need access to your Solr index. | * Make sure that VuFind 1 is running -- the upgrade script will need access to your Solr index. | ||
* Upgrade Java to 1.7 if needed. | * Upgrade Java to 1.7 if needed. | ||
- | * Install a copy of VuFind 2 according to the [[installation notes]]. | + | * Install a copy of VuFind 2 according to the [[: |
* Instead of navigating to < | * Instead of navigating to < | ||
* The automatic upgrade will handle most of your configurations, | * The automatic upgrade will handle most of your configurations, | ||
- | * Custom code - most code changes can now be isolated to a [[customizing_vufind_2.0# | + | * Custom code - most code changes can now be isolated to a [[development: |
- | * Custom themes - 2.0 themes use PHP templates instead of Smarty and have a different directory structure -- see [[customizing the user interface]]. Note that the [[https:// | + | * Custom themes - 2.0 themes use PHP templates instead of Smarty and have a different directory structure -- see [[development: |
* Solr schema/ | * Solr schema/ | ||
* Shut down VuFind 1, reindex your records into VuFind 2, and start VuFind 2's Solr instance. | * Shut down VuFind 1, reindex your records into VuFind 2, and start VuFind 2's Solr instance. | ||
- | * For security, disable web server write access to the config/ | + | * For security, disable web server write access to the config/ |
- | Obviously, it is strongly recommended that you prepare your VuFind 2.0 upgrade on a test server prior to doing this in production -- porting old customizations is not a trivial process. | + | Obviously, it is strongly recommended that you prepare your VuFind 2.x upgrade on a test server prior to doing this in production -- porting old customizations is not a trivial process. |
Remember that help is available at the [[http:// | Remember that help is available at the [[http:// |
installation/migration_notes.txt · Last modified: 2024/02/07 15:47 by demiankatz