Difference between revisions of "Upgrading"

From EPrints Documentation
Jump to: navigation, search
(Added Manual)
(epindexer and site-wide configuration integrated, formatting adjusted)
 
Line 7: Line 7:
  
 
=== From GitHub ===
 
=== From GitHub ===
If you have installed with GitHub you can update to the latest version using the following commands, substituting y form the version you want:
+
If you have installed with GitHub you can update to the latest version using the following commands, substituting ''y'' for the version you want:
  
 
  git fetch origin
 
  git fetch origin
 
  git merge tags/v3.3.y
 
  git merge tags/v3.3.y
  
This should warn you if you have made any locally uncommitted changes.  You may need to use ''git stash'' to move these temporarily and reintegrate after updating from GitHUb.
+
This should warn you if you have made any locally uncommitted changes.  You may need to use ''git stash'' to move these temporarily and reintegrate after updating from GitHub.
  
 
=== From a Tarball ===
 
=== From a Tarball ===
 
Although not impossible it is strongly discouraged to upgrade from a tarball.  One major reason not to do this is that if you have made any local changes other than to your original archive's configuration, it will be difficult to ensure all these modifications are retained.  However, if you wish to do this, you can follow the instructions below, (as the eprints user unless otherwise stated):
 
Although not impossible it is strongly discouraged to upgrade from a tarball.  One major reason not to do this is that if you have made any local changes other than to your original archive's configuration, it will be difficult to ensure all these modifications are retained.  However, if you wish to do this, you can follow the instructions below, (as the eprints user unless otherwise stated):
 +
<ol>
 +
<li> Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)</li>
  
1. Download the tarball from files.eprints.org, (e.g. http://files.eprints.org/1073/2/eprints-3.3.15.tar.gz)
+
<li> As the root user, unpack the tarball under the same parent path as your existing EPrints and change the ownership of this whole directory structure</li>
  
2. As the root user, unpack the tarball under the same parent path as your existing EPrints and change the ownership of this whole directory structure:
+
cd /opt
 +
tar -xzvf eprints-3.3.16.tar.gz
 +
mv eprints-3.3.16 eprints3_new
 +
chown -R eprints:eprints /opt/eprints3_new
  
tar -xzvf eprints-3.3.15.tar.gz /opt/eprints3_new
+
<li> As the root user, stop Apache and EPrints' indexer.</li>
  chown -R eprints:eprints /opt/eprints3_new
+
 
 +
  apachectl graceful-stop
 +
/opt/eprints3/bin/epindexer stop
  
3. Move the archive(s) from your old EPrints to your new one, e.g.:
+
<li> Move the archive(s) from your old EPrints to your new one, e.g.</li>
  
 
  mv /opt/eprints3/archives/* /opt/eprints3_new/archives/
 
  mv /opt/eprints3/archives/* /opt/eprints3_new/archives/
  
4. Copy SystemSettings.pm to you new EPrints
+
<li> Copy SystemSettings.pm to your new EPrints as well as site-wide settings</li>
  
  cp /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/
+
  cp -p /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/
 +
cp -pR /opt/eprints3/cfg /opt/eprints3_new/cfg
 +
cp -pR /opt/eprints3/site_lib /opt/eprints3_new/site_lib
  
5. If you are aware of any local modifications to files under your EPrints path (e.g. /opt/eprints3) but outside in the archives directory then compare these files using diff to work out how your local changes can be integrated.  E.g.
+
<li> If you are aware of any local modifications to files under your EPrints path (e.g. /opt/eprints3) but outside the archives directory then compare these files using diff to work out how your local changes can be integrated.  E.g.</li>
  
 
  diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm  
 
  diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm  
  
6. As the root user, switch round the old and new versions of EPrints, e.g.
+
<li> As the root user, switch round the old and new versions of EPrints, e.g.</li>
  
 
  mv /opt/eprints3 /opt/eprints3_old
 
  mv /opt/eprints3 /opt/eprints3_old
 
  mv /opt/eprints3_new /opt/eprints3
 
  mv /opt/eprints3_new /opt/eprints3
  
7. Run epadmin test to check there are no configuration issues, e.g.:
+
<li> Run epadmin test to check there are no configuration issues, e.g.</li>
  
 
  /opt/eprints3/bin/epadmin test
 
  /opt/eprints3/bin/epadmin test
  
8. As the root user, restart Apache.
+
<li> Restart EPrints' indexer.</li>
 +
 
 +
/opt/eprints3/bin/epindexer start
 +
 
 +
<li> As the root user, restart Apache.</li>
  
 
  apachectl restart
 
  apachectl restart
  
 +
<li>Don't forget to reinstall your Bazaar packages.</li>
 +
</ol>
  
 
== Upgrading to EPrints to 3.3 ==
 
== Upgrading to EPrints to 3.3 ==

Latest revision as of 13:07, 22 October 2020

Manual Sections

Upgrade from 3.3.x to 3.3.y

From a Linux Package Manager

If you have installed from the Deb or RPM package, then you can just upgrade this. However, it is recommended that you have done a backup before doing this. Also if this is on a production server, that you do this during an extended period of scheduled downtime and have previously tested the upgrade on a pre-production server.

From GitHub

If you have installed with GitHub you can update to the latest version using the following commands, substituting y for the version you want:

git fetch origin
git merge tags/v3.3.y

This should warn you if you have made any locally uncommitted changes. You may need to use git stash to move these temporarily and reintegrate after updating from GitHub.

From a Tarball

Although not impossible it is strongly discouraged to upgrade from a tarball. One major reason not to do this is that if you have made any local changes other than to your original archive's configuration, it will be difficult to ensure all these modifications are retained. However, if you wish to do this, you can follow the instructions below, (as the eprints user unless otherwise stated):

  1. Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)
  2. As the root user, unpack the tarball under the same parent path as your existing EPrints and change the ownership of this whole directory structure
  3. cd /opt
    tar -xzvf eprints-3.3.16.tar.gz
    mv eprints-3.3.16 eprints3_new
    chown -R eprints:eprints /opt/eprints3_new
    
  4. As the root user, stop Apache and EPrints' indexer.
  5. apachectl graceful-stop
    /opt/eprints3/bin/epindexer stop
    
  6. Move the archive(s) from your old EPrints to your new one, e.g.
  7. mv /opt/eprints3/archives/* /opt/eprints3_new/archives/
    
  8. Copy SystemSettings.pm to your new EPrints as well as site-wide settings
  9. cp -p /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/
    cp -pR /opt/eprints3/cfg /opt/eprints3_new/cfg
    cp -pR /opt/eprints3/site_lib /opt/eprints3_new/site_lib
    
  10. If you are aware of any local modifications to files under your EPrints path (e.g. /opt/eprints3) but outside the archives directory then compare these files using diff to work out how your local changes can be integrated. E.g.
  11. diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm 
    
  12. As the root user, switch round the old and new versions of EPrints, e.g.
  13. mv /opt/eprints3 /opt/eprints3_old
    mv /opt/eprints3_new /opt/eprints3
    
  14. Run epadmin test to check there are no configuration issues, e.g.
  15. /opt/eprints3/bin/epadmin test
    
  16. Restart EPrints' indexer.
  17. /opt/eprints3/bin/epindexer start
    
  18. As the root user, restart Apache.
  19. apachectl restart
    
  20. Don't forget to reinstall your Bazaar packages.

Upgrading to EPrints to 3.3

Upgrading from older 3.1 and 3.2 versions of EPrints to 3.3 is somewhat more involved. Please see the following guides: