Upgrading 3.3.12+ to 3.4 - Revision history

Libjlrs: /* Notes */

2025-02-11T12:59:58Z

Notes

← Older revision		Revision as of 12:59, 11 February 2025
Line 94:		Line 94:

	==Notes==		==Notes==
			* EPrints 3.4.4+ now uses LONGTEXT instead of VARCHAR(255) for the <code>requester_user_agent</code> column. Upgrading from v3.3 '''will not''' automatically update this column definition in the database. Manually altering the column is an option, but may take a long time as the access table can contain millions of rows. See: https://github.com/eprints/eprints3.4/issues/427
	* 3.4 does not automatically update an archive's <code>html/en/</code> files. If there are any bugs with broken JavaScript or unexpected CSS, try deleting the archives <code>html/en/javascript/auto.js</code> or <code>html/en/style/auto.css</code>. Similarly if a static page cannot be changed try deleting it under the archive's <code>html/en/</code> or running <code>generate_static</code>.		* 3.4 does not automatically update an archive's <code>html/en/</code> files. If there are any bugs with broken JavaScript or unexpected CSS, try deleting the archives <code>html/en/javascript/auto.js</code> or <code>html/en/style/auto.css</code>. Similarly if a static page cannot be changed try deleting it under the archive's <code>html/en/</code> or running <code>generate_static</code>.
	* If some Perl modules are giving out error messages like:		* If some Perl modules are giving out error messages like:

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

2024-11-01T13:14:54Z

URL/version upgrade

← Older revision		Revision as of 13:14, 1 November 2024
Line 22:		Line 22:

	* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with		* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with
	wget https://files.eprints.org/~~2789~~/1/eprints-3.4.5.tar.gz		wget https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz
	wget https://files.eprints.org/~~2789~~/2/eprints-3.4.5-flavours.tar.gz		wget https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz
	'''as root'''		'''as root'''
	cd /root		cd /root
	tar xvzf eprints-3.4.5.tar.gz		tar xvzf eprints-3.4.6.tar.gz
	tar xvzf eprints-3.4.5-flavours.tar.gz		tar xvzf eprints-3.4.6-flavours.tar.gz

	* Have a look to <code>/root/eprints-3.4.5/INSTALL</code> for some local adaption options.		* Have a look to <code>/root/eprints-3.4.6/INSTALL</code> for some local adaption options.
	'''as root'''		'''as root'''
	cd eprints-3.4.5		cd eprints-3.4.6
	./configure		./configure
	make install		make install

Drn@ecs.soton.ac.uk at 09:51, 22 November 2023

2023-11-22T09:51:03Z

← Older revision		Revision as of 09:51, 22 November 2023
Line 13:		Line 13:

	==Process==		==Process==

	We will move your existing eprints 3.3.16+ installation from <code>/opt/eprints3/</code> to <code>/opt/eprints3.3</code>, install eprints 3.4, then migrate your configurations into EPrints 3.4; cf. [https://wiki.eprints.org/w/Category:Installation Category Installation]		We will move your existing eprints 3.3.16+ installation from <code>/opt/eprints3/</code> to <code>/opt/eprints3.3</code>, install eprints 3.4, then migrate your configurations into EPrints 3.4; cf. [https://wiki.eprints.org/w/Category:Installation Category Installation]
	<br>		<br>

Drn@ecs.soton.ac.uk: Upped to 3.4.5 plus fixed some typos

2023-11-22T09:00:43Z

Upped to 3.4.5 plus fixed some typos

← Older revision		Revision as of 09:00, 22 November 2023
Line 23:		Line 23:

	* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with		* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with
	wget https://files.eprints.org/~~2551~~/7/eprints-3.4.3.tar.gz		wget https://files.eprints.org/2789/1/eprints-3.4.5.tar.gz
	wget https://files.eprints.org/~~2551~~/8/eprints-3.4.3-flavours.tar.gz		wget https://files.eprints.org/2789/2/eprints-3.4.5-flavours.tar.gz
	'''as root'''		'''as root'''
	cd /root		cd /root
	tar xvzf eprints-3.4.3.tar.gz		tar xvzf eprints-3.4.5.tar.gz
	tar xvzf eprints-3.4.3-flavours.tar.gz		tar xvzf eprints-3.4.5-flavours.tar.gz

	* Have a look to <code>/root/eprints-3.4.3/INSTALL</code> for some local adaption options.		* Have a look to <code>/root/eprints-3.4.5/INSTALL</code> for some local adaption options.
	'''as root'''		'''as root'''
	cd eprints-3.4.3		cd eprints-3.4.5
	./configure		./configure
	make install		make install
Line 95:		Line 95:

	==Notes==		==Notes==
	* 3.4 does not automatically update an archive's <code>html/en/</code> files. If there are any bugs with broken ~~Javascript~~ or unexpected CSS, try deleting the archives <code>html/en/javascript/auto.js</code> or <code>html/en/style/auto.css</code>. Similarly if a static page cannot be changed try deleting it under the archive's <code>html/en/</code> or running <code>generate_static</code>.		* 3.4 does not automatically update an archive's <code>html/en/</code> files. If there are any bugs with broken JavaScript or unexpected CSS, try deleting the archives <code>html/en/javascript/auto.js</code> or <code>html/en/style/auto.css</code>. Similarly if a static page cannot be changed try deleting it under the archive's <code>html/en/</code> or running <code>generate_static</code>.
	* If some ~~perl~~ modules are giving out error messages like:		* If some Perl modules are giving out error messages like:
	Can't locate object method "new" via package "EPrints::Plugin::Event::PIRUS" at /opt/eprints3/bin/../perl_lib/EPrints/PluginFactory.pm line 276.		Can't locate object method "new" via package "EPrints::Plugin::Event::PIRUS" at /opt/eprints3/bin/../perl_lib/EPrints/PluginFactory.pm line 276.
	Can't locate object method "new" via package "EPrints::Plugin::Screen::EPrint::Box::Tools::SUPER" at /opt/eprints3/site_lib/plugins/EPrints/Plugin/Screen/EPrint/Box/Tools.pm line 12.		Can't locate object method "new" via package "EPrints::Plugin::Screen::EPrint::Box::Tools::SUPER" at /opt/eprints3/site_lib/plugins/EPrints/Plugin/Screen/EPrint/Box/Tools.pm line 12.

Alan.stiles@open.ac.uk: /* Pre-upgrade */ clarified epm download source.

2023-09-14T14:22:49Z

Pre-upgrade: clarified epm download source.

← Older revision		Revision as of 14:22, 14 September 2023
Line 9:		Line 9:
	* If you use Twitter integration, use CPAN to install LWP::Authen::OAuth as this is no longer in perl_lib. To do so, as root run:		* If you use Twitter integration, use CPAN to install LWP::Authen::OAuth as this is no longer in perl_lib. To do so, as root run:
	cpan LWP::Authen::OAuth		cpan LWP::Authen::OAuth
	* Download each of the Bazaar plugins you have installed as EPM files.		* Download each of the Bazaar plugins you have installed as EPM files from your existing repository.
	* Make a backup of your local configurations.		* Make a backup of your local configurations.

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

2022-03-06T00:34:47Z

← Older revision		Revision as of 00:34, 6 March 2022
Line 92:		Line 92:

	* Finally, run <code>generate_static</code> to make sure all pages are regenerated with any changes to configuration.		* Finally, run <code>generate_static</code> to make sure all pages are regenerated with any changes to configuration.
	/opt/eprints3/bin/generate_static ~~ARCHIVE_NAME~~		/opt/eprints3/bin/generate_static ARCHIVEID

	==Notes==		==Notes==

Drn@ecs.soton.ac.uk: Updated instructions to 3.4.3

2021-04-22T07:36:05Z

Updated instructions to 3.4.3

← Older revision		Revision as of 07:36, 22 April 2021
Line 23:		Line 23:

	* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with		* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with
	wget https://files.eprints.org/~~2401~~/7/eprints-3.4.2.tar.gz		wget https://files.eprints.org/2551/7/eprints-3.4.3.tar.gz
	wget https://files.eprints.org/~~2401~~/8/eprints-3.4.2-flavours.tar.gz		wget https://files.eprints.org/2551/8/eprints-3.4.3-flavours.tar.gz
	'''as root'''		'''as root'''
	cd /root		cd /root
	tar xvzf eprints-3.4.2.tar.gz		tar xvzf eprints-3.4.3.tar.gz
	tar xvzf eprints-3.4.2-flavours.tar.gz		tar xvzf eprints-3.4.3-flavours.tar.gz

	* Have a look to <code>/root/eprints-3.4.2/INSTALL</code> for some local adaption options.		* Have a look to <code>/root/eprints-3.4.3/INSTALL</code> for some local adaption options.
	'''as root'''		'''as root'''
	cd eprints-3.4.2		cd eprints-3.4.3
	./configure		./configure
	make install		make install

Drn@ecs.soton.ac.uk: Updated 3.4.1 references to 3.4.2

2020-10-19T14:29:54Z

Updated 3.4.1 references to 3.4.2

← Older revision		Revision as of 14:29, 19 October 2020
Line 23:		Line 23:

	* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with		* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with
	wget https://files.eprints.org/2401/7/eprints-3.4.1.tar.gz		wget https://files.eprints.org/2401/7/eprints-3.4.2.tar.gz
	wget https://files.eprints.org/2401/8/eprints-3.4.1-flavours.tar.gz		wget https://files.eprints.org/2401/8/eprints-3.4.2-flavours.tar.gz
	'''as root'''		'''as root'''
	cd /root		cd /root
	tar xvzf eprints-3.4.1.tar.gz		tar xvzf eprints-3.4.2.tar.gz
	tar xvzf eprints-3.4.1-flavours.tar.gz		tar xvzf eprints-3.4.2-flavours.tar.gz

	* Have a look to <code>/root/eprints-3.4.1/INSTALL</code> for some local adaption options.		* Have a look to <code>/root/eprints-3.4.2/INSTALL</code> for some local adaption options.
	'''as root'''		'''as root'''
	cd eprints-3.4.1		cd eprints-3.4.2
	./configure		./configure
	make install		make install

Th.lauke@arcor.de: version updated, splitting of eprint_fields.pl explained more detailed, some formatting modified

2019-08-07T14:42:13Z

version updated, splitting of eprint_fields.pl explained more detailed, some formatting modified

← Older revision		Revision as of 14:42, 7 August 2019
Line 1:		Line 1:
	These instructions help you upgrade EPrints 3.3.16+ (~~and~~ newer version of EPrints 3.3) to EPrints 3.4 while keeping all your eprints, documents and local configuration changes.		These instructions help you upgrade EPrints 3.3.16+ (or any newer version of EPrints 3.3) to EPrints 3.4 while keeping all your eprints, documents and local configuration changes.

	It assumes your EPrints 3.3.16+ was installed using a tarball (tar.gz) file and installed in <code>/opt/eprints3</code>. The commands in these instructions assume Centos 7 OS and run as the eprints user, unless it is stated to run as the root user.		It assumes your EPrints 3.3.16+ was installed using a tarball (tar.gz) file and installed in <code>/opt/eprints3</code>. The commands in these instructions assume Centos 7 OS and run as the eprints user, unless it is stated to run as the root user.
Line 14:		Line 14:
	==Process==		==Process==

	We will move your existing eprints 3.3.16+ installation from <code>/opt/eprints3/</code> to <code>/opt/eprints3.3</code>, install eprints 3.4, then migrate your configurations into EPrints 3.4; cf. https://wiki.eprints.org/w/Category:Installation		We will move your existing eprints 3.3.16+ installation from <code>/opt/eprints3/</code> to <code>/opt/eprints3.3</code>, install eprints 3.4, then migrate your configurations into EPrints 3.4; cf. [https://wiki.eprints.org/w/Category:Installation Category Installation]
	<br>		<br>
	'''as root'''		'''as root'''
Line 23:		Line 23:

	* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with		* Download EPrints 3.4 core and publication flavour tarball and install them from [http://files.eprints.org/ Files.eprints.org] with
	wget https://files.eprints.org/~~2305~~/4/eprints-3.4.0.tar.gz		wget https://files.eprints.org/2401/7/eprints-3.4.1.tar.gz
	wget https://files.eprints.org/~~2305~~/5/eprints-3.4.0-flavours.tar.gz		wget https://files.eprints.org/2401/8/eprints-3.4.1-flavours.tar.gz
	'''as root'''		'''as root'''
	cd /root		cd /root
	tar xvzf eprints-3.4.0.tar.gz		tar xvzf eprints-3.4.1.tar.gz
	tar xvzf eprints-3.4.0-flavours.tar.gz		tar xvzf eprints-3.4.1-flavours.tar.gz

	* Have a look to <code>/root/eprints-3.4.0/INSTALL</code> for some local adaption options.		* Have a look to <code>/root/eprints-3.4.1/INSTALL</code> for some local adaption options.
	'''as root'''		'''as root'''
	cd eprints-3.4.0		cd eprints-3.4.1
	./configure		./configure
	make install		make install
Line 51:		Line 51:
	ln -s default.xml default_internal.xml		ln -s default.xml default_internal.xml

	* Audit each of their local config files against the pub_lib flavours config files~~.<br>~~ The first <code>diff</code> below will identify all the files that are the same. If so, delete the ones in <code>archives/ARCHIVENAME/cfg/cfg.d/</code>. You almost certainly should not find any, as the files in <code>flavours/pub_lib/cfg.d</code> will at very least have updated copyright/licensing boilerplate. ~~<br>~~The second <code>diff</code> will find where files exists in both directory are different. Here they should be compared to see, if the local differences are superficial (e.g. slightly different comments or spacing) and therefore can be removed. Also the pub_lib flavour version may fix an outstanding bug or perform the required functionality more succinctly. If this is the only change, then the local archive version can be deleted, otherwise the change should be incorporated in the local version.		* Audit each of their local config files against the pub_lib flavours config files:
			#The first <code>diff</code> below will identify all the files that are the same. If so, delete the ones in <code>archives/ARCHIVENAME/cfg/cfg.d/</code>. You almost certainly should not find any, as the files in <code>flavours/pub_lib/cfg.d</code> will at very least have updated copyright/licensing boilerplate.
			#The second <code>diff</code> will find where files exists in both directory are different. Here they should be compared to see, if the local differences are superficial (e.g. slightly different comments or spacing) and therefore can be removed. Also the pub_lib flavour version may fix an outstanding bug or perform the required functionality more succinctly. If this is the only change, then the local archive version can be deleted, otherwise the change should be incorporated in the local version.
	cd /opt/eprints3/		cd /opt/eprints3/
	diff -rs archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ are identical$'		diff -rs archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ are identical$'
	diff -rq archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ differ$'		diff -rq archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ differ$'

	* Compare <code>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</code> with <code>flavours/pub_lib/cfg/cfg.d/eprint_fields_pub.pl</code> maybe with the help of [http://diffuse.sourceforge.net/download_de.html ''diffuse''] to overcome this business easier:		<ul><li>Compare <code>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</code> with <code>flavours/pub_lib/cfg/cfg.d/eprint_fields_pub.pl</code> maybe with the help of [http://diffuse.sourceforge.net/download_de.html ''diffuse''] to overcome this business easier:<ul>
	** If these are different and fields are present in <code>eprint_fields_pub.pl</code> and not <code>eprint_fields.pl</code> or the definitions (e.g. type, options, etc.) for the same field are different then:		<li>If these are different and fields are present in <code>eprint_fields_pub.pl</code> and not <code>eprint_fields.pl</code> or the definitions (e.g. type, options, etc.) for the same field are different then:<ol>
	**# Copy <code>flavours/pub_lib/cfg.d/eprint_fields_pub.pl</code> to their archive's <code>cfg/cfg.d/</code>		<li>Copy <code>flavours/pub_lib/cfg.d/eprint_fields_pub.pl</code> to their archive's <code>cfg/cfg.d/</code>.
	**# Modify the fields in their archive's <code>cfg/cfg.d/eprint_fields_pub.pl</code> where they have different definitions (e.g. type, options, etc.) to those in <code>eprint_fields.pl</code>		<li>Modify the fields in their archive's <code>cfg/cfg.d/eprint_fields_pub.pl</code> where they have different definitions (e.g. type, options, etc.) to those in <code>eprint_fields.pl</code>.
	**# Remove all fields in their archive's <code>cfg/cfg.d/eprint_fields.pl</code> where they also occur in their archive's <code>cfg/cfg.d/eprint_fields_pub.pl</code>		<li>Remove all fields in their archive's <code>cfg/cfg.d/eprint_fields.pl</code> where they also occur in their archive's <code>cfg/cfg.d/eprint_fields_pub.pl</code>, no matter if already transferred due to previous item or initially the same.</ol>
	** If there are only additional fields in <code>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</code> then just do the last step.		<li>If there are only additional fields in <code>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</code> then just do the last step.
	** If the two files are identical then you need to do nothing. However, this is extremly unlikely.		<li>If the two files are identical then you need to do nothing. However, this is extremly unlikely.
			</ul>
			Finally, the specification is still the same, but mostly split into two distinct files, which obey the known rule ''Local version overrides central one''.</ul>
	* Synchronise <code>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</code> with <code>ingredients/bazaar/cfg.d/epm.pl</code>, i.e. remove <code>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</code> in case of ''no'' local modifications.		* Synchronise <code>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</code> with <code>ingredients/bazaar/cfg.d/epm.pl</code>, i.e. remove <code>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</code> in case of ''no'' local modifications.

	* Ensure the following bazaar files are disabled by renaming to FILENAME.pl''.disabled''. Once they have been reinstalled via the Bazaar then they can be moved back into place. Using epadmin test is a good way of discovering which files need this doing, but below is a list of common files that should be temporarily moved, if they exist in your archive's <code>cfg/cfg.d/</code> directory:		* Ensure the following bazaar files are disabled by renaming to FILENAME.pl''.disabled''. Once they have been reinstalled via the Bazaar then they can be moved back into place. Using <code>epadmin test</code> is a good way of discovering which files need this doing, but below is a list of common files that should be temporarily moved, if they exist in your archive's <code>cfg/cfg.d/</code> directory:
	mv z_orcid_support.pl z_orcid_support.pl.disabled		mv z_orcid_support.pl z_orcid_support.pl.disabled
	mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled		mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled
Line 92:		Line 95:

	==Notes==		==Notes==
	* 3.4 does not automatically update an archive's <code>html/en/</code> files. If there are any bugs with broken Javascript or unexpected CSS, try deleting the archives <code>html/en/javascript/auto.js</code> or <code>html/en/style/auto.css</code>. Similarly if a static page cannot be changed try deleting it under the archive's <code>html/en/</code> or running generate_static.		* 3.4 does not automatically update an archive's <code>html/en/</code> files. If there are any bugs with broken Javascript or unexpected CSS, try deleting the archives <code>html/en/javascript/auto.js</code> or <code>html/en/style/auto.css</code>. Similarly if a static page cannot be changed try deleting it under the archive's <code>html/en/</code> or running <code>generate_static</code>.
	* If some perl modules are giving out error ~~message~~ like:		* If some perl modules are giving out error messages like:
	Can't locate object method "new" via package "EPrints::Plugin::Event::PIRUS" at /opt/eprints3/bin/../perl_lib/EPrints/PluginFactory.pm line 276.		Can't locate object method "new" via package "EPrints::Plugin::Event::PIRUS" at /opt/eprints3/bin/../perl_lib/EPrints/PluginFactory.pm line 276.
	Can't locate object method "new" via package "EPrints::Plugin::Screen::EPrint::Box::Tools::SUPER" at /opt/eprints3/site_lib/plugins/EPrints/Plugin/Screen/EPrint/Box/Tools.pm line 12.		Can't locate object method "new" via package "EPrints::Plugin::Screen::EPrint::Box::Tools::SUPER" at /opt/eprints3/site_lib/plugins/EPrints/Plugin/Screen/EPrint/Box/Tools.pm line 12.
	It is because their parent module has not been initialised. This happens when the parent module lives in perl_lib, and the problem module live in elsewhere; e.g. parent module of PIRUS(Event.pm) is in perl_lib, while the PIRUS.pm is in pub_lib.		It is because their parent module has not been initialised. This happens when the parent module lives in perl_lib, and the problem module live in elsewhere; e.g. parent module of PIRUS(Event.pm) is in <code>./perl_lib</code>, while the <code>PIRUS.pm</code> is in <code>./pub_lib</code>.
	Just need to "use" the parent module before the ISA line:		Just need to <code>use</code> the parent module before the <code>ISA</code> line:
	use EPrints::Plugin::Event;		use EPrints::Plugin::Event;

	[[Category:Upgrading]]		[[Category:Upgrading]]

Th.lauke@arcor.de: formatting modified

2019-08-02T17:45:04Z

formatting modified

← Older revision		Revision as of 17:45, 2 August 2019
Line 1:		Line 1:
	These instructions help you upgrade EPrints 3.3.12 (and newer version of EPrints 3.3) to EPrints 3.4 while keeping all your eprints, documents and local configuration changes.		These instructions help you upgrade EPrints 3.3.16+ (and newer version of EPrints 3.3) to EPrints 3.4 while keeping all your eprints, documents and local configuration changes.

	It assumes your EPrints 3.3.12+ was installed using a tarball (tar.gz) file and installed in /opt/eprints3. The commands in these instructions assume Centos 7 OS and run as the eprints user, unless it stated to run as the root user.		It assumes your EPrints 3.3.16+ was installed using a tarball (tar.gz) file and installed in <code>/opt/eprints3</code>. The commands in these instructions assume Centos 7 OS and run as the eprints user, unless it is stated to run as the root user.

	=Upgrade from Tarball=		=Upgrade from Tarball=
Line 14:		Line 14:
	==Process==		==Process==

	We will move your existing eprints 3.3.12+ installation from <tt>/opt/eprints3/</tt> to <tt>/opt/eprints3.3</tt>, install eprints 3.4, then migrate your configurations into EPrints 3.4.		We will move your existing eprints 3.3.16+ installation from <code>/opt/eprints3/</code> to <code>/opt/eprints3.3</code>, install eprints 3.4, then migrate your configurations into EPrints 3.4; cf. https://wiki.eprints.org/w/Category:Installation
	<br>		<br>
	'''as root'''		'''as root'''
Line 30:		Line 30:
	tar xvzf eprints-3.4.0-flavours.tar.gz		tar xvzf eprints-3.4.0-flavours.tar.gz

	* Have a look to <tt>/root/eprints-3.4.0/INSTALL</tt> for some local adaption options.		* Have a look to <code>/root/eprints-3.4.0/INSTALL</code> for some local adaption options.
	'''as root'''		'''as root'''
	cd eprints-3.4.0		cd eprints-3.4.0
Line 40:		Line 40:
	cd /opt		cd /opt
	mv eprints3.3/archives/ARCHIVENAME eprints3/archives/		mv eprints3.3/archives/ARCHIVENAME eprints3/archives/
	* After moving, make sure all files inside <tt>/opt/eprints3</tt> are still owned by eprints user and belongs to eprints group, thus		* After moving, make sure all files inside <code>/opt/eprints3</code> are still owned by eprints user and belongs to eprints group, thus
	'''as root'''		'''as root'''
	chown -R eprints:eprints /opt/eprints3		chown -R eprints:eprints /opt/eprints3

	* Create <tt>/opt/eprints3/archives/ARCHIVENAME/cfg/cfg.d/00_flavour.pl</tt> to set the appropriate flavour, typically 'pub', i.e.		* Create <code>/opt/eprints3/archives/ARCHIVENAME/cfg/cfg.d/00_flavour.pl</code> to set the appropriate flavour, typically 'pub', i.e.
	echo "\$c->{flavour} = 'pub';" > /opt/eprints3/archives/ARCHIVENAME/cfg/cfg.d/00_flavour.pl		echo "\$c->{flavour} = 'pub';" > /opt/eprints3/archives/ARCHIVENAME/cfg/cfg.d/00_flavour.pl

Line 51:		Line 51:
	ln -s default.xml default_internal.xml		ln -s default.xml default_internal.xml

	* Audit each of their local config files against the pub_lib flavours config files.<br> The first <tt>diff</tt> below will identify all the files that are the same. If so, delete the ones in <tt>archives/ARCHIVENAME/cfg/cfg.d/</tt>. You almost certainly should not find any, as the files in <tt>flavours/pub_lib/cfg.d</tt> will at very least have updated copyright/licensing boilerplate. <br>The second <tt>diff</tt> will find where files exists in both directory are different. Here they should be compared to see, if the local differences are superficial (e.g. slightly different comments or spacing) and therefore can be removed. Also the pub_lib flavour version may fix an outstanding bug or perform the required functionality more succinctly. If this is the only change, then the local archive version can be deleted, otherwise the change should be incorporated in the local version.		* Audit each of their local config files against the pub_lib flavours config files.<br> The first <code>diff</code> below will identify all the files that are the same. If so, delete the ones in <code>archives/ARCHIVENAME/cfg/cfg.d/</code>. You almost certainly should not find any, as the files in <code>flavours/pub_lib/cfg.d</code> will at very least have updated copyright/licensing boilerplate. <br>The second <code>diff</code> will find where files exists in both directory are different. Here they should be compared to see, if the local differences are superficial (e.g. slightly different comments or spacing) and therefore can be removed. Also the pub_lib flavour version may fix an outstanding bug or perform the required functionality more succinctly. If this is the only change, then the local archive version can be deleted, otherwise the change should be incorporated in the local version.
	cd /opt/eprints3/		cd /opt/eprints3/
	diff -rs archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ are identical$'		diff -rs archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ are identical$'
	diff -rq archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ differ$'		diff -rq archives/ARCHIVENAME/cfg/cfg.d flavours/pub_lib/cfg.d \| egrep '^Files .+ and .+ differ$'

	* Compare <tt>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</tt> with <tt>flavours/pub_lib/cfg/cfg.d/eprint_fields_pub.pl</tt> maybe with the help of [http://diffuse.sourceforge.net/download_de.html ''diffuse''] to overcome this business easier:		* Compare <code>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</code> with <code>flavours/pub_lib/cfg/cfg.d/eprint_fields_pub.pl</code> maybe with the help of [http://diffuse.sourceforge.net/download_de.html ''diffuse''] to overcome this business easier:
	** If these are different and fields are present in <tt>eprint_fields_pub.pl</tt> and not <tt>eprint_fields.pl</tt> or the definitions (e.g. type, options, etc.) for the same field are different then:		** If these are different and fields are present in <code>eprint_fields_pub.pl</code> and not <code>eprint_fields.pl</code> or the definitions (e.g. type, options, etc.) for the same field are different then:
	**# Copy <tt>flavours/pub_lib/cfg.d/eprint_fields_pub.pl</tt> to their archive's <tt>cfg/cfg.d/</tt>		**# Copy <code>flavours/pub_lib/cfg.d/eprint_fields_pub.pl</code> to their archive's <code>cfg/cfg.d/</code>
	**# Modify the fields in their archive's <tt>cfg/cfg.d/eprint_fields_pub.pl</tt> where they have different definitions (e.g. type, options, etc.) to those in <tt>eprint_fields.pl</tt>		**# Modify the fields in their archive's <code>cfg/cfg.d/eprint_fields_pub.pl</code> where they have different definitions (e.g. type, options, etc.) to those in <code>eprint_fields.pl</code>
	**# Remove all fields in their archive's <tt>cfg/cfg.d/eprint_fields.pl</tt> where they also occur in their archive's <tt>cfg/cfg.d/eprint_fields_pub.pl</tt>		**# Remove all fields in their archive's <code>cfg/cfg.d/eprint_fields.pl</code> where they also occur in their archive's <code>cfg/cfg.d/eprint_fields_pub.pl</code>
	** If there are only additional fields in <tt>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</tt> then just do the last step.		** If there are only additional fields in <code>archives/ARCHIVENAME/cfg/cfg.d/eprint_fields.pl</code> then just do the last step.
	** If the two files are identical then you need to do nothing. However, this is extremly unlikely.		** If the two files are identical then you need to do nothing. However, this is extremly unlikely.

	* Synchronise <tt>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</tt> with <tt>ingredients/bazaar/cfg.d/epm.pl</tt>, i.e. remove <tt>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</tt> in case of ''no'' local modifications.		* Synchronise <code>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</code> with <code>ingredients/bazaar/cfg.d/epm.pl</code>, i.e. remove <code>archives/ARCHIVENAME/cfg/cfg.d/epm.pl</code> in case of ''no'' local modifications.

	* Ensure the following bazaar files are disabled by renaming to FILENAME.pl''.disabled''. Once they have been reinstalled via the Bazaar then they can be moved back into place. Using epadmin test is a good way of discovering which files need this doing, but below is a list of common files that should be temporarily moved, if they exist in your archive's <tt>cfg/cfg.d/</tt> directory:		* Ensure the following bazaar files are disabled by renaming to FILENAME.pl''.disabled''. Once they have been reinstalled via the Bazaar then they can be moved back into place. Using epadmin test is a good way of discovering which files need this doing, but below is a list of common files that should be temporarily moved, if they exist in your archive's <code>cfg/cfg.d/</code> directory:
	mv z_orcid_support.pl z_orcid_support.pl.disabled		mv z_orcid_support.pl z_orcid_support.pl.disabled
	mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled		mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled
Line 72:		Line 72:
	mv z_meprints.pl z_meprints.pl.disabled		mv z_meprints.pl z_meprints.pl.disabled

	* As the eprints user, run <tt>epadmin update</tt> to add any new fields that were not previously present (typically this is embargo_reason for documents and requester_email for request)		* As the eprints user, run <code>epadmin update</code> to add any new fields that were not previously present (typically this is embargo_reason for documents and requester_email for request)
	/opt/eprints3/bin/epadmin update ARCHIVENAME		/opt/eprints3/bin/epadmin update ARCHIVENAME

Line 88:		Line 88:
	apachectl graceful		apachectl graceful

	* Finally, run <tt>generate_static</tt> to make sure all pages are regenerated with any changes to configuration.		* Finally, run <code>generate_static</code> to make sure all pages are regenerated with any changes to configuration.
	/opt/eprints3/bin/generate_static ARCHIVE_NAME		/opt/eprints3/bin/generate_static ARCHIVE_NAME

	==Notes==		==Notes==
	* 3.4 does not automatically update an archive's <tt>html/en/</tt> files. If there are any bugs with broken Javascript or unexpected CSS, try deleting the archives <tt>html/en/javascript/auto.js</tt> or <tt>html/en/style/auto.css</tt>. Similarly if a static page cannot be changed try deleting it under the archive's <tt>html/en/</tt> or running generate_static.		* 3.4 does not automatically update an archive's <code>html/en/</code> files. If there are any bugs with broken Javascript or unexpected CSS, try deleting the archives <code>html/en/javascript/auto.js</code> or <code>html/en/style/auto.css</code>. Similarly if a static page cannot be changed try deleting it under the archive's <code>html/en/</code> or running generate_static.
	* If some perl modules are giving out error message like:		* If some perl modules are giving out error message like:
	Can't locate object method "new" via package "EPrints::Plugin::Event::PIRUS" at /opt/eprints3/bin/../perl_lib/EPrints/PluginFactory.pm line 276.		Can't locate object method "new" via package "EPrints::Plugin::Event::PIRUS" at /opt/eprints3/bin/../perl_lib/EPrints/PluginFactory.pm line 276.