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 revision | ||
vufind2:migration_notes [2014/09/23 10:28] – [Migrating from VuFind 2.x to 2.y] emaijala | installation:migration_notes [2024/02/07 15:47] (current) – demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | This page provides notes on upgrading to VuFind 2.x from earlier versions. | + | This page provides notes on upgrading to the latest VuFind® release |
- | ===== Migrating from VuFind 2.x to 2.y ===== | + | :!: Please note that even though most of the version-specific notes here refer to very old versions, the information is still relevant to current releases. The process has simply remained stable for many years. |
- | Upgrading | + | ===== Migrating |
- | Note that if you have made customizations to your Solr schema or configuration, | + | Upgrading from VuFind® 2.x or newer is relatively easy, assuming |
- | Always make a backup before upgrading, just to be on the safe side!! | + | :!: Note that if you have made customizations to your Solr schema or configuration, these changes will need to be reapplied manually. |
- | 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: | + | :!: Always make a backup before upgrading, just to be on the safe side!! |
- | * Make sure that the config/ | + | ==== Step-by-Step ==== |
- | * Visit < | + | |
- | * Review the auto-upgraded configurations; | + | |
- | * Disable web server write access to the config/ | + | |
- | It is also strongly recommended that you check the [[..:changelog]] for notes on backward-incompatible changes that might affect e.g. your local customizations. | + | Starting with VuFind® 2.1, after unpacking the new VuFind®, |
- | Note that Java 1.7 is required starting with VuFind 2.3. | + | - Unpack the new version of VuFind® on top of the old version. This will most commonly involve simply downloading the new version, but if you are using Git for version control, it can also be achieved by checking out or merging a different version tag. |
- | ===== Migrating | + | - :!: If you are simply downloading the new version rather than using Git, it is safer to delete non-customized files before unpacking, to ensure |
+ | - If you are installing from Git rather than a downloaded archive, run " | ||
+ | - Make sure that the config/ | ||
+ | - Empty out the cache subdirectory of your [[configuration: | ||
+ | - Visit < | ||
+ | - Review the auto-upgraded configurations; | ||
+ | - Disable web server write access to the config/ | ||
- | Although | + | :!: It is also strongly recommended that you check the [[..: |
- | * Make sure that VuFind 1 is running -- the upgrade script will need access to your Solr index. | + | :!: 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® 3.x uses Solr 5. If you are upgrading from 2.x to 3.x, you will notice some important changes: the solr directory contents will be structured differently, | ||
+ | |||
+ | 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 ===== | ||
+ | |||
+ | :!: 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. | ||
+ | |||
+ | * Make sure that VuFind® | ||
* Upgrade Java to 1.7 if needed. | * Upgrade Java to 1.7 if needed. | ||
- | * Install a copy of VuFind | + | * Install a copy of VuFind® |
- | * 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 | + | * Shut down VuFind® |
- | * 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 | + | Obviously, it is strongly recommended that you prepare your VuFind® |
Remember that help is available at the [[http:// | Remember that help is available at the [[http:// | ||
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
installation/migration_notes.txt · Last modified: 2024/02/07 15:47 by demiankatz