Upgrading - Revision history

Ap1e26 at 13:05, 13 October 2026

2026-10-13T13:05:07Z

← Older revision		Revision as of 13:05, 13 October 2026
Line 1:		Line 1:
	[[Category:Upgrading]]		[[Category:Upgrading]]
			{{manual}}
	This page is intended to provide guidance for those upgrading between versions of EPrints 3.4. (e.g. 3.4.1 to 3.4.2). This is generally intended for those upgrading using a tagged release from [https://github.com/eprints/eprints3.4/ EPrints 3.4 GitHub repository] or upgrading using source tarballs available on [https://files.eprints.org/ files.eprints.org]. However, '''new versions of EPrints 3.4 will no longer be released as Linux packages''' (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).		This page is intended to provide guidance for those upgrading between versions of EPrints 3.4. (e.g. 3.4.1 to 3.4.2). This is generally intended for those upgrading using a tagged release from [https://github.com/eprints/eprints3.4/ EPrints 3.4 GitHub repository] or upgrading using source tarballs available on [https://files.eprints.org/ files.eprints.org]. However, '''new versions of EPrints 3.4 will no longer be released as Linux packages''' (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).

Ap1e26: /* From a source tarball */

2026-10-13T13:04:19Z

From a source tarball

← Older revision		Revision as of 13:04, 13 October 2026
Line 112:		Line 112:
	/opt/eprints3/bin/indexer start		/opt/eprints3/bin/indexer start

	== From a source tarball ==		= From a source tarball =
	1. Download the source tarball for both your current version of EPrints (e.g. 3.4.1) and your intended new version (e.g. 3.4.3) from [https://files.eprints.org/ files.eprints.org] and unpack into a separate directory on your EPrints repository server. E.g.		1. Download the source tarball for both your current version of EPrints (e.g. 3.4.1) and your intended new version (e.g. 3.4.3) from [https://files.eprints.org/ files.eprints.org] and unpack into a separate directory on your EPrints repository server. E.g.
	tar -xzvf eprints-3.4.1.tar.gz /home/eprints/		tar -xzvf eprints-3.4.1.tar.gz /home/eprints/

Ap1e26: /* From GitHub release */

2026-10-13T13:04:06Z

From GitHub release

← Older revision		Revision as of 13:04, 13 October 2026
Line 20:		Line 20:
	It would be expected that you have scheduled downtime (at least a day) and ideally try out the upgrade schedule on a cloned instance of your EPrints repository. If you tested the upgrade schedule on a clone, actual downtime (or more accurately at-risk period) will probably be less than an hour.		It would be expected that you have scheduled downtime (at least a day) and ideally try out the upgrade schedule on a cloned instance of your EPrints repository. If you tested the upgrade schedule on a clone, actual downtime (or more accurately at-risk period) will probably be less than an hour.

	== From GitHub release ==		= From GitHub release =
	'''N.B. These instructions are a work in progress.'''		'''N.B. These instructions are a work in progress.'''

Line 37:		Line 37:


	=== In-place Upgrade ===		== In-place Upgrade ==
	All steps should be done as the eprints users, although some commands may prompt for a root password.		All steps should be done as the eprints users, although some commands may prompt for a root password.

Line 67:		Line 67:
	/opt/eprints3/bin/indexer start		/opt/eprints3/bin/indexer start

	=== Clean Upgrade ===		== Clean Upgrade ==
	Step 1 needs to be done as the root. Steps 2 and onwards should be done as the eprints users, although some commands may prompt for a root password.		Step 1 needs to be done as the root. Steps 2 and onwards should be done as the eprints users, although some commands may prompt for a root password.

Ap1e26 at 13:02, 13 October 2026

2026-10-13T13:02:14Z

Show changes

Ap1e26: /* Upgrade between same series versions of EPrints */

2026-10-12T09:27:25Z

Upgrade between same series versions of EPrints

← Older revision		Revision as of 09:27, 12 October 2026
Line 3:		Line 3:
	== Upgrade between same series versions of EPrints ==		== 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.		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.
			[[Upgrading between EPrints 3.3 Versions]]

	=== From a Linux Package Manager ===		=== From a Linux Package Manager ===

Ap1e26: /* Upgrading to EPrints to 3.3 */

2026-10-12T09:21:23Z

Upgrading to EPrints to 3.3

← Older revision		Revision as of 09:21, 12 October 2026
Line 102:		Line 102:
	</ol>		</ol>

	== Upgrading to EPrints to 3.3 ==		== Upgrading to EPrints 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:		Upgrading from older 3.1 and 3.2 versions of EPrints to 3.3 is somewhat more involved. Please see the following guides:
	* [[Upgrading from 3.1]]		* [[Upgrading from 3.1]]

Th.lauke@arcor.de: category added

2025-02-25T12:56:49Z

category added

← Older revision		Revision as of 12:56, 25 February 2025
Line 1:		Line 1:
			[[Category:Upgrading]]
	{{manual}}		{{manual}}

	== Upgrade between same series versions of EPrints ==		== 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.		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.

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

2024-11-01T13:19:18Z

URL/version upgrade

← Older revision		Revision as of 13:19, 1 November 2024
Line 42:		Line 42:
	==== Downloading and Unpacking 3.4 ====		==== Downloading and Unpacking 3.4 ====
	<ol>		<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>		<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		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		chown -R eprints:eprints /opt/eprints3_new

	</ol>		</ol>

	==== Installing and Configuring ====		==== Installing and Configuring ====

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

← Older revision		Revision as of 00:33, 6 March 2022
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.		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 ===		=== 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.		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		apachectl graceful
	/opt/eprints3/bin indexer restart		/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>		<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>		<li> Restart EPrints' indexer.</li>

← Older revision		Revision as of 15:50, 8 May 2024
Line 2:		Line 2:

	== Upgrade between same series versions of EPrints ==		== 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 ===		=== 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.		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 upgrade ARCHIVEID
	/opt/eprints3/bin/epadmin update 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.		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 upgrade ARCHIVEID
	/opt/eprints3/bin/epadmin update ARCHIVEID		/opt/eprints3/bin/epadmin update ARCHIVEID
Line 42:		Line 42:
	==== Downloading and Unpacking 3.4 ====		==== Downloading and Unpacking 3.4 ====
	<ol>		<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>		<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		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		chown -R eprints:eprints /opt/eprints3_new