Editing Upgrading (section)

= 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.
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/

2. Compare the code to see if any critical changes have been made to the core codebase:
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v "/\(ingredients\|var\)"
Depending on your level of customization you should also pay attention to the results of
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/
or the equivalent command for the other flavours, or for a Zero EPrints repository
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero
and even
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ 
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ 
One of the first two directories was used for the initial configuration of your archive, and the latters control your repository by default; each of them could be overridden by your customized versions ...
Decide whether any personal version is still necessary, or meanwhile obsolete!

3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc
If the files in <Code>/opt/eprints3/</Code> are the same as that in the latest version (e.g. <Code>/home/eprints-3.4.3/</Code>) then no change is required.  If some are not present in the latest version you need to consider whether they can/should be copied across (e.g. into <Code>/home/eprints/eprints-3.4.3/flavours/pub_lib/inc</Code>). It is likely new ingredients will be added to a flavours inc file between versions, so this file is particular important to check so your repository's local modifications to this file and modifications in the latest version of EPrints can be reconciled.

4. If your repository has any Bazaar plug-ins installed go to the Eprints Bazaar page on your repository via the Admin menu and download each one individually from the ''Developer Tools'' tab.

5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:
 systemctl stop httpd
 ps aux | grep httpd
 /opt/eprints3/bin/indexer stop
 ps aux | grep indexer
''httpd'' is for RHEL-based Linux OS, for Debian-based Linux OS use ''apache2''.

6. As root, move the new version of EPrints (with any ported changes, from step 3) to <Code>/opt/eprints3-new</code>
 mv /home/eprints-3.4.3 /opt/eprints3-new

7. As the eprints user move the contents of the current archives into the new directory:
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/
If <Code>/opt/eprints3/archives</Code> or any of its archives are on a different disk partition, this may take a long time and the partition you are moving it to may not be big enough.  It may be better to figure out an alternative way of updating the other EPrints directories without moving the archive between disk partitions and then switching round the eprints directories (step 9 below).

8. As the eprints user copy across ingredients ('''except''' the bazaar and jquery ingredient) to the new version:
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/

9. As root, switch round the old and new eprints directories:
 mv /opt/eprints3 /opt/eprints3-old
 mv /opt/eprints3-new /opt/eprints3

10. As the eprints user, test EPrints is in a good state:
 /opt/eprints3/bin/epadmin test
If you have various Bazaar plug-ins installed, it is likely that this will report issues.  If so you will need to disable these files until you can re-install the Bazaar plug-ins. E.g.
 cd /opt/eprints3/archives/<ARCHIVE_NAME>/cfg/cfg.d/
 rm ../epm/*
 mv z_orcid_support.pl z_orcid_support.pl.disabled
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled
 mv z_meprints.pl z_meprints.pl.disabled 
 mv kultur.pl kultur.pl.disabled

11. Assuming EPrints is (now) in a good state, regenerate EPrints' Apache configuration:
 /opt/eprints3/bin/generate_apacheconf --system --replace

12. As root, check the Apache configuration is sound and restart the webserver:
 apachectl configtest
 systemctl start httpd
For Debian-based LinuxOS use:
 apache2ctl configtest
 systemctl start apache2

13. Load up your repository in a web browser, login and go to the EPrints Bazaar page via the Admin menu.  Install all the Bazaar plug-ins you downloaded in step 4.  You can do this by scrolling to the bottom of the ''Available'' tab and using the ''Upload and Install'' section.  Once you have re-installed all the Bazaar plug-ins, you can move back all the files you disabled in step 10.  Then use ''epadmin'' to re-test and restart the webserver:
 /opt/eprints3/bin/epadmin test
 systemctl start httpd

14. Now using your web browser do a thorough test of both the functionality and the appearance/layout of your repository and make tweaks to your local archive configuration as necessary (e.g. modify the CSS).

13. Finally, as the eprints user, restart the indexer.
 /opt/eprints3/bin/indexer start

It is advised that you keep the <Code>/opt/eprints3-old</Code> directory for a while (at least a month) in case you spot any unexpected problems.  Worse case scenario you can revert back to this version by doing steps 7 and 9 in reverse.  However, typically it is useful as a reference if you forgot to port a bespoke core code change of your old version of EPrints or a change you did port does not work as expected.