Upgrading - Revision history

Th.lauke@arcor.de: category added

2025-02-25T12:56:49Z

category added

Th.lauke@arcor.de: URL/version upgrade

2024-11-01T13:19:18Z

URL/version upgrade

Th.lauke@arcor.de: typos removed, versions updated

2024-05-08T15:50:07Z

typos removed, versions updated

Drn@ecs.soton.ac.uk at 00:33, 6 March 2022

2022-03-06T00:33:44Z

Drn@ecs.soton.ac.uk: /* From a Linux Package Manager */

2021-05-10T23:26:36Z

‎From a Linux Package Manager

Drn@ecs.soton.ac.uk: /* Upgrade between same series versions of EPrints */

2021-05-10T23:23:44Z

‎Upgrade between same series versions of EPrints

Drn@ecs.soton.ac.uk: Updated upgrade instructions to make them applicable to 3.3 and 3.4 and ensure database gets upgraded/updated after the code is updated to the latest version.

2021-05-10T23:21:22Z

Updated upgrade instructions to make them applicable to 3.3 and 3.4 and ensure database gets upgraded/updated after the code is updated to the latest version.

Th.lauke@arcor.de: epindexer and site-wide configuration integrated, formatting adjusted

2020-10-22T13:07:52Z

epindexer and site-wide configuration integrated, formatting adjusted

Drn@ecs.soton.ac.uk: Added Manual

2017-09-08T12:49:59Z

Added Manual

Drn@ecs.soton.ac.uk at 13:36, 5 September 2017

2017-09-05T13:36:43Z

@@ Line 1: / Line 1: @@
 {{manual}}
 == Upgrade between same series versions of EPrints ==
 If you are upgrading between the same series versions of EPrints (e.g. 3.3.15 to 3.3.16 or 3.4.2 to 3.4.3)  then the upgrade process is somewhat more straightforward that upgrading between EPrints series versions (e.g. 3.3.16 to 3.4.3).  This page was originally written for upgrading between 3.3 series versions,  '''[[Upgrading between EPrints 3.4 versions]]''' provides additional specific information about EPrints 3.4 series.

@@ Line 42: / Line 42: @@
 ==== Downloading and Unpacking 3.4 ====
 <ol>
-<li> Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/2789/1/eprints-3.4.5.tar.gz)</li>
+<li> Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz)</li>
-<li> Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/2789/2/eprints-3.4.5-flavours.tar.gz)</li>
+<li> Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz)</li>
 <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>
   cd /opt
-  tar -xzvf /home/eprints/eprints-3.4.5.tar.gz
+  tar -xzvf /home/eprints/eprints-3.4.6.tar.gz
-  tar -xzvf /home/eprints/eprints-3.4.5-flavours.tar.gz
+  tar -xzvf /home/eprints/eprints-3.4.6-flavours.tar.gz
-  mv eprints-3.4.5 eprints3_new
+  mv eprints-3.4.6 eprints3_new
   chown -R eprints:eprints /opt/eprints3_new
 </ol>
 ==== Installing and Configuring ====

@@ Line 2: / Line 2: @@
 == Upgrade between same series versions of EPrints ==
-If you are upgrading between the same series versions of EPrints (e.g. 3.3.15 to 3.3.16 or 3.4.2 to 3.4.3)  then the upgrade process is somehwat more straightforward that upgrading between EPrints series versions (e.g. 3.3.16 to 3.4.3).  This page was originally written for upgrading between 3.3 series versions,  '''[[Upgrading between EPrints 3.4 versions]]''' provides additional specific information about EPrints 3.4 series.
+If you are upgrading between the same series versions of EPrints (e.g. 3.3.15 to 3.3.16 or 3.4.2 to 3.4.3)  then the upgrade process is somewhat more straightforward that upgrading between EPrints series versions (e.g. 3.3.16 to 3.4.3).  This page was originally written for upgrading between 3.3 series versions,  '''[[Upgrading between EPrints 3.4 versions]]''' provides additional specific information about EPrints 3.4 series.
 === 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.
-Once the package upgrade has completed make sure to run both ''epadmin upgrade'' and ''epadmin_upgrade'' on all archives.  The package manager may only tell you need to run ''epadmin upgrade'' but ''epadmin update'' is also need to ensure newly added fields to data objects are also incorporated.
+Once the package upgrade has completed make sure to run both ''epadmin upgrade'' and ''epadmin update'' on all archives.  The package manager may only tell you need to run ''epadmin upgrade'' but ''epadmin update'' is also needed to ensure newly added fields to data objects are also incorporated.
   /opt/eprints3/bin/epadmin upgrade ARCHIVEID
   /opt/eprints3/bin/epadmin update ARCHIVEID
@@ Line 19: / Line 19: @@
 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.
-Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both ''epadmin upgrade'' and ''epadmin_upgrade'' on all archives and then reload the webserver and EPrints indexer, e.g.
+Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both ''epadmin upgrade'' and ''epadmin update'' on all archives and then reload the webserver and EPrints indexer, e.g.
   /opt/eprints3/bin/epadmin upgrade ARCHIVEID
   /opt/eprints3/bin/epadmin update ARCHIVEID
@@ Line 42: / Line 42: @@
 ==== Downloading and Unpacking 3.4 ====
 <ol>
-<li> Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/2551/7/eprints-3.4.3.tar.gz)</li>
+<li> Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/2789/1/eprints-3.4.5.tar.gz)</li>
-<li> Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/2551/8/eprints-3.4.3-flavours.tar.gz)</li>
+<li> Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/2789/2/eprints-3.4.5-flavours.tar.gz)</li>
 <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>
   cd /opt
-  tar -xzvf /home/eprints/eprints-3.4.3.tar.gz
+  tar -xzvf /home/eprints/eprints-3.4.5.tar.gz
-  tar -xzvf /home/eprints/eprints-3.4.3-flavours.tar.gz
+  tar -xzvf /home/eprints/eprints-3.4.5-flavours.tar.gz
-  mv eprints-3.4.3 eprints3_new
+  mv eprints-3.4.5 eprints3_new
   chown -R eprints:eprints /opt/eprints3_new

@@ Line 8: / Line 8: @@
 Once the package upgrade has completed make sure to run both ''epadmin upgrade'' and ''epadmin_upgrade'' on all archives.  The package manager may only tell you need to run ''epadmin upgrade'' but ''epadmin update'' is also need to ensure newly added fields to data objects are also incorporated.
-  /opt/eprints3/bin/epadmin upgrade ARCHIVE_NAME
+  /opt/eprints3/bin/epadmin upgrade ARCHIVEID
-  /opt/eprints3/bin/epadmin update ARCHIVE_NAME
+  /opt/eprints3/bin/epadmin update ARCHIVEID
 === From GitHub ===
@@ Line 20: / Line 20: @@
 Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both ''epadmin upgrade'' and ''epadmin_upgrade'' on all archives and then reload the webserver and EPrints indexer, e.g.
-  /opt/eprints3/bin/epadmin upgrade ARCHIVE_NAME
+  /opt/eprints3/bin/epadmin upgrade ARCHIVEID
-  /opt/eprints3/bin/epadmin update ARCHIVE_NAME
+  /opt/eprints3/bin/epadmin update ARCHIVEID
   apachectl graceful
   /opt/eprints3/bin indexer restart
@@ Line 87: / Line 87: @@
 <li> Run ''epadmin upgrade'' and ''epadmin update'' to deploy any structural changes or addition of fields to the database, e.g.</li>
-  /opt/eprints3/bin/epadmin upgrade ARCHIVE_NAME
+  /opt/eprints3/bin/epadmin upgrade ARCHIVEID
-  /opt/eprints3/bin/epadmin update ARCHIVE_NAME
+  /opt/eprints3/bin/epadmin update ARCHIVEID
 <li> Restart EPrints' indexer.</li>

@@ Line 7: / Line 7: @@
 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.
-Once the package upgrade has completed make sure to run both ''epadmin upgrade'' and ''epadmin_upgrade'' on all archives and then reload the webserver and EPrints indexer, e.g.
+Once the package upgrade has completed make sure to run both ''epadmin upgrade'' and ''epadmin_upgrade'' on all archives.  The package manager may only tell you need to run ''epadmin upgrade'' but ''epadmin update'' is also need to ensure newly added fields to data objects are also incorporated.
   /opt/eprints3/bin/epadmin upgrade ARCHIVE_NAME
   /opt/eprints3/bin/epadmin update ARCHIVE_NAME
 === From GitHub ===

@@ Line 1: / Line 1: @@
 {{manual}}
-== Upgrade from 3.3.x to 3.3.y ==
+== Upgrade between same series versions of EPrints ==
 === 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:
+If you have installed with GitHub, the preferred method for production repositories, you can update to the latest version using the following commands, substituting ''y'' for the version you want and ''x'' for the 3 or 4 depending on whether you are upgrading between EPrints 3.3 or 3.4 series:
   git fetch origin
-  git merge tags/v3.3.y
+  git merge tags/v3.x.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):
 <ol>
 <li> Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)</li>
@@ Line 26: / Line 41: @@
   chown -R eprints:eprints /opt/eprints3_new
 <li> As the root user, stop Apache and EPrints' indexer.</li>
@@ Line 53: / Line 86: @@
   /opt/eprints3/bin/epadmin test
 <li> Restart EPrints' indexer.</li>
@@ Line 69: / Line 107: @@
 * [[Upgrading from 3.1]]
 * [[Upgrading from 3.2]]

@@ Line 7: / Line 7: @@
 === 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 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 ===
 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):
-. 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>
-. 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.15.tar.gz /opt/eprints3_new
+<li> As the root user, stop Apache and EPrints' indexer.</li>
-  chown -R eprints:eprints /opt/eprints3_new
-. 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/
-. 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/
-. 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
-. 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_new /opt/eprints3
-. 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
-. As the root user, restart Apache.
+<li> Restart EPrints' indexer.</li>
   apachectl restart
 == Upgrading to EPrints to 3.3 ==

← Older revision		Revision as of 12:49, 8 September 2017
Line 1:		Line 1:
		+	{{manual}}
		+
	== Upgrade from 3.3.x to 3.3.y ==		== Upgrade from 3.3.x to 3.3.y ==