| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| legacy:installation:migration_notes [2015/12/08 19:54] – ↷ Links adapted because of a move operation demiankatz | legacy:installation:migration_notes [2015/12/14 18:12] – ↷ Links adapted because of a move operation demiankatz |
|---|
| This page should be used to suggest best practices for moving from one version of VuFind to another -- database changes, URL remappings, etc. | This page should be used to suggest best practices for moving from one version of VuFind to another -- database changes, URL remappings, etc. |
| |
| Next to upgrading via upgrade script, there's also the possibility to use a versioning control-tool (for example [[:subversion#upgrading_an_old_custom_vufind_version_using_subversion|Subversion]]) | Next to upgrading via upgrade script, there's also the possibility to use a versioning control-tool (for example [[legacy:vufind_1.x_developer_manual:subversion#upgrading_an_old_custom_vufind_version_using_subversion|Subversion]]) |
| |
| ===== Upgrading to 2.x ===== | ===== Upgrading to 2.x ===== |
| |
| See the [[vufind2:migration_notes|VuFind 2.x migration notes]] page. | See the [[installation:migration_notes|VuFind 2.x migration notes]] page. |
| |
| ===== Upgrading 1.3 to 1.4 ===== | ===== Upgrading 1.3 to 1.4 ===== |
| Check the Solr configuration in the solr directory and the SolrMarc configuration in the import directory. These are not touched by the upgrade script and will most likely require some manual adjustments. | Check the Solr configuration in the solr directory and the SolrMarc configuration in the import directory. These are not touched by the upgrade script and will most likely require some manual adjustments. |
| |
| 1.4's Solr schema adds several new fields to support [[:hierarchies_and_collections]]. The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. | 1.4's Solr schema adds several new fields to support [[indexing:hierarchies_and_collections|hierarchies and collections]]. The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. |
| |
| Once you are satisfied with your SolrMarc configuration, it is recommended that you [[:re-indexing|reindex all of your records]]. While the 1.4 schema should be compatible with the 1.3 schema, and both releases use the same Solr version, upgrades are a good time to refresh your index. | Once you are satisfied with your SolrMarc configuration, it is recommended that you [[indexing:re-indexing|reindex all of your records]]. While the 1.4 schema should be compatible with the 1.3 schema, and both releases use the same Solr version, upgrades are a good time to refresh your index. |
| |
| === Other Configuration Files === | === Other Configuration Files === |
| === Code and Template Customization === | === Code and Template Customization === |
| |
| Obviously, if you have customized 1.3's code or templates, these changes will have to be reintegrated with your 1.4 installation. Most of 1.4's template changes have to do with its new [[:hierarchies_and_collections]] functionality. Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! | Obviously, if you have customized 1.3's code or templates, these changes will have to be reintegrated with your 1.4 installation. Most of 1.4's template changes have to do with its new [[indexing:hierarchies_and_collections|hierarchies and collections]] functionality. Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! |
| |
| Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[:subversion#vendor_branching|Subversion Vendor Branching]]. | Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[legacy:vufind_1.x_developer_manual:subversion#vendor_branching|Subversion Vendor Branching]]. |
| |
| ===== Upgrading 1.2 to 1.3 ===== | ===== Upgrading 1.2 to 1.3 ===== |
| 1.3's Solr schema has one significant difference from 1.2's (the addition of a publishDateSort field necessitated by changes in Solr 3.x). The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. | 1.3's Solr schema has one significant difference from 1.2's (the addition of a publishDateSort field necessitated by changes in Solr 3.x). The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. |
| |
| Once you are satisfied with your SolrMarc configuration, [[:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.3 with a 1.2-generated index may not work correctly since the new release uses a much newer version of Solr. | Once you are satisfied with your SolrMarc configuration, [[indexing:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.3 with a 1.2-generated index may not work correctly since the new release uses a much newer version of Solr. |
| |
| === Other Configuration Files === | === Other Configuration Files === |
| Obviously, if you have customized 1.2's code or templates, these changes will have to be reintegrated with your 1.3 installation. Most of 1.3's template changes have to do with its new bulk "book bag" functionality. Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! | Obviously, if you have customized 1.2's code or templates, these changes will have to be reintegrated with your 1.3 installation. Most of 1.3's template changes have to do with its new bulk "book bag" functionality. Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! |
| |
| Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[:subversion#vendor_branching|Subversion Vendor Branching]]. | Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[legacy:vufind_1.x_developer_manual:subversion#vendor_branching|Subversion Vendor Branching]]. |
| |
| ===== Upgrading 1.1 to 1.2 ===== | ===== Upgrading 1.1 to 1.2 ===== |
| 1.2's Solr schema has one minor difference from 1.1's (the addition of the dewey-raw field to aid with call number browsing). The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. | 1.2's Solr schema has one minor difference from 1.1's (the addition of the dewey-raw field to aid with call number browsing). The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. |
| |
| Once you are satisfied with your SolrMarc configuration, [[:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.2 with a 1.1-generated index may not work correctly. | Once you are satisfied with your SolrMarc configuration, [[indexing:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.2 with a 1.1-generated index may not work correctly. |
| |
| === Other Configuration Files === | === Other Configuration Files === |
| Obviously, if you have customized 1.1's code or templates, these changes will have to be reintegrated with your 1.2 installation. Most of the 1.2's template changes have to do with its expanded ILS behavior. If you have implemented holds in your own way, you may want to reimplement them using VuFind's new standard mechanism ([[http://blog.library.villanova.edu/libtech/2011/06/02/expanded-ils-functionality-in-vufind/|this article]] may help). Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! | Obviously, if you have customized 1.1's code or templates, these changes will have to be reintegrated with your 1.2 installation. Most of the 1.2's template changes have to do with its expanded ILS behavior. If you have implemented holds in your own way, you may want to reimplement them using VuFind's new standard mechanism ([[http://blog.library.villanova.edu/libtech/2011/06/02/expanded-ils-functionality-in-vufind/|this article]] may help). Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! |
| |
| Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[:subversion#vendor_branching|Subversion Vendor Branching]]. | Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[legacy:vufind_1.x_developer_manual:subversion#vendor_branching|Subversion Vendor Branching]]. |
| |
| ===== Upgrading 1.0.x to 1.1 ===== | ===== Upgrading 1.0.x to 1.1 ===== |
| Check the Solr configuration in the solr directory and the SolrMarc configuration in the import directory. These are not touched by the upgrade script and will most likely require some manual adjustments. | Check the Solr configuration in the solr directory and the SolrMarc configuration in the import directory. These are not touched by the upgrade script and will most likely require some manual adjustments. |
| |
| 1.1's Solr schema has some differences from 1.0.x's (to support new features like [[:tracking_record_changes]], to eliminate some unused legacy fields, and to resolve issues like [[http://vufind.org/jira/browse/VUFIND-259|VUFIND-259]] and [[http://vufind.org/jira/browse/VUFIND-322|VUFIND-322]]). The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. | 1.1's Solr schema has some differences from 1.0.x's (to support new features like [[indexing:tracking_record_changes|tracking record changes]], to eliminate some unused legacy fields, and to resolve issues like [[http://vufind.org/jira/browse/VUFIND-259|VUFIND-259]] and [[http://vufind.org/jira/browse/VUFIND-322|VUFIND-322]]). The upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. |
| |
| Once you are satisfied with your SolrMarc configuration, [[:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.1 with a 1.0.x-generated index will not work correctly. | Once you are satisfied with your SolrMarc configuration, [[indexing:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.1 with a 1.0.x-generated index will not work correctly. |
| |
| === Other Configuration Files === | === Other Configuration Files === |
| Here are a few changes that are likely to affect you: | Here are a few changes that are likely to affect you: |
| |
| * VuFind's Javascript files have been moved around so that more JS code is contained inside the theme directories. This allows the introduction of a new {js} Smarty tag that includes Javascript files in [[:customization#theme_inheritance|theme inheritance]], which makes local customization easier than it used to be. However, it means that if you have hard-coded Javascript paths in your custom templates, you should replace them with appropriate {js} calls, and if you have customized any of the ajax.js files previously found under the web/services directory, you will need to move your customizations to the renamed files in the web/interface/themes/[your_theme]/js directory. | * VuFind's Javascript files have been moved around so that more JS code is contained inside the theme directories. This allows the introduction of a new {js} Smarty tag that includes Javascript files in [[legacy:vufind_1.x_developer_manual:user_interface_customization#theme_inheritance|theme inheritance]], which makes local customization easier than it used to be. However, it means that if you have hard-coded Javascript paths in your custom templates, you should replace them with appropriate {js} calls, and if you have customized any of the ajax.js files previously found under the web/services directory, you will need to move your customizations to the renamed files in the web/interface/themes/[your_theme]/js directory. |
| * All AJAX calls have been changed to use JSON instead of XML, and the AJAX handlers in the various web/services subdirectories have been consolidated into fewer files in the web/services/AJAX directory. If you have customized any AJAX-related code, you will need to do some work to reconcile it with the new layout... but take comfort in the fact that the new method makes everything significantly less complicated! | * All AJAX calls have been changed to use JSON instead of XML, and the AJAX handlers in the various web/services subdirectories have been consolidated into fewer files in the web/services/AJAX directory. If you have customized any AJAX-related code, you will need to do some work to reconcile it with the new layout... but take comfort in the fact that the new method makes everything significantly less complicated! |
| * The [[:other_than_marc|record driver]] interface has been slightly changed to move real-time holdings lookup inside the record drivers, rather than having it hard-coded in the Record/Holdings controller. This makes it easier for you to control which records VuFind looks up in your ILS. If you are using custom record drivers, you may need to make some minor adjustments to account for changes to getHoldings(), but for most common applications this will not make a difference to you. You may also need to implement the new getXML method introduced for [[:tracking_record_changes#oai-pmh_server_functionality|OAI-PMH server support]]. | * The [[legacy:vufind_1.x_developer_manual:supporting_a_new_metadata_format|record driver]] interface has been slightly changed to move real-time holdings lookup inside the record drivers, rather than having it hard-coded in the Record/Holdings controller. This makes it easier for you to control which records VuFind looks up in your ILS. If you are using custom record drivers, you may need to make some minor adjustments to account for changes to getHoldings(), but for most common applications this will not make a difference to you. You may also need to implement the new getXML method introduced for [[indexing:tracking_record_changes#oai-pmh_server_functionality|OAI-PMH server support]]. |
| * Thumbnail URL generation (using bookcover.php) is now largely controlled by the getThumbnail method of the record driver -- this allows easier customization/overriding without huge amounts of template editing, but you may have to update custom templates if they are doing inline generation of bookcover.php links. | * Thumbnail URL generation (using bookcover.php) is now largely controlled by the getThumbnail method of the record driver -- this allows easier customization/overriding without huge amounts of template editing, but you may have to update custom templates if they are doing inline generation of bookcover.php links. |
| |
| Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! | Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! |
| |
| Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[:subversion#vendor_branching|Subversion Vendor Branching]]. | Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[legacy:vufind_1.x_developer_manual:subversion#vendor_branching|Subversion Vendor Branching]]. |
| |
| === Dependencies === | === Dependencies === |
| === Automation === | === Automation === |
| |
| If you want to take advantage of the new [[:alphabetical_heading_browse]], be aware that you will need to add heading generation to your automated update process in order to keep the browse lists in sync with your index. | If you want to take advantage of the new [[indexing:alphabetical_heading_browse|alphabetical heading browse]], be aware that you will need to add heading generation to your automated update process in order to keep the browse lists in sync with your index. |
| |
| ===== Upgrading to 1.0.1 ===== | ===== Upgrading to 1.0.1 ===== |
| Due to changes in the latest version of SolrMarc, any custom indexing scripts you wrote are now found in the import/index_scripts directory rather than in import/scripts. When you copy your customizations from the old version, be sure you put them in the right place! | Due to changes in the latest version of SolrMarc, any custom indexing scripts you wrote are now found in the import/index_scripts directory rather than in import/scripts. When you copy your customizations from the old version, be sure you put them in the right place! |
| |
| 1.0's Solr schema has some differences from RC2's (mainly due to the introduction of [[:other_than_marc|record drivers]]), and the upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. | 1.0's Solr schema has some differences from RC2's (mainly due to the introduction of [[legacy:vufind_1.x_developer_manual:supporting_a_new_metadata_format|record drivers]]), and the upgrade script does not attempt to merge your customizations to the Solr schema or SolrMarc MARC mappings with the new installation. You will have to do this by hand. |
| |
| Once you are satisfied with your SolrMarc configuration, [[:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.0 with an RC2-generated index will not work correctly. | Once you are satisfied with your SolrMarc configuration, [[indexing:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run 1.0 with an RC2-generated index will not work correctly. |
| |
| === Other Configuration Files === | === Other Configuration Files === |
| === Code and Template Customization === | === Code and Template Customization === |
| |
| Obviously, if you have customized RC2's code or templates, these changes will have to be reintegrated with your 1.0 installation. The biggest changes have to do with the way records are displayed -- a lot of code on the record view and search results screens has been moved into a [[:other_than_marc|record driver]] module. If you have customized record views, you may have to reimplement your changes in a slightly different way. Hopefully the greatly improved flexibility of the new model makes it worth the effort! Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! | Obviously, if you have customized RC2's code or templates, these changes will have to be reintegrated with your 1.0 installation. The biggest changes have to do with the way records are displayed -- a lot of code on the record view and search results screens has been moved into a [[legacy:vufind_1.x_developer_manual:supporting_a_new_metadata_format|record driver]] module. If you have customized record views, you may have to reimplement your changes in a slightly different way. Hopefully the greatly improved flexibility of the new model makes it worth the effort! Feel free to ask questions on the [[https://lists.sourceforge.net/mailman/listinfo/vufind-tech|vufind-tech]] mailing list if you need help! |
| |
| Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[:subversion#vendor_branching|Subversion Vendor Branching]]. | Remember, if you do a lot of local customizations and find the upgrade process unreasonably tedious, you may be able to make your life easier by using [[legacy:vufind_1.x_developer_manual:subversion#vendor_branching|Subversion Vendor Branching]]. |
| |
| ===== Upgrading RC1 to RC2 ===== | ===== Upgrading RC1 to RC2 ===== |
| Note that the version of SolrMarc included with RC2 is a great deal more configurable than the version in RC1. You may be able to achieve your old customizations more easily, without the need to build your own customized version of the SolrMarc .jar file. See the [[:changelog]] for more details on new features. | Note that the version of SolrMarc included with RC2 is a great deal more configurable than the version in RC1. You may be able to achieve your old customizations more easily, without the need to build your own customized version of the SolrMarc .jar file. See the [[:changelog]] for more details on new features. |
| |
| Once you are satisfied with your SolrMarc configuration, [[:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run RC2 with an RC1-generated index will not work. | Once you are satisfied with your SolrMarc configuration, [[indexing:re-indexing|REINDEX ALL OF YOUR RECORDS]]. Attempting to run RC2 with an RC1-generated index will not work. |
| |
| === Code and Template Customization === | === Code and Template Customization === |
