<?xml version="1.0"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-GB">
	<id>https://wiki.eprints.org/w/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Ap1e26</id>
	<title>EPrints Documentation - User contributions [en-gb]</title>
	<link rel="self" type="application/atom+xml" href="https://wiki.eprints.org/w/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Ap1e26"/>
	<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/Special:Contributions/Ap1e26"/>
	<updated>2026-11-22T19:04:58Z</updated>
	<subtitle>User contributions</subtitle>
	<generator>MediaWiki 1.43.11</generator>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Setting_up_email&amp;diff=17594</id>
		<title>Setting up email</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Setting_up_email&amp;diff=17594"/>
		<updated>2026-10-16T12:11:31Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Manual}}&lt;br /&gt;
There are two different ways of configuring EPrints to send email.  You can either edit EPrints configuration to set the SMTP server (handy for testing) or your can use Postfix or similar applications and set them up as a smarthost that can relay email via another SMTP server (our recommended solution).&lt;br /&gt;
&lt;br /&gt;
== Configuring Postfix as an Email Smarthost ==&lt;br /&gt;
Follow instructions on how to install Postfix and configure as a smarthost at https://www.cyberciti.biz/faq/how-to-configure-postfix-relayhost-smarthost-to-send-email-using-an-external-smptd/  There is no need to reload the webserver once you have finished, as nothing should have changed in the EPrints configuration.&lt;br /&gt;
&lt;br /&gt;
The advantage of installing Postfix as a smarthost is that you can check /var/log/maillog if there are problems with email being sent, which should make it easier to determine whether it is the EPrints server or the SMTP server that is causing the problem.&lt;br /&gt;
&lt;br /&gt;
== Configuring SMTP in EPrints ==&lt;br /&gt;
Edit EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm (e.g. /opt/eprints3/perl_lib/EPrints/SystemSettings.pm) and set a value for the &#039;&#039;&#039;smtp_server&#039;&#039;&#039; line:&lt;br /&gt;
&lt;br /&gt;
E.g.&lt;br /&gt;
 &#039;smtp_server&#039; =&amp;gt; &#039;smtp.foobar.ac.uk&#039;,&lt;br /&gt;
&lt;br /&gt;
Once changing this setting you will need to test EPrints configuration and reload the webserver:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin test&lt;br /&gt;
 apachectl graceful&lt;br /&gt;
If you are running Debian/Ubuntu Linux &#039;&#039;apache2ctl reload&#039;&#039; may be a better way to reload the webserver.&lt;br /&gt;
&lt;br /&gt;
The advantage of using this method is that it will not effect how mail is sent by any other applications on the server.  The disadvantage is it may be difficult to debug if users do not receive email as expected.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
[[Category:Configuration]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Setting_up_email&amp;diff=17593</id>
		<title>Setting up email</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Setting_up_email&amp;diff=17593"/>
		<updated>2026-10-16T12:10:47Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Manual}}&lt;br /&gt;
There are two different ways of configuring EPrints to send email.  You can either edit EPrints configuration to set the SMTP server or your can use Postfix or similar applications and set them up as a smarthost that can relay email via another SMTP server.&lt;br /&gt;
&lt;br /&gt;
== Configuring Postfix as an Email Smarthost ==&lt;br /&gt;
Follow instructions on how to install Postfix and configure as a smarthost at https://www.cyberciti.biz/faq/how-to-configure-postfix-relayhost-smarthost-to-send-email-using-an-external-smptd/  There is no need to reload the webserver once you have finished, as nothing should have changed in the EPrints configuration.&lt;br /&gt;
&lt;br /&gt;
The advantage of installing Postfix as a smarthost is that you can check /var/log/maillog if there are problems with email being sent, which should make it easier to determine whether it is the EPrints server or the SMTP server that is causing the problem.&lt;br /&gt;
&lt;br /&gt;
== Configuring SMTP in EPrints ==&lt;br /&gt;
Edit EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm (e.g. /opt/eprints3/perl_lib/EPrints/SystemSettings.pm) and set a value for the &#039;&#039;&#039;smtp_server&#039;&#039;&#039; line:&lt;br /&gt;
&lt;br /&gt;
E.g.&lt;br /&gt;
 &#039;smtp_server&#039; =&amp;gt; &#039;smtp.foobar.ac.uk&#039;,&lt;br /&gt;
&lt;br /&gt;
Once changing this setting you will need to test EPrints configuration and reload the webserver:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin test&lt;br /&gt;
 apachectl graceful&lt;br /&gt;
If you are running Debian/Ubuntu Linux &#039;&#039;apache2ctl reload&#039;&#039; may be a better way to reload the webserver.&lt;br /&gt;
&lt;br /&gt;
The advantage of using this method is that it will not effect how mail is sent by any other applications on the server.  The disadvantage is it may be difficult to debug if users do not receive email as expected.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
[[Category:Configuration]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Branding/Logos&amp;diff=17592</id>
		<title>Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Branding/Logos&amp;diff=17592"/>
		<updated>2026-10-16T12:08:24Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page Branding/Logos to Archive:Branding/Logos: This targets an old version, more in depth guide available&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Archive:Branding/Logos]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17591</id>
		<title>Archive:Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17591"/>
		<updated>2026-10-16T12:08:24Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page Branding/Logos to Archive:Branding/Logos: This targets an old version, more in depth guide available&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Template:Deprecated}}&lt;br /&gt;
{{manual}}&lt;br /&gt;
[[Category:Branding]]&lt;br /&gt;
There are several different types of page in the eprints WebsiteInterface and they are generated in different ways. See WebsiteInterface for an explanation.&lt;br /&gt;
&lt;br /&gt;
Every page on eprints is wrapped in the site template. This can be found at /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
==Changing the Template==&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
Make your changes. Be careful not to remove the &amp;lt;pin&amp;gt; elements as this is how eprints knows where to insert information. &lt;br /&gt;
&lt;br /&gt;
Note that this file is XML so all tags must be closed correctly.&lt;br /&gt;
&lt;br /&gt;
==Cause the new template to be applied==&lt;br /&gt;
&lt;br /&gt;
TIP: If you want to see the new template in situ without waiting to update all the webpages then run &amp;quot;generate_abstracts myid 66&amp;quot; (or some other existing abstract page) and see the change on that one page.&lt;br /&gt;
&lt;br /&gt;
This is slightly different for each part of the site...&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Static page | Static pages]] ===&lt;br /&gt;
run generate_static&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Abstract page | Abstract pages]]===&lt;br /&gt;
&lt;br /&gt;
run generate_abstracts&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#EPrint view page | View pages]] ===&lt;br /&gt;
&lt;br /&gt;
run generate_views&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Dynamic Pages | Dynamic pages]] ===&lt;br /&gt;
&lt;br /&gt;
run force_config_reload or resart the webserver&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Branding_with_confidence&amp;diff=17590</id>
		<title>Branding with confidence</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Branding_with_confidence&amp;diff=17590"/>
		<updated>2026-10-16T12:07:43Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Branding]]&lt;br /&gt;
{{manual}}&lt;br /&gt;
One of the most common EPrints customisations is to add your own institution&#039;s branding and &amp;quot;look and feel&amp;quot; to the interface - this may include logos, page layouts, stylesheets and colour schemes.&lt;br /&gt;
&lt;br /&gt;
It is generally advised that you have command line access to the server so you can add/edit these files for branding directly.  Alternatively you may have some means of mapping EPrints on a network drive so you can edit these files with a graphical text editor or your own computer.  It is possible to use the &#039;&#039;Config. Tools -&amp;gt; View Configuration&#039;&#039; section of the EPrints Admin web interface.  However, this is discouraged, as anything beyond minor changes runs the risk of breaking EPrints in a way where you can no longer access these &#039;&#039;View Configuration&#039;&#039; pages to revert the changes you have made.&lt;br /&gt;
&lt;br /&gt;
__TOC__&lt;br /&gt;
&lt;br /&gt;
==Branding fast track==&lt;br /&gt;
&lt;br /&gt;
This section describes techniques for very quickly changing the appearance of your EPrints repository. These techniques could be useful, for example, to quickly brand a demonstration repository so that your audience can identify with it.&lt;br /&gt;
&lt;br /&gt;
===Adding a logo===&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example 1&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
The simplest approach, (which will require command line access to the server, as this cannot be done safely through the &#039;&#039;Config. Tools -&amp;gt; View Configuration&#039;&#039; section of the EPrints Admin web interface), is to overwrite the default EPrints logo with a copy of your own logo. Copy your logo (e.g. using SCP or SFTP) to: &lt;br /&gt;
&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/cfg/static/images/sitelogo.png&lt;br /&gt;
&lt;br /&gt;
And refresh the web page. Your logo should now be displayed in place of the default EPrints logo.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example 2&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
The image that EPrints uses for the site logo is defined in the branding configuration file. You can change this setting to point to the logo image on your institution&#039;s Web page.&lt;br /&gt;
&lt;br /&gt;
Open the branding configuration file in a text editor (e.g. Vim or Nano) if you are editing it from the command line:&lt;br /&gt;
&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/cfg/cfg.d/branding.pl&lt;br /&gt;
&lt;br /&gt;
You can alternatively edit this file via the &#039;&#039;&#039;Config. Tools -&amp;gt; View Configuration&#039;&#039;&#039; section of the EPrints Admin web interface, under just:&lt;br /&gt;
&lt;br /&gt;
 cfg/cfg.d/branding.pl&lt;br /&gt;
&lt;br /&gt;
Find the site_logo configuration setting:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;perl&amp;quot;&amp;gt;&lt;br /&gt;
$c-&amp;gt;{site_logo} = &amp;quot;/images/sitelogo.png&amp;quot;;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Change the setting to point to your own logo image:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;perl&amp;quot;&amp;gt;&lt;br /&gt;
$c-&amp;gt;{site_logo} = &amp;quot;http://www.soton.ac.uk/img/furniture/royal/corp_logo.gif&amp;quot;;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Reload the EPrints configuration by typing:&lt;br /&gt;
&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin reload ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
If you are doing this via the EPrints Admin web interface click on the &#039;&#039;&#039;Reload Configuration&#039;&#039;&#039; button under the &#039;&#039;&#039;Config. Tools&#039;&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example 3&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
You can also adjust the &amp;lt;tt&amp;gt;site_logo&amp;lt;/tt&amp;gt; configuration setting to point any local image file using a text editor at the command line. Place a copy (e.g. using SCP of SFTP) of your logo image somewhere in the &amp;lt;tt&amp;gt;EPRINTS_PATH/archives/ARCHIVEID/cfg/static/images/&amp;lt;/tt&amp;gt; directory and then update the branding configuration file to point to it.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;perl&amp;quot;&amp;gt;&lt;br /&gt;
$c-&amp;gt;{site_logo} = &amp;quot;/images/mylogo.gif&amp;quot;;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Reload the EPrints configuration by typing:&lt;br /&gt;
&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin reload ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
===Changing the theme===&lt;br /&gt;
&lt;br /&gt;
Open the branding configuration file in a text editor:&lt;br /&gt;
(Note if this file does not exist, copy it from lib/cfg.d/branding.pl)&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/cfg.d/branding.pl&lt;br /&gt;
&lt;br /&gt;
Find the theme configuration setting:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;perl&amp;quot;&amp;gt;&lt;br /&gt;
# $c-&amp;gt;{theme} = &amp;quot;green&amp;quot;;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Change the setting to use the chosen theme.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;perl&amp;quot;&amp;gt;&lt;br /&gt;
$c-&amp;gt;{theme} = &amp;quot;green&amp;quot;;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;Currently EPrints 3 only includes the default and &amp;quot;green&amp;quot; theme, but look out for more themes in future versions of EPrints and on the http://files.eprints.org/ community repository.&lt;br /&gt;
&lt;br /&gt;
==Taking control==&lt;br /&gt;
&lt;br /&gt;
This section describes techniques for taking complete control of the appearance of your repository.&lt;br /&gt;
&lt;br /&gt;
===Changing the page layout===&lt;br /&gt;
&lt;br /&gt;
Every page in your repository is displayed using a single template. A custom layout can be applied to your repository pages by editing this template.&lt;br /&gt;
&lt;br /&gt;
Copy the default layout to your repository:&lt;br /&gt;
&lt;br /&gt;
 cp lib/templates/default.xml archives/ARCHIVEID/cfg/templates/default.xml&lt;br /&gt;
&lt;br /&gt;
Open the template file for your repository:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/templates/default.xml&lt;br /&gt;
&lt;br /&gt;
The template is an XHTML file with some additional syntax (see [[API:EPrints/Apache/Template]]).&lt;br /&gt;
&lt;br /&gt;
====Pins====&lt;br /&gt;
&lt;br /&gt;
You will notice a number of epc:pin elements. These tell EPrints how to combine the template with page-specific content to build each individual page.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;xml&amp;quot;&amp;gt;&lt;br /&gt;
    &amp;lt;div&amp;gt;&lt;br /&gt;
      &amp;lt;div class=&amp;quot;ep_tm_page_content&amp;quot;&amp;gt;&lt;br /&gt;
        &amp;lt;h1 class=&amp;quot;ep_tm_pagetitle&amp;quot;&amp;gt;&lt;br /&gt;
          &amp;lt;epc:pin ref=&amp;quot;title&amp;quot;/&amp;gt;&lt;br /&gt;
        &amp;lt;/h1&amp;gt;&lt;br /&gt;
        &amp;lt;epc:pin ref=&amp;quot;page&amp;quot;/&amp;gt;&lt;br /&gt;
      &amp;lt;/div&amp;gt;&lt;br /&gt;
    &amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This part of the template lays out the main content area of the page (the &#039;&#039;page&#039;&#039; pin) which is centered on the page.&lt;br /&gt;
&lt;br /&gt;
You can incorporate the epc:pin elements however you like into your new layout (although note that the head pin should always be inside the head section of the template, and the pagetop pin should be at the start of the body section). You can also define new pins (see below).&lt;br /&gt;
&lt;br /&gt;
====Configuration Strings====&lt;br /&gt;
&lt;br /&gt;
There are also a number of epc:print elements in the default template which are useful for including configuration values in the template.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;html4strict&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;style type=&amp;quot;text/css&amp;quot; media=&amp;quot;screen&amp;quot;&amp;gt;@import url(&amp;lt;epc:print expr=&amp;quot;$config{base_url}&amp;quot;/&amp;gt;/style/auto.css);&amp;lt;/style&amp;gt;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This extract from the head section of the template shows how an epc:print element is used to refer to the base URL of the repository. This avoids hardcoding URLs into the template (which is good for maintainability - if the repository URL should change, you do not have to change the template).&lt;br /&gt;
&lt;br /&gt;
Configuration values can also be used inside attributes, using the {...} syntax.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;html4strict&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;a href=&amp;quot;{$config{frontpage}}&amp;quot;&amp;gt;&amp;lt;img alt=&amp;quot;Logo&amp;quot; src=&amp;quot;{$config{site_logo}}&amp;quot; /&amp;gt;&amp;lt;/a&amp;gt;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This extract shows how the URL of both the front page of the repository and the logo are derived from the configuration rather than being hard coded directly into the template.&lt;br /&gt;
&lt;br /&gt;
====Template checklist====&lt;br /&gt;
&lt;br /&gt;
A typical repository page layout will include:&lt;br /&gt;
&lt;br /&gt;
# the correct XML declaration at the top of the file&lt;br /&gt;
# a head section (load default and custom stylesheets, &#039;&#039;title&#039;&#039; and &#039;&#039;head&#039;&#039; pins)&lt;br /&gt;
# a body section, containing:&lt;br /&gt;
## &#039;&#039;pagetop&#039;&#039; pin&lt;br /&gt;
## header (repository title and logo)&lt;br /&gt;
## navigation menu (links to browse, search etc.)&lt;br /&gt;
## quick search box&lt;br /&gt;
## toolbar (&#039;&#039;login_status&#039;&#039; and &#039;&#039;toolbar&#039;&#039; pins)&lt;br /&gt;
## main content area (&#039;&#039;title&#039;&#039; and &#039;&#039;page&#039;&#039; pins)&lt;br /&gt;
## footer (copyright notice etc.)&lt;br /&gt;
&lt;br /&gt;
====Loading the new template====&lt;br /&gt;
&lt;br /&gt;
Load your new template by running:&lt;br /&gt;
&lt;br /&gt;
 bin/epadmin reload ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
====Dealing with template errors====&lt;br /&gt;
&lt;br /&gt;
A common cause of errors when loading a new template is that the template is not &#039;&#039;well formed&#039;&#039;. The template is in XHTML syntax, and therefore must follow the rules for writing well-formed XML documents:&lt;br /&gt;
&lt;br /&gt;
* http://en.wikipedia.org/wiki/XML#Well-formed_documents&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
You get the following error when reloading the template:&lt;br /&gt;
&lt;br /&gt;
 parser error : Opening and ending tag mismatch: img line 25 and div&lt;br /&gt;
&lt;br /&gt;
Open the template file, and look for an img tag on line 25:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;img src=&amp;quot;/images/mylogo.gif&amp;quot;&amp;gt; &lt;br /&gt;
&lt;br /&gt;
The problem is that the img tag is opened, but there is no closing img tag. The img element is empty, so we can add a self-closing tag to make the eleemtn well formed:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;img src=&amp;quot;/images/mylogo.gif&amp;quot; /&amp;gt; &lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
 parser error : Opening and ending tag mismatch: p line 60 and body&lt;br /&gt;
&lt;br /&gt;
Open the template file and look for the p tag on line 60:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 &amp;lt;p&amp;gt;This repository is maintained by the &amp;lt;b&amp;gt;Library and Computing team&amp;lt;/b&amp;gt;.&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
There is no closing p tag. The p element is not empty, so we add a closing p tag at the end of the paragraph to make the element well formed:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
 &amp;lt;p&amp;gt;This repository is maintained by the &amp;lt;b&amp;gt;Library and Computing team&amp;lt;/b&amp;gt;.&amp;lt;/p&amp;gt;&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Adding extra images===&lt;br /&gt;
&lt;br /&gt;
If your new layout requires additional images, or if you want to add additional images to the default layout, you need to place a copy of each image in your repository&#039;s image directory:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/static/images/&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
Place a copy of small_logo.gif in:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/static/images/&lt;br /&gt;
&lt;br /&gt;
Use the image in the template:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;html4strict&amp;quot;&amp;gt;&lt;br /&gt;
&amp;lt;img src=&amp;quot;{$config{base_url}}/images/small_logo.gif&amp;quot; /&amp;gt;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
===Working with stylesheets===&lt;br /&gt;
&lt;br /&gt;
EPrints has [[EPrints_Directory_Structure/eprints3/lib/static/style/auto|several stylesheet files]], each of which contains style rules for a specific aspect of the repository. By default these stylesheets are applied to every repository page, in alphabetical order.&lt;br /&gt;
&lt;br /&gt;
The default stylesheets can be found here:&lt;br /&gt;
&lt;br /&gt;
 lib/static/style/auto/&lt;br /&gt;
&lt;br /&gt;
====Overriding default style rules====&lt;br /&gt;
&lt;br /&gt;
You may decide that you want to override a particular rule in one of the default stylesheets. Rather than edit the default stylesheet directly (since the edited rule will then be applied to any other repositories running on the same server), you should override the rule in your repository&#039;s overrides file:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/static/style/auto/zzz_local.css&lt;br /&gt;
&lt;br /&gt;
Remember that the stylesheets are applied in alphabetical order, so this file will be applied last.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;css&amp;quot;&amp;gt;&lt;br /&gt;
 h1 {&lt;br /&gt;
         margin: 0px 0px 10px 0px;&lt;br /&gt;
         font: bold 130% Arial,Sans-serif;&lt;br /&gt;
         text-align: center;&lt;br /&gt;
         color: #606060;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This rule is from general.css and defines how the h1 (heading level 1) element should be displayed (in the default template, h1 is used to display the title of the page).&lt;br /&gt;
&lt;br /&gt;
Edit the local overrides file for your repository:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/static/style/auto/zzz_local.css&lt;br /&gt;
&lt;br /&gt;
Override the &#039;&#039;font&#039;&#039; part of the h1 style:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;css&amp;quot;&amp;gt;&lt;br /&gt;
 h1 {&lt;br /&gt;
         font: bold 200% Arial,Sans-serif;&lt;br /&gt;
 }&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This renders the page title on each page in a larger font.&lt;br /&gt;
&lt;br /&gt;
====Overriding default stylesheets====&lt;br /&gt;
&lt;br /&gt;
If you want to override a default stylesheet in its entirety, you should copy it into your repository&#039;s stylesheet directory and edit it there.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
Make a copy of the default stylesheet general.css:&lt;br /&gt;
&lt;br /&gt;
 cp lib/static/style/auto/general.css archives/ARCHIVEID/cfg/static/style/auto/&lt;br /&gt;
&lt;br /&gt;
Edit the repository copy:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/static/style/auto/general.css&lt;br /&gt;
&lt;br /&gt;
After making changes to the repository copy of general.css, apply the new stylesheet by running:&lt;br /&gt;
&lt;br /&gt;
 bin/generate_static ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
====Adding institutional stylesheets====&lt;br /&gt;
&lt;br /&gt;
Your institutional Web site may already have a stylesheet or set of stylesheets that you want to apply to your repository.&lt;br /&gt;
&lt;br /&gt;
Copy the institutional stylesheets into your repository stylesheet directory:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/static/style/&lt;br /&gt;
&lt;br /&gt;
Process the stylesheets by running:&lt;br /&gt;
&lt;br /&gt;
 bin/generate_static ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
The stylesheets are then available to use in the template file.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;html4strict&amp;quot;&amp;gt;&lt;br /&gt;
 &amp;lt;head&amp;gt;&lt;br /&gt;
  ...&lt;br /&gt;
  &amp;lt;style type=&amp;quot;text/css&amp;quot; media=&amp;quot;screen&amp;quot;&amp;gt;@import url(&amp;lt;epc:print expr=&amp;quot;$config{base_url}&amp;quot;/&amp;gt;/style/auto.css);&amp;lt;/style&amp;gt;&lt;br /&gt;
  &amp;lt;style type=&amp;quot;text/css&amp;quot; media=&amp;quot;screen&amp;quot;&amp;gt;@import url(&amp;lt;epc:print expr=&amp;quot;$config{base_url}&amp;quot;/&amp;gt;/style/my_inst.css);&amp;lt;/style&amp;gt;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Here we add a stylesheet link to our institutional stylesheet my_inst.css to the head section of the template. Note that we apply my_inst.css &#039;&#039;after&#039;&#039; the repository stylesheets (applied in order by auto.css) so that the institutional style rules override the repository style rules.&lt;br /&gt;
&lt;br /&gt;
====Adding extra style-related images====&lt;br /&gt;
&lt;br /&gt;
If your new stylesheet requires additional images (eg. background images for tables or divs), you need to place a copy of each image in your repository style/image directory:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/static/style/images/&lt;br /&gt;
&lt;br /&gt;
Note that this keeps the style-related images separate from other images used by your repository pages, such as logos.&lt;br /&gt;
&lt;br /&gt;
The images can then be used in your stylesheet.&lt;br /&gt;
&lt;br /&gt;
===Adding dynamic content===&lt;br /&gt;
&lt;br /&gt;
You can add dynamic content to the template by adding extra epc:pin elements.&lt;br /&gt;
&lt;br /&gt;
Dynamic pins can be created in the dynamic template configuration file:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/cfg.d/dynamic_template.pl&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example&lt;br /&gt;
&lt;br /&gt;
Open the template file for your repository:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/lang/en/templates/default.xml&lt;br /&gt;
&lt;br /&gt;
Add a new pin called &#039;&#039;todays_date&#039;&#039; to the template; here we add the pin next to the user&#039;s login status:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;html4strict&amp;quot;&amp;gt;&lt;br /&gt;
    &amp;lt;div&amp;gt;&lt;br /&gt;
      &amp;lt;div class=&amp;quot;ep_tm_page_content&amp;quot;&amp;gt;&lt;br /&gt;
        &amp;lt;h1 class=&amp;quot;ep_tm_pagetitle&amp;quot;&amp;gt;&lt;br /&gt;
          &amp;lt;epc:pin ref=&amp;quot;title&amp;quot;/&amp;gt;&lt;br /&gt;
        &amp;lt;/h1&amp;gt;&lt;br /&gt;
        &amp;lt;epc:pin ref=&amp;quot;page&amp;quot;/&amp;gt;&lt;br /&gt;
        &amp;lt;epc:pin ref=&amp;quot;todays_date&amp;quot;/&amp;gt;&lt;br /&gt;
      &amp;lt;/div&amp;gt;&lt;br /&gt;
    &amp;lt;/div&amp;gt;&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Open the dynamic template configuration file for your repository:&lt;br /&gt;
&lt;br /&gt;
 archives/ARCHIVEID/cfg/cfg.d/dynamic_template.pl&lt;br /&gt;
&lt;br /&gt;
Find and uncomment the function that creates the content for the dynamic pins:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;perl&amp;quot;&amp;gt;&lt;br /&gt;
 $c-&amp;gt;{dynamic_template}-&amp;gt;{function} = sub {&lt;br /&gt;
    my( $repository, $parts ) = @_;&lt;br /&gt;
 };&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Add a line which creates the content for the &#039;&#039;todays_date&#039;&#039; pin:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;perl&amp;quot;&amp;gt;&lt;br /&gt;
$c-&amp;gt;{dynamic_template}-&amp;gt;{function} = sub {&lt;br /&gt;
 my( $repository, $parts ) = @_;&lt;br /&gt;
 $parts-&amp;gt;{todays_date} = $repository-&amp;gt;make_text( scalar localtime );&lt;br /&gt;
};&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Reload the dynamic template configuration:&lt;br /&gt;
&lt;br /&gt;
 bin/epadmin reload ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
The date should now be displayed on your repository pages.&lt;br /&gt;
&lt;br /&gt;
== See also ==&lt;br /&gt;
* [[Branding, the next level]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Template:Manual&amp;diff=17589</id>
		<title>Template:Manual</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Template:Manual&amp;diff=17589"/>
		<updated>2026-10-16T12:07:13Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{box|title=Manual Sections|content=&lt;br /&gt;
* [[Introduction]]&lt;br /&gt;
** [[Contact|How to Get Help/Support]]&lt;br /&gt;
** [[History]]&lt;br /&gt;
* Installing EPrints &amp;amp; Getting Started&lt;br /&gt;
** [[Installation|Installing EPrints]]&lt;br /&gt;
*** [[Installing EPrints on RHEL/Fedora/CentOS|Installation on RHEL-based Linux]]&lt;br /&gt;
*** [[Installing_EPrints_on_Debian/Ubuntu|Installation on Debian/Ubuntu]]&lt;br /&gt;
*** [[Generic Linux Installation|Installation on Generic Linux OS]]&lt;br /&gt;
**** [[Required software]]&lt;br /&gt;
** [[Upgrading|Upgrading EPrints]]&lt;br /&gt;
** [[Setting up an Archive]]&lt;br /&gt;
** [[Backups]]&lt;br /&gt;
** [[Troubleshooting]]&lt;br /&gt;
** Advanced Installation&lt;br /&gt;
*** [[How to use EPrints with HTTPS]]&lt;br /&gt;
*** [[Setting up email]]&lt;br /&gt;
* Configuring EPrints&lt;br /&gt;
** [[Branding with confidence]]&lt;br /&gt;
** [[Metadata|Deposit Types and Metadata]]&lt;br /&gt;
** [[Organisation Hierarchy]]&lt;br /&gt;
** [[Searches]]&lt;br /&gt;
* Advanced Configuration/Howtos&lt;br /&gt;
** [[Setting up HTTPS using Let&#039;s Encrypt]]&lt;br /&gt;
** [[HTTPS-only and HSTS]]&lt;br /&gt;
** [[Shibboleth|User Authentication using Shibboleth]]&lt;br /&gt;
* Technical Reference&lt;br /&gt;
** [[EPrints configuration|EPrints Configuration Reference]]&lt;br /&gt;
** [[Repository configuration|Repository Configuration Reference]]&lt;br /&gt;
** [[Metadata|Metadata Reference]] (also [[Functions]])&lt;br /&gt;
** [[API Overview]]&lt;br /&gt;
* [[Entire Manual]] (for printing)&lt;br /&gt;
}}&lt;br /&gt;
[[Category:Manual]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17588</id>
		<title>Archive:Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17588"/>
		<updated>2026-10-16T12:06:19Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{Template:Deprecated}}&lt;br /&gt;
{{manual}}&lt;br /&gt;
[[Category:Branding]]&lt;br /&gt;
There are several different types of page in the eprints WebsiteInterface and they are generated in different ways. See WebsiteInterface for an explanation.&lt;br /&gt;
&lt;br /&gt;
Every page on eprints is wrapped in the site template. This can be found at /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
==Changing the Template==&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
Make your changes. Be careful not to remove the &amp;lt;pin&amp;gt; elements as this is how eprints knows where to insert information. &lt;br /&gt;
&lt;br /&gt;
Note that this file is XML so all tags must be closed correctly.&lt;br /&gt;
&lt;br /&gt;
==Cause the new template to be applied==&lt;br /&gt;
&lt;br /&gt;
TIP: If you want to see the new template in situ without waiting to update all the webpages then run &amp;quot;generate_abstracts myid 66&amp;quot; (or some other existing abstract page) and see the change on that one page.&lt;br /&gt;
&lt;br /&gt;
This is slightly different for each part of the site...&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Static page | Static pages]] ===&lt;br /&gt;
run generate_static&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Abstract page | Abstract pages]]===&lt;br /&gt;
&lt;br /&gt;
run generate_abstracts&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#EPrint view page | View pages]] ===&lt;br /&gt;
&lt;br /&gt;
run generate_views&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Dynamic Pages | Dynamic pages]] ===&lt;br /&gt;
&lt;br /&gt;
run force_config_reload or resart the webserver&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=How_to_use_EPrints_with_HTTPS&amp;diff=17587</id>
		<title>How to use EPrints with HTTPS</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=How_to_use_EPrints_with_HTTPS&amp;diff=17587"/>
		<updated>2026-10-16T10:34:45Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
&lt;br /&gt;
[[Category:Authentication]]&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;This guide is intended for EPrints 3.3 or later and is a good staring point, but the [[Simplified_HTTPS_Configuration | Update]] may be more appropriate for this current version!&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;N.B.&#039;&#039;&#039; Setting up your Apache Web server is beyond the scope of this document.  Please see your operating system documentation and the Apache documentation for assistance in setting up Apache in your environment.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Before you Begin ==&lt;br /&gt;
This guide assumes you have already got your SSL certificates or know how to get them when required. We mostly do this using Let&#039;s Encrypt, and have a [[Setting up HTTPS using Let&#039;s Encrypt | handy guide]] on it.&lt;br /&gt;
&lt;br /&gt;
== Configuration ==&lt;br /&gt;
Below is a list of variable names described in these instructions and example values of what they might be in a real-world configuration.&lt;br /&gt;
{| border=&amp;quot;1&amp;quot; cellpadding=&amp;quot;10&amp;quot; cellspacing=&amp;quot;0&amp;quot;&lt;br /&gt;
!Variable&lt;br /&gt;
!Example&lt;br /&gt;
|-&lt;br /&gt;
|EPRINTS_PATH&lt;br /&gt;
|/opt/eprints3&lt;br /&gt;
|-&lt;br /&gt;
|YOUR-REPOSITORY-DOMAIN&lt;br /&gt;
|example.eprints.org&lt;br /&gt;
|-&lt;br /&gt;
|REPOID&lt;br /&gt;
|example&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
To start setting up your existing archive to work under HTTPS, you must first edit &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/cfg/cfg.d/10_core.pl&amp;lt;/code&amp;gt;. Initially it will probably look something like the configuration directly below,  which is the basic &amp;lt;code&amp;gt;10_core.pl&amp;lt;/code&amp;gt; configuration file after you have run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/epadmin create&amp;lt;/code&amp;gt; to set up your archive.  Alternatively you could run &amp;lt;code&amp;gt;/opt/eprints3/bin/epadmin config_core REPOID&amp;lt;/code&amp;gt; that will prompt you for the following information. It is suggested that you make a backup of the &amp;lt;code&amp;gt;10_core.pl&amp;lt;/code&amp;gt; file regardless before proceeding.&lt;br /&gt;
&lt;br /&gt;
 $c-&amp;gt;{host} = &#039;YOUR-REPOSITORY-DOMAIN&#039;;&lt;br /&gt;
 $c-&amp;gt;{port} = 80;&lt;br /&gt;
 $c-&amp;gt;{aliases} = [];&lt;br /&gt;
 $c-&amp;gt;{securehost} = &amp;amp;#39;&amp;amp;#39;;&lt;br /&gt;
 $c-&amp;gt;{secureport} = 443;&lt;br /&gt;
 $c-&amp;gt;{http_root} = undef;&lt;br /&gt;
&lt;br /&gt;
Update the file to define the secure host and modify ports as needed.  If your Apache web server is not using the standard ports (80,443) you can adjust the &amp;lt;code&amp;gt;port&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;secureport&amp;lt;/code&amp;gt; parameters in the config file accordingly.&lt;br /&gt;
&lt;br /&gt;
 $c-&amp;gt;{host} = &#039;YOUR-REPOSITORY-DOMAIN&#039;;&lt;br /&gt;
 $c-&amp;gt;{port} = 80;&lt;br /&gt;
 $c-&amp;gt;{aliases} = [];&lt;br /&gt;
 $c-&amp;gt;{securehost} = $c-&amp;gt;{host};&lt;br /&gt;
 $c-&amp;gt;{secureport} = 443;&lt;br /&gt;
 $c-&amp;gt;{http_root} = undef;&lt;br /&gt;
&lt;br /&gt;
Now, you need to create the directory &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/&amp;lt;/code&amp;gt; and then edit the file &amp;lt;code&amp;gt;REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt;.  This file should look something like below.  If you are installing EPrints on Debian/Ubuntu based systems you will need to create a symlink &amp;lt;code&amp;gt;logs&amp;lt;/code&amp;gt; in &amp;lt;code&amp;gt;/etc/apache2/&amp;lt;/code&amp;gt; to point at &amp;lt;code&amp;gt;/var/log/apache2/&amp;lt;/code&amp;gt;. &lt;br /&gt;
{{Securevhost.conf}}&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the SSL key, certificate and chain files in the same directory as &amp;lt;code&amp;gt;securevhost.conf&amp;lt;/code&amp;gt;, as this will make it easy if you need to migrate you EPrints repository to a new server in the future.&lt;br /&gt;
&lt;br /&gt;
== Generate the Apache Configuration File for HTTPS ==&lt;br /&gt;
Run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf --system --replace&amp;lt;/code&amp;gt; to generate the secure Apache configuration files.  This will set up the repository configuration file located in the &amp;lt;code&amp;gt;EPRINTS_PATH/cfg/apache_ssl/&amp;lt;/code&amp;gt; directory named &amp;lt;code&amp;gt;REPOID.conf&amp;lt;/code&amp;gt;. &lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Add the Main Apache Config File to SSL Config ==&lt;br /&gt;
Depending upon the version of EPrints you are running there are a couple files that may be involved.  It is recommended to run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf --man&amp;lt;/code&amp;gt; or view the source of &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf&amp;lt;/code&amp;gt; file to understand what file(s) need to be set up.  Apache will not yet have been set up to include &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt;.  &lt;br /&gt;
&lt;br /&gt;
To include this, you will need to find the file that already includes &amp;lt;code&amp;gt;cfg/apache.conf&amp;lt;/code&amp;gt;.  (For Red Hat/Fedora/CentOS Linux you will need to look in &amp;lt;code&amp;gt;/etc/httpd/&amp;lt;/code&amp;gt;.  For Debian/Ubuntu Linux you will need to look in &amp;lt;code&amp;gt;/etc/apache2/&amp;lt;/code&amp;gt;).  Then add the following line afterwards&lt;br /&gt;
&lt;br /&gt;
 Include EPRINTS_PATH/archives/*/ssl/securevhost.conf&lt;br /&gt;
&lt;br /&gt;
== Restart Apache to pick up the changes to the Apache configuration ==&lt;br /&gt;
Consult your operating system documentation on how to restart service processes but in general you need to run one of the following commands either as &amp;lt;code&amp;gt;root&amp;lt;/code&amp;gt; or using &amp;lt;code&amp;gt;sudo&amp;lt;/code&amp;gt;:&lt;br /&gt;
&lt;br /&gt;
=== For Red Hat/Fedora/CentOS Linux ===&lt;br /&gt;
 /sbin/service httpd restart&lt;br /&gt;
&lt;br /&gt;
=== For Debian/Ubuntu Linux ===&lt;br /&gt;
Before restarting Apache make sure &amp;lt;code&amp;gt;mod_ssl&amp;lt;/code&amp;gt; is enabled:&lt;br /&gt;
 a2enmod ssl&lt;br /&gt;
Then restart Apache: &lt;br /&gt;
 /etc/init.d/apache2 restart&lt;br /&gt;
&lt;br /&gt;
== Confirmation ==&lt;br /&gt;
Open your web browser and access your repository via its URL, this should be done over HTTP.  When you click to login you should notice that you will be redirected to an HTTPS connection.&amp;lt;br/&amp;gt;N.B. Any task that require you to be logged in will be redirected to an HTTPS connection otherwise an HTTP request will be used by default. &lt;br /&gt;
&lt;br /&gt;
== HTTPS Only == &lt;br /&gt;
EPrints default HTTPS configuration is usually sufficient for most institutions needs, as there is no absolute need to encrypt the requesting and sending of Open Access research.  However, if you wish to only ever use HTTPS, then follow the instructions for [[HTTPS-only and HSTS]].  HSTS (HTTP Strict Transport Security) ensures that even if the link you click on is for HTTP, your web browser will convert this to HTTPS before making the request.  Meaning you will never send any un-encrypted traffic to EPrints.  It also helps reduce the load on your repository&#039;s server, as it save it having to do the HTTP to HTTPS redirection.  &lt;br /&gt;
&lt;br /&gt;
It is generally a good idea to enable HSTS even on repositories with default HTTPS configuration, in case there are any errant bespoke links that could send private information using HTTP.  This can be done by adding the following line to &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt; after the &amp;lt;code&amp;gt;ServerName&amp;lt;/code&amp;gt; line and then restarting Apache again:&lt;br /&gt;
&lt;br /&gt;
 Header set Strict-Transport-Security &amp;quot;max-age=15780000&amp;quot;&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=How_to_use_EPrints_with_HTTPS&amp;diff=17586</id>
		<title>How to use EPrints with HTTPS</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=How_to_use_EPrints_with_HTTPS&amp;diff=17586"/>
		<updated>2026-10-16T10:33:59Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Before you Begin */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
&lt;br /&gt;
[[Category:Authentication]]&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;This guide is intended for EPrints 3.3 or later,&amp;lt;br/&amp;gt; but the [[Simplified_HTTPS_Configuration | Update]] may be more appropriate for this current version!&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;N.B.&#039;&#039;&#039; Setting up your Apache Web server is beyond the scope of this document.  Please see your operating system documentation and the Apache documentation for assistance in setting up Apache in your environment.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Before you Begin ==&lt;br /&gt;
This guide assumes you have already got your SSL certificates or know how to get them when required. We mostly do this using Let&#039;s Encrypt, and have a [[Setting up HTTPS using Let&#039;s Encrypt | handy guide]] on it.&lt;br /&gt;
&lt;br /&gt;
== Configuration ==&lt;br /&gt;
Below is a list of variable names described in these instructions and example values of what they might be in a real-world configuration.&lt;br /&gt;
{| border=&amp;quot;1&amp;quot; cellpadding=&amp;quot;10&amp;quot; cellspacing=&amp;quot;0&amp;quot;&lt;br /&gt;
!Variable&lt;br /&gt;
!Example&lt;br /&gt;
|-&lt;br /&gt;
|EPRINTS_PATH&lt;br /&gt;
|/opt/eprints3&lt;br /&gt;
|-&lt;br /&gt;
|YOUR-REPOSITORY-DOMAIN&lt;br /&gt;
|example.eprints.org&lt;br /&gt;
|-&lt;br /&gt;
|REPOID&lt;br /&gt;
|example&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
To start setting up your existing archive to work under HTTPS, you must first edit &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/cfg/cfg.d/10_core.pl&amp;lt;/code&amp;gt;. Initially it will probably look something like the configuration directly below,  which is the basic &amp;lt;code&amp;gt;10_core.pl&amp;lt;/code&amp;gt; configuration file after you have run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/epadmin create&amp;lt;/code&amp;gt; to set up your archive.  Alternatively you could run &amp;lt;code&amp;gt;/opt/eprints3/bin/epadmin config_core REPOID&amp;lt;/code&amp;gt; that will prompt you for the following information. It is suggested that you make a backup of the &amp;lt;code&amp;gt;10_core.pl&amp;lt;/code&amp;gt; file regardless before proceeding.&lt;br /&gt;
&lt;br /&gt;
 $c-&amp;gt;{host} = &#039;YOUR-REPOSITORY-DOMAIN&#039;;&lt;br /&gt;
 $c-&amp;gt;{port} = 80;&lt;br /&gt;
 $c-&amp;gt;{aliases} = [];&lt;br /&gt;
 $c-&amp;gt;{securehost} = &amp;amp;#39;&amp;amp;#39;;&lt;br /&gt;
 $c-&amp;gt;{secureport} = 443;&lt;br /&gt;
 $c-&amp;gt;{http_root} = undef;&lt;br /&gt;
&lt;br /&gt;
Update the file to define the secure host and modify ports as needed.  If your Apache web server is not using the standard ports (80,443) you can adjust the &amp;lt;code&amp;gt;port&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;secureport&amp;lt;/code&amp;gt; parameters in the config file accordingly.&lt;br /&gt;
&lt;br /&gt;
 $c-&amp;gt;{host} = &#039;YOUR-REPOSITORY-DOMAIN&#039;;&lt;br /&gt;
 $c-&amp;gt;{port} = 80;&lt;br /&gt;
 $c-&amp;gt;{aliases} = [];&lt;br /&gt;
 $c-&amp;gt;{securehost} = $c-&amp;gt;{host};&lt;br /&gt;
 $c-&amp;gt;{secureport} = 443;&lt;br /&gt;
 $c-&amp;gt;{http_root} = undef;&lt;br /&gt;
&lt;br /&gt;
Now, you need to create the directory &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/&amp;lt;/code&amp;gt; and then edit the file &amp;lt;code&amp;gt;REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt;.  This file should look something like below.  If you are installing EPrints on Debian/Ubuntu based systems you will need to create a symlink &amp;lt;code&amp;gt;logs&amp;lt;/code&amp;gt; in &amp;lt;code&amp;gt;/etc/apache2/&amp;lt;/code&amp;gt; to point at &amp;lt;code&amp;gt;/var/log/apache2/&amp;lt;/code&amp;gt;. &lt;br /&gt;
{{Securevhost.conf}}&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the SSL key, certificate and chain files in the same directory as &amp;lt;code&amp;gt;securevhost.conf&amp;lt;/code&amp;gt;, as this will make it easy if you need to migrate you EPrints repository to a new server in the future.&lt;br /&gt;
&lt;br /&gt;
== Generate the Apache Configuration File for HTTPS ==&lt;br /&gt;
Run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf --system --replace&amp;lt;/code&amp;gt; to generate the secure Apache configuration files.  This will set up the repository configuration file located in the &amp;lt;code&amp;gt;EPRINTS_PATH/cfg/apache_ssl/&amp;lt;/code&amp;gt; directory named &amp;lt;code&amp;gt;REPOID.conf&amp;lt;/code&amp;gt;. &lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Add the Main Apache Config File to SSL Config ==&lt;br /&gt;
Depending upon the version of EPrints you are running there are a couple files that may be involved.  It is recommended to run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf --man&amp;lt;/code&amp;gt; or view the source of &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf&amp;lt;/code&amp;gt; file to understand what file(s) need to be set up.  Apache will not yet have been set up to include &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt;.  &lt;br /&gt;
&lt;br /&gt;
To include this, you will need to find the file that already includes &amp;lt;code&amp;gt;cfg/apache.conf&amp;lt;/code&amp;gt;.  (For Red Hat/Fedora/CentOS Linux you will need to look in &amp;lt;code&amp;gt;/etc/httpd/&amp;lt;/code&amp;gt;.  For Debian/Ubuntu Linux you will need to look in &amp;lt;code&amp;gt;/etc/apache2/&amp;lt;/code&amp;gt;).  Then add the following line afterwards&lt;br /&gt;
&lt;br /&gt;
 Include EPRINTS_PATH/archives/*/ssl/securevhost.conf&lt;br /&gt;
&lt;br /&gt;
== Restart Apache to pick up the changes to the Apache configuration ==&lt;br /&gt;
Consult your operating system documentation on how to restart service processes but in general you need to run one of the following commands either as &amp;lt;code&amp;gt;root&amp;lt;/code&amp;gt; or using &amp;lt;code&amp;gt;sudo&amp;lt;/code&amp;gt;:&lt;br /&gt;
&lt;br /&gt;
=== For Red Hat/Fedora/CentOS Linux ===&lt;br /&gt;
 /sbin/service httpd restart&lt;br /&gt;
&lt;br /&gt;
=== For Debian/Ubuntu Linux ===&lt;br /&gt;
Before restarting Apache make sure &amp;lt;code&amp;gt;mod_ssl&amp;lt;/code&amp;gt; is enabled:&lt;br /&gt;
 a2enmod ssl&lt;br /&gt;
Then restart Apache: &lt;br /&gt;
 /etc/init.d/apache2 restart&lt;br /&gt;
&lt;br /&gt;
== Confirmation ==&lt;br /&gt;
Open your web browser and access your repository via its URL, this should be done over HTTP.  When you click to login you should notice that you will be redirected to an HTTPS connection.&amp;lt;br/&amp;gt;N.B. Any task that require you to be logged in will be redirected to an HTTPS connection otherwise an HTTP request will be used by default. &lt;br /&gt;
&lt;br /&gt;
== HTTPS Only == &lt;br /&gt;
EPrints default HTTPS configuration is usually sufficient for most institutions needs, as there is no absolute need to encrypt the requesting and sending of Open Access research.  However, if you wish to only ever use HTTPS, then follow the instructions for [[HTTPS-only and HSTS]].  HSTS (HTTP Strict Transport Security) ensures that even if the link you click on is for HTTP, your web browser will convert this to HTTPS before making the request.  Meaning you will never send any un-encrypted traffic to EPrints.  It also helps reduce the load on your repository&#039;s server, as it save it having to do the HTTP to HTTPS redirection.  &lt;br /&gt;
&lt;br /&gt;
It is generally a good idea to enable HSTS even on repositories with default HTTPS configuration, in case there are any errant bespoke links that could send private information using HTTP.  This can be done by adding the following line to &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt; after the &amp;lt;code&amp;gt;ServerName&amp;lt;/code&amp;gt; line and then restarting Apache again:&lt;br /&gt;
&lt;br /&gt;
 Header set Strict-Transport-Security &amp;quot;max-age=15780000&amp;quot;&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=How_to_use_EPrints_with_HTTPS&amp;diff=17585</id>
		<title>How to use EPrints with HTTPS</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=How_to_use_EPrints_with_HTTPS&amp;diff=17585"/>
		<updated>2026-10-16T10:33:27Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
&lt;br /&gt;
[[Category:Authentication]]&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;This guide is intended for EPrints 3.3 or later,&amp;lt;br/&amp;gt; but the [[Simplified_HTTPS_Configuration | Update]] may be more appropriate for this current version!&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;N.B.&#039;&#039;&#039; Setting up your Apache Web server is beyond the scope of this document.  Please see your operating system documentation and the Apache documentation for assistance in setting up Apache in your environment.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Before you Begin ==&lt;br /&gt;
This guide assumes you have already got your SSL certificates or know how to get them when required. We mostly do this using Let&#039;s Encrypt, and have a handy guide on it.&lt;br /&gt;
&lt;br /&gt;
== Configuration ==&lt;br /&gt;
Below is a list of variable names described in these instructions and example values of what they might be in a real-world configuration.&lt;br /&gt;
{| border=&amp;quot;1&amp;quot; cellpadding=&amp;quot;10&amp;quot; cellspacing=&amp;quot;0&amp;quot;&lt;br /&gt;
!Variable&lt;br /&gt;
!Example&lt;br /&gt;
|-&lt;br /&gt;
|EPRINTS_PATH&lt;br /&gt;
|/opt/eprints3&lt;br /&gt;
|-&lt;br /&gt;
|YOUR-REPOSITORY-DOMAIN&lt;br /&gt;
|example.eprints.org&lt;br /&gt;
|-&lt;br /&gt;
|REPOID&lt;br /&gt;
|example&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
To start setting up your existing archive to work under HTTPS, you must first edit &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/cfg/cfg.d/10_core.pl&amp;lt;/code&amp;gt;. Initially it will probably look something like the configuration directly below,  which is the basic &amp;lt;code&amp;gt;10_core.pl&amp;lt;/code&amp;gt; configuration file after you have run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/epadmin create&amp;lt;/code&amp;gt; to set up your archive.  Alternatively you could run &amp;lt;code&amp;gt;/opt/eprints3/bin/epadmin config_core REPOID&amp;lt;/code&amp;gt; that will prompt you for the following information. It is suggested that you make a backup of the &amp;lt;code&amp;gt;10_core.pl&amp;lt;/code&amp;gt; file regardless before proceeding.&lt;br /&gt;
&lt;br /&gt;
 $c-&amp;gt;{host} = &#039;YOUR-REPOSITORY-DOMAIN&#039;;&lt;br /&gt;
 $c-&amp;gt;{port} = 80;&lt;br /&gt;
 $c-&amp;gt;{aliases} = [];&lt;br /&gt;
 $c-&amp;gt;{securehost} = &amp;amp;#39;&amp;amp;#39;;&lt;br /&gt;
 $c-&amp;gt;{secureport} = 443;&lt;br /&gt;
 $c-&amp;gt;{http_root} = undef;&lt;br /&gt;
&lt;br /&gt;
Update the file to define the secure host and modify ports as needed.  If your Apache web server is not using the standard ports (80,443) you can adjust the &amp;lt;code&amp;gt;port&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;secureport&amp;lt;/code&amp;gt; parameters in the config file accordingly.&lt;br /&gt;
&lt;br /&gt;
 $c-&amp;gt;{host} = &#039;YOUR-REPOSITORY-DOMAIN&#039;;&lt;br /&gt;
 $c-&amp;gt;{port} = 80;&lt;br /&gt;
 $c-&amp;gt;{aliases} = [];&lt;br /&gt;
 $c-&amp;gt;{securehost} = $c-&amp;gt;{host};&lt;br /&gt;
 $c-&amp;gt;{secureport} = 443;&lt;br /&gt;
 $c-&amp;gt;{http_root} = undef;&lt;br /&gt;
&lt;br /&gt;
Now, you need to create the directory &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/&amp;lt;/code&amp;gt; and then edit the file &amp;lt;code&amp;gt;REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt;.  This file should look something like below.  If you are installing EPrints on Debian/Ubuntu based systems you will need to create a symlink &amp;lt;code&amp;gt;logs&amp;lt;/code&amp;gt; in &amp;lt;code&amp;gt;/etc/apache2/&amp;lt;/code&amp;gt; to point at &amp;lt;code&amp;gt;/var/log/apache2/&amp;lt;/code&amp;gt;. &lt;br /&gt;
{{Securevhost.conf}}&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the SSL key, certificate and chain files in the same directory as &amp;lt;code&amp;gt;securevhost.conf&amp;lt;/code&amp;gt;, as this will make it easy if you need to migrate you EPrints repository to a new server in the future.&lt;br /&gt;
&lt;br /&gt;
== Generate the Apache Configuration File for HTTPS ==&lt;br /&gt;
Run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf --system --replace&amp;lt;/code&amp;gt; to generate the secure Apache configuration files.  This will set up the repository configuration file located in the &amp;lt;code&amp;gt;EPRINTS_PATH/cfg/apache_ssl/&amp;lt;/code&amp;gt; directory named &amp;lt;code&amp;gt;REPOID.conf&amp;lt;/code&amp;gt;. &lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Add the Main Apache Config File to SSL Config ==&lt;br /&gt;
Depending upon the version of EPrints you are running there are a couple files that may be involved.  It is recommended to run &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf --man&amp;lt;/code&amp;gt; or view the source of &amp;lt;code&amp;gt;EPRINTS_PATH/bin/generate_apacheconf&amp;lt;/code&amp;gt; file to understand what file(s) need to be set up.  Apache will not yet have been set up to include &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt;.  &lt;br /&gt;
&lt;br /&gt;
To include this, you will need to find the file that already includes &amp;lt;code&amp;gt;cfg/apache.conf&amp;lt;/code&amp;gt;.  (For Red Hat/Fedora/CentOS Linux you will need to look in &amp;lt;code&amp;gt;/etc/httpd/&amp;lt;/code&amp;gt;.  For Debian/Ubuntu Linux you will need to look in &amp;lt;code&amp;gt;/etc/apache2/&amp;lt;/code&amp;gt;).  Then add the following line afterwards&lt;br /&gt;
&lt;br /&gt;
 Include EPRINTS_PATH/archives/*/ssl/securevhost.conf&lt;br /&gt;
&lt;br /&gt;
== Restart Apache to pick up the changes to the Apache configuration ==&lt;br /&gt;
Consult your operating system documentation on how to restart service processes but in general you need to run one of the following commands either as &amp;lt;code&amp;gt;root&amp;lt;/code&amp;gt; or using &amp;lt;code&amp;gt;sudo&amp;lt;/code&amp;gt;:&lt;br /&gt;
&lt;br /&gt;
=== For Red Hat/Fedora/CentOS Linux ===&lt;br /&gt;
 /sbin/service httpd restart&lt;br /&gt;
&lt;br /&gt;
=== For Debian/Ubuntu Linux ===&lt;br /&gt;
Before restarting Apache make sure &amp;lt;code&amp;gt;mod_ssl&amp;lt;/code&amp;gt; is enabled:&lt;br /&gt;
 a2enmod ssl&lt;br /&gt;
Then restart Apache: &lt;br /&gt;
 /etc/init.d/apache2 restart&lt;br /&gt;
&lt;br /&gt;
== Confirmation ==&lt;br /&gt;
Open your web browser and access your repository via its URL, this should be done over HTTP.  When you click to login you should notice that you will be redirected to an HTTPS connection.&amp;lt;br/&amp;gt;N.B. Any task that require you to be logged in will be redirected to an HTTPS connection otherwise an HTTP request will be used by default. &lt;br /&gt;
&lt;br /&gt;
== HTTPS Only == &lt;br /&gt;
EPrints default HTTPS configuration is usually sufficient for most institutions needs, as there is no absolute need to encrypt the requesting and sending of Open Access research.  However, if you wish to only ever use HTTPS, then follow the instructions for [[HTTPS-only and HSTS]].  HSTS (HTTP Strict Transport Security) ensures that even if the link you click on is for HTTP, your web browser will convert this to HTTPS before making the request.  Meaning you will never send any un-encrypted traffic to EPrints.  It also helps reduce the load on your repository&#039;s server, as it save it having to do the HTTP to HTTPS redirection.  &lt;br /&gt;
&lt;br /&gt;
It is generally a good idea to enable HSTS even on repositories with default HTTPS configuration, in case there are any errant bespoke links that could send private information using HTTP.  This can be done by adding the following line to &amp;lt;code&amp;gt;EPRINTS_PATH/archives/REPOID/ssl/securevhost.conf&amp;lt;/code&amp;gt; after the &amp;lt;code&amp;gt;ServerName&amp;lt;/code&amp;gt; line and then restarting Apache again:&lt;br /&gt;
&lt;br /&gt;
 Header set Strict-Transport-Security &amp;quot;max-age=15780000&amp;quot;&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Troubleshooting&amp;diff=17584</id>
		<title>Troubleshooting</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Troubleshooting&amp;diff=17584"/>
		<updated>2026-10-16T09:55:30Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* A Note on SELinux */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
==Trouble Shooting==&lt;br /&gt;
This section covers some things which can go wrong and why. If you have a suggestion for this section, let us know!&lt;br /&gt;
&lt;br /&gt;
It will grow as people suggest new problems and solutions. Check the http://www.eprints.org/ website for the latest version.&lt;br /&gt;
&lt;br /&gt;
==Installation of EPrints and Required Software==&lt;br /&gt;
===Apache Crashes with a segmentation fault===&lt;br /&gt;
Possible cause: apache linked against &amp;quot;expat&amp;quot; library. If you did not install apache from source then it is possible it was linked against the &amp;quot;expat&amp;quot; library. The problem arrises that it is also linked against mod_perl and when we use the XML::Parser module, that is also linked against expat. 2 expat&#039;s in one apache make it seg-fault.&lt;br /&gt;
&lt;br /&gt;
===(Under SuSE Linux) Apache has problems compiling the mod rewrite module===&lt;br /&gt;
With an error something like:&lt;br /&gt;
 In file included from mod_rewrite.c:93:&lt;br /&gt;
 mod_rewrite.h:133: ndbm.h: No such file or directory&lt;br /&gt;
&lt;br /&gt;
Possible cause: Missing the ndbm library which is required (for some reason).&lt;br /&gt;
&lt;br /&gt;
Solution: It comes as part of gdbm which is free. If working from a package you need gdbm-devel to get the header files (.h files).&lt;br /&gt;
&lt;br /&gt;
=== (under debian sarge with apache2) Apache::const can&#039;t be located correctly when executing ./configure. ===&lt;br /&gt;
&lt;br /&gt;
Solution: execute&lt;br /&gt;
 export PERLLIB=/usr/lib/perl5/Apache2/&lt;br /&gt;
in a sh environment before ./configure.&lt;br /&gt;
&lt;br /&gt;
==Setting Up and Configuring a New Archive==&lt;br /&gt;
===System gives a &amp;quot;500 Internal Error&amp;quot; when viewing advanced search or submitting a document===&lt;br /&gt;
Possible cause: No Subjects, Bug in code.&lt;br /&gt;
&lt;br /&gt;
Solution: Run &#039;&#039;&#039;generate_subjects&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
If this fails: Look at your apache error log for clues. If reporting a bug, include the errors from the apache error log (often, but now always, found at &amp;lt;tt&amp;gt;/usr/local/apache/logs/error_log&amp;lt;/tt&amp;gt;)&lt;br /&gt;
&lt;br /&gt;
== MySQL ==&lt;br /&gt;
See [[Common MySQL Problems with EPrints]].&lt;br /&gt;
&lt;br /&gt;
==General==&lt;br /&gt;
Solution: Build apache following the detailed instructions in the &amp;quot;requried software&amp;quot; section of the documentation.&lt;br /&gt;
&lt;br /&gt;
===Changes to the configuration didn&#039;t appear on the website===&lt;br /&gt;
Possible cause: Several.&lt;br /&gt;
&lt;br /&gt;
Solution: Rebuild everything by re-running (for the archive in question) &#039;&#039;&#039;generate_static&#039;&#039;&#039;, &#039;&#039;&#039;generate_views&#039;&#039;&#039;, &#039;&#039;&#039;generate_apacheconf&#039;&#039;&#039; then stop and start apache. &#039;&#039;&#039;generate_abstracts&#039;&#039;&#039; can take a long time, so don&#039;t run it unless you want to update the abstracts themselves.&lt;br /&gt;
&lt;br /&gt;
===Browse View page gives a &amp;quot;404 not found&amp;quot; error or fails to update.===&lt;br /&gt;
Possible Cause: You didn&#039;t run the script which makes them!&lt;br /&gt;
&lt;br /&gt;
Solution: Run generate_views, and ideally set it up to run automatically: see &amp;quot;Browse Views&amp;quot; in the installation section.&lt;br /&gt;
&lt;br /&gt;
===Apache takes a really long time to start (over a minute) and so do the command line scripts.===&lt;br /&gt;
Possible Cause: EPrints loads several XML files at start up, and for some reason this requires a DNS lookup if DNS lookup is unavailable then it has to timeout.&lt;br /&gt;
&lt;br /&gt;
Solution: Make sure that the machine can perform DNS look-ups.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== The same page is repeatedly returned when submitting forms under Apache 2/mod_perl 2.0.0RC4 ===&lt;br /&gt;
&lt;br /&gt;
Ensure you have an up to date version of CGI (3.08+).&lt;br /&gt;
&lt;br /&gt;
=== A Note on SELinux ===&lt;br /&gt;
&lt;br /&gt;
Secure Linux (SELinux?) adds an additional security layer above that of Unix&#039;s U/G/O. By default RedHat installations prevent Apache from accessing files outside of /var/www/html and /tmp (and user&#039;s home directories?).&lt;br /&gt;
&lt;br /&gt;
If you run your EPrints Apache server as user eprints this isn&#039;t an issue, however if you run Apache as apache you will need to run:&lt;br /&gt;
&lt;br /&gt;
 chcon -R -t httpd_sys_content_t /opt/eprints2/&lt;br /&gt;
&lt;br /&gt;
To allow the apache process to access the eprints files (in addition to any Unix permission changes necessary).&lt;br /&gt;
&lt;br /&gt;
If you don&#039;t do this, you will not be able to start Apache after you have modified it to include the eprints Apache configuration files; it will give you error messages saying that it was unable to create certain files.&lt;br /&gt;
&lt;br /&gt;
(Ref. http://www.cavebear.com/cbblog-archives/000148.html)&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Troubleshooting&amp;diff=17583</id>
		<title>Troubleshooting</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Troubleshooting&amp;diff=17583"/>
		<updated>2026-10-16T09:55:09Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* (Under SuSE Linux) Apache has problems compiling the mod rewrite module */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
==Trouble Shooting==&lt;br /&gt;
This section covers some things which can go wrong and why. If you have a suggestion for this section, let us know!&lt;br /&gt;
&lt;br /&gt;
It will grow as people suggest new problems and solutions. Check the http://www.eprints.org/ website for the latest version.&lt;br /&gt;
&lt;br /&gt;
==Installation of EPrints and Required Software==&lt;br /&gt;
===Apache Crashes with a segmentation fault===&lt;br /&gt;
Possible cause: apache linked against &amp;quot;expat&amp;quot; library. If you did not install apache from source then it is possible it was linked against the &amp;quot;expat&amp;quot; library. The problem arrises that it is also linked against mod_perl and when we use the XML::Parser module, that is also linked against expat. 2 expat&#039;s in one apache make it seg-fault.&lt;br /&gt;
&lt;br /&gt;
===(Under SuSE Linux) Apache has problems compiling the mod rewrite module===&lt;br /&gt;
With an error something like:&lt;br /&gt;
 In file included from mod_rewrite.c:93:&lt;br /&gt;
 mod_rewrite.h:133: ndbm.h: No such file or directory&lt;br /&gt;
&lt;br /&gt;
Possible cause: Missing the ndbm library which is required (for some reason).&lt;br /&gt;
&lt;br /&gt;
Solution: It comes as part of gdbm which is free. If working from a package you need gdbm-devel to get the header files (.h files).&lt;br /&gt;
&lt;br /&gt;
=== (under debian sarge with apache2) Apache::const can&#039;t be located correctly when executing ./configure. ===&lt;br /&gt;
&lt;br /&gt;
Solution: execute&lt;br /&gt;
 export PERLLIB=/usr/lib/perl5/Apache2/&lt;br /&gt;
in a sh environment before ./configure.&lt;br /&gt;
&lt;br /&gt;
==Setting Up and Configuring a New Archive==&lt;br /&gt;
===System gives a &amp;quot;500 Internal Error&amp;quot; when viewing advanced search or submitting a document===&lt;br /&gt;
Possible cause: No Subjects, Bug in code.&lt;br /&gt;
&lt;br /&gt;
Solution: Run &#039;&#039;&#039;generate_subjects&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
If this fails: Look at your apache error log for clues. If reporting a bug, include the errors from the apache error log (often, but now always, found at &amp;lt;tt&amp;gt;/usr/local/apache/logs/error_log&amp;lt;/tt&amp;gt;)&lt;br /&gt;
&lt;br /&gt;
== MySQL ==&lt;br /&gt;
See [[Common MySQL Problems with EPrints]].&lt;br /&gt;
&lt;br /&gt;
==General==&lt;br /&gt;
Solution: Build apache following the detailed instructions in the &amp;quot;requried software&amp;quot; section of the documentation.&lt;br /&gt;
&lt;br /&gt;
===Changes to the configuration didn&#039;t appear on the website===&lt;br /&gt;
Possible cause: Several.&lt;br /&gt;
&lt;br /&gt;
Solution: Rebuild everything by re-running (for the archive in question) &#039;&#039;&#039;generate_static&#039;&#039;&#039;, &#039;&#039;&#039;generate_views&#039;&#039;&#039;, &#039;&#039;&#039;generate_apacheconf&#039;&#039;&#039; then stop and start apache. &#039;&#039;&#039;generate_abstracts&#039;&#039;&#039; can take a long time, so don&#039;t run it unless you want to update the abstracts themselves.&lt;br /&gt;
&lt;br /&gt;
===Browse View page gives a &amp;quot;404 not found&amp;quot; error or fails to update.===&lt;br /&gt;
Possible Cause: You didn&#039;t run the script which makes them!&lt;br /&gt;
&lt;br /&gt;
Solution: Run generate_views, and ideally set it up to run automatically: see &amp;quot;Browse Views&amp;quot; in the installation section.&lt;br /&gt;
&lt;br /&gt;
===Apache takes a really long time to start (over a minute) and so do the command line scripts.===&lt;br /&gt;
Possible Cause: EPrints loads several XML files at start up, and for some reason this requires a DNS lookup if DNS lookup is unavailable then it has to timeout.&lt;br /&gt;
&lt;br /&gt;
Solution: Make sure that the machine can perform DNS look-ups.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== The same page is repeatedly returned when submitting forms under Apache 2/mod_perl 2.0.0RC4 ===&lt;br /&gt;
&lt;br /&gt;
Ensure you have an up to date version of CGI (3.08+).&lt;br /&gt;
&lt;br /&gt;
=== A Note on SELinux ===&lt;br /&gt;
&lt;br /&gt;
Secure Linux (SELinux?) adds an additional security layer above that of Unix&#039;s U/G/O. By default RedHat installations prevent Apache from accessing files outside of /var/www/html and /tmp (and user&#039;s home directories?).&lt;br /&gt;
&lt;br /&gt;
If you run your EPrints Apache server as user eprints this isn&#039;t an issue, however if you run Apache as apache you will need to run:&lt;br /&gt;
&lt;br /&gt;
chcon -R -t httpd_sys_content_t /opt/eprints2/&lt;br /&gt;
&lt;br /&gt;
To allow the apache process to access the eprints files (in addition to any Unix permission changes necessary).&lt;br /&gt;
&lt;br /&gt;
If you don&#039;t do this, you will not be able to start Apache after you have modified it to include the eprints Apache configuration files; it will give you error messages saying that it was unable to create certain files.&lt;br /&gt;
&lt;br /&gt;
(Ref. http://www.cavebear.com/cbblog-archives/000148.html)&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=HTTPS2&amp;diff=17582</id>
		<title>HTTPS2</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=HTTPS2&amp;diff=17582"/>
		<updated>2026-10-14T10:13:09Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page HTTPS2 to Archive:HTTPS2: This is very old&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Archive:HTTPS2]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:HTTPS2&amp;diff=17581</id>
		<title>Archive:HTTPS2</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:HTTPS2&amp;diff=17581"/>
		<updated>2026-10-14T10:13:08Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page HTTPS2 to Archive:HTTPS2: This is very old&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Authentication]]&lt;br /&gt;
==Add HTTPS Settings==&lt;br /&gt;
&lt;br /&gt;
For each &amp;lt;tt&amp;gt;ARCHIVEID.xml&amp;lt;/tt&amp;gt; file, fill in the &amp;lt;tt&amp;gt;securehost&amp;lt;/tt&amp;gt; and &amp;lt;tt&amp;gt;securepath&amp;lt;/tt&amp;gt; entries.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;archive id=&amp;quot;demo&amp;quot;&amp;gt;&lt;br /&gt;
    ....&lt;br /&gt;
    &amp;lt;securehost&amp;gt;secure.mydomain.com&amp;lt;/securehost&amp;gt;&lt;br /&gt;
    &amp;lt;securepath&amp;gt;/demo&amp;lt;/securepath&amp;gt;&lt;br /&gt;
    ....&lt;br /&gt;
 &amp;lt;/archive&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;tt&amp;gt;securehost&amp;lt;/tt&amp;gt; is vhosted on the same server as your EPrints archive(s).&lt;br /&gt;
&lt;br /&gt;
Secure requests will be of the form &amp;lt;tt&amp;gt;https://securehost/securepath&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;tt&amp;gt;securepath&amp;lt;/tt&amp;gt; therefore differentiates requests from individual archives.&lt;br /&gt;
&lt;br /&gt;
==Generate Secure Config==&lt;br /&gt;
&lt;br /&gt;
 $ bin/generate_apacheconf&lt;br /&gt;
&lt;br /&gt;
As well as the usual apache configuration files, and depending on the version of EPrints, this will generate:&lt;br /&gt;
&lt;br /&gt;
* an &amp;lt;tt&amp;gt;auto-secure.conf&amp;lt;/tt&amp;gt; file in each archive&#039;s &amp;lt;tt&amp;gt;cfg&amp;lt;/tt&amp;gt; directory (2.3.13)&lt;br /&gt;
* an &amp;lt;tt&amp;gt;auto-your.secure.host.conf&amp;lt;/tt&amp;gt; file (for each secure host) in the main &amp;lt;tt&amp;gt;cfg&amp;lt;/tt&amp;gt; directory (2.3.11)&lt;br /&gt;
&lt;br /&gt;
==Set up Secure Host==&lt;br /&gt;
&lt;br /&gt;
Under Fedora Core 4, run:&lt;br /&gt;
&lt;br /&gt;
 $ yum install mod_ssl&lt;br /&gt;
&lt;br /&gt;
This sets up a test SSL server.&lt;br /&gt;
&lt;br /&gt;
===Certificates===&lt;br /&gt;
&lt;br /&gt;
For a production system, you would need to provide the relevant certificates and tweak the mod_ssl config accordingly - see: &lt;br /&gt;
&lt;br /&gt;
* [http://httpd.apache.org/docs/2.2/mod/mod_ssl.html Apache Module mod_ssl]&lt;br /&gt;
* [http://www.modssl.org/docs/2.8/ssl_faq.html mod_ssl FAQ]&lt;br /&gt;
&lt;br /&gt;
Create a &amp;lt;tt&amp;gt;server.key&amp;lt;/tt&amp;gt; on the EPrints server (remembering the passphrase you enter):&lt;br /&gt;
&lt;br /&gt;
 $ openssl genrsa -des3 -out server.key 1024&lt;br /&gt;
&lt;br /&gt;
Create a certificate request:&lt;br /&gt;
&lt;br /&gt;
 $ openssl req -new -key server.key -out server.csr&lt;br /&gt;
&lt;br /&gt;
The important thing when answering the questions is the CommonName: if ultimately the secure web address of your EPrints server is &amp;lt;tt&amp;gt;https://www.myeprints.com&amp;lt;/tt&amp;gt;, then the CommonName value to enter is exactly &amp;lt;tt&amp;gt;www.myeprints.com&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
Send the &amp;lt;tt&amp;gt;server.csr&amp;lt;/tt&amp;gt; file to your Certificate Authority administrator, who should send you back a &amp;lt;tt&amp;gt;.cer&amp;lt;/tt&amp;gt; file.&lt;br /&gt;
&lt;br /&gt;
Copy &amp;lt;tt&amp;gt;server.key&amp;lt;/tt&amp;gt; and the &amp;lt;tt&amp;gt;.cer&amp;lt;/tt&amp;gt; file to the following locations:&lt;br /&gt;
&lt;br /&gt;
 /etc/httpd/conf/ssl.key/server.key&lt;br /&gt;
 /etc/httpd/conf/ssl.crt/eprints.cer&lt;br /&gt;
&lt;br /&gt;
Modify &amp;lt;tt&amp;gt;/etc/httpd/conf.d/ssl.conf&amp;lt;/tt&amp;gt; accordingly:&lt;br /&gt;
&lt;br /&gt;
 SSLCertificateFile /etc/httpd/conf/ssl.crt/eprints.cer&lt;br /&gt;
 SSLCertificateKeyFile /etc/httpd/conf/ssl.key/server.key&lt;br /&gt;
&lt;br /&gt;
===Include EPrints SSL config===&lt;br /&gt;
&lt;br /&gt;
Include each &amp;lt;tt&amp;gt;auto-secure.conf&amp;lt;/tt&amp;gt; file generated by EPrints inside the &amp;lt;tt&amp;gt;Virtualhost&amp;lt;/tt&amp;gt; directive.&lt;br /&gt;
&lt;br /&gt;
On FC4, edit &amp;lt;tt&amp;gt;/etc/httpd/conf.d/ssl.conf&amp;lt;/tt&amp;gt;:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;VirtualHost _default_:443&amp;gt;&lt;br /&gt;
    ....&lt;br /&gt;
    Include /opt/eprints2/archives/ARCHIVEID/cfg/auto-secure.conf # 2.3.13&lt;br /&gt;
    Include /opt/eprints2/cfg/auto-your.secure.host.conf # 2.3.11&lt;br /&gt;
    Include /opt/eprints3/archives/soton/var/auto-secure.conf # 3.0.0&lt;br /&gt;
 &amp;lt;/VirtualHost&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If you have set up SSL certificates, you will be asked to enter your passphrase when you restart apache. To override this, see [http://www.modssl.org/docs/2.8/ssl_faq.html#remove-passphrase How can I get rid of the pass-phrase dialog at Apache startup time?].&lt;br /&gt;
&lt;br /&gt;
==Create Template for Secure Pages==&lt;br /&gt;
&lt;br /&gt;
Make a copy of the default template in &amp;lt;tt&amp;gt;archives/ARCHIVEID/cfg/lang/en/templates/&amp;lt;/tt&amp;gt;:&lt;br /&gt;
&lt;br /&gt;
 $ cp default.xml secure.xml&lt;br /&gt;
&lt;br /&gt;
In a multi-language archive, you would need to do this for each language-specific template (en = ENglish).&lt;br /&gt;
&lt;br /&gt;
It&#039;s a good idea to have a visual differentiation between secure and non-secure pages, e.g. edit &amp;lt;tt&amp;gt;secure.xml&amp;lt;/tt&amp;gt; and add &amp;quot;(SECURE)&amp;quot; to the title of the page.&lt;br /&gt;
&lt;br /&gt;
Some browsers will complain if images/CSS etc. embedded in a secure page are served by the non-secure host. To solve this modify the &amp;lt;tt&amp;gt;secure_urlpath&amp;lt;/tt&amp;gt; and &amp;lt;tt&amp;gt;secure_url&amp;lt;/tt&amp;gt; entries in &amp;lt;tt&amp;gt;archives/ARCHIVEID/cfg/cfg.d/20_baseurls.pl&amp;lt;/tt&amp;gt;:&lt;br /&gt;
&lt;br /&gt;
 $c-&amp;gt;{secure_urlpath} = &amp;quot;&amp;quot;;&lt;br /&gt;
 $c-&amp;gt;{secure_url} = &amp;quot;https://&amp;quot;.$c-&amp;gt;{securehost}.$c-&amp;gt;{securepath};&lt;br /&gt;
&lt;br /&gt;
In the &amp;lt;tt&amp;gt;secure.xml&amp;lt;/tt&amp;gt; template replace image/CSS &amp;lt;tt&amp;gt;base_url&amp;lt;/tt&amp;gt;s with &amp;lt;tt&amp;gt;secure_url&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
BUG FIX: In bin/generate_static replace &amp;lt;tt&amp;gt;import url($base_url$1);&amp;lt;/tt&amp;gt; with &amp;lt;tt&amp;gt;import url($1);&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
At the top of the page, replace the reference to &#039;&#039;&#039;/javascript/auto.js&#039;&#039;&#039; with &#039;&#039;&#039;/javascript/secure_auto.js&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
At the top of auto.js, there are the following 3 lines:&lt;br /&gt;
 var eprints_http_root = &amp;quot;http:\/\/myrepository.ac.uk&amp;quot;;&lt;br /&gt;
 var eprints_http_cgiroot = &amp;quot;http:\/\/myrepository.ac.uk\/cgi&amp;quot;;&lt;br /&gt;
 var eprints_oai_archive_id = &amp;quot;myrepository.ac.uk&amp;quot;;&lt;br /&gt;
... in secure_auto.js, these must start with &#039;https&#039; rather than just &#039;http&#039;.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Https3&amp;diff=17580</id>
		<title>Https3</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Https3&amp;diff=17580"/>
		<updated>2026-10-14T10:12:22Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page Https3 to Archive:Https3: This is very old&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Archive:Https3]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Https3&amp;diff=17579</id>
		<title>Archive:Https3</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Https3&amp;diff=17579"/>
		<updated>2026-10-14T10:12:22Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page Https3 to Archive:Https3: This is very old&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Authentication]]&lt;br /&gt;
== Introduction ==&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;EPrints 3.0.5/3.1 introduces a new mechanism to set up HTTPS that greatly simplifies the process, see [[HTTPS]].&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Setting up EPrints3 to work with https is a little tricky. There seems to be a few bugs to be worked round. This How To considers the following scenario:&lt;br /&gt;
&lt;br /&gt;
* Two repositories, repos1 and repos2, being served by virtual hosts repos1.FQDN:80 and repos2.FQDN:80&lt;br /&gt;
&lt;br /&gt;
* A single https domain, at eprints.FQDN:443 (so that only one certificate is needed). Secure pages for repos1 and repos2 will be accessed at eprints.FQDN:443/repos1 and eprints.FQDN:443/repos2 respectively.&lt;br /&gt;
&lt;br /&gt;
This How To should work with EPrints 3.0 or 3.0.1. It was developed on Ubuntu Server 6.06, but should work on other systems without significant changes. The instructions can be adapted for an arbitrary number of repositories.&lt;br /&gt;
&lt;br /&gt;
It is assumed that EPrints is installed in /opt/eprints3/.&lt;br /&gt;
&lt;br /&gt;
== Getting started ==&lt;br /&gt;
&lt;br /&gt;
Install EPrints 3.x following the appropriate instructions.&lt;br /&gt;
&lt;br /&gt;
Run bin/epadmin create twice to create repos1 and repos2.&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints3/archives/repos1/cfg/cfg.d/10_core.pl to read:&lt;br /&gt;
&lt;br /&gt;
  $c-&amp;gt;{host} = &#039;repos1.FQDN&#039;;&lt;br /&gt;
  $c-&amp;gt;{port} = 80;&lt;br /&gt;
  $c-&amp;gt;{aliases} = [];&lt;br /&gt;
  $c-&amp;gt;{securehost} = &#039;eprints.FQDN&#039;;&lt;br /&gt;
  $c-&amp;gt;{securepath} = &#039;/repos1&#039;;&lt;br /&gt;
  $c-&amp;gt;{secureport} = 443;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Make secure versions of the templates:&lt;br /&gt;
&lt;br /&gt;
  cp /opt/eprints3/archives/repos1/cfg/lang/en/templates/default.xml /opt/eprints3/archives/repos1/cfg/lang/en/templates/secure.xml&lt;br /&gt;
&lt;br /&gt;
Repeat these steps for repos2.&lt;br /&gt;
&lt;br /&gt;
Generate the Apache configuration:&lt;br /&gt;
&lt;br /&gt;
  /opt/eprints3/bin/generate_apacheconf&lt;br /&gt;
&lt;br /&gt;
Add &#039;Include /opt/eprints3/cfg/apache.conf&#039; to the Apache configuration (for Ubuntu / Debian, can replace everything in /etc/apache/sites-avaliable/default with &#039;Include /opt/eprints3/cfg/apache.conf&#039;). Apache should now be correctly configured to serve the non-secure pages.&lt;br /&gt;
&lt;br /&gt;
== Secure Apache Configuration ==&lt;br /&gt;
&lt;br /&gt;
Next, we want to configure Apache to serve the secure pages. However, generate_apacheconf hasn&#039;t created a secure.conf file in /opt/eprints3/cfg/ so this needs to be done manually. Some configuration has been generated for us in /opt/eprints3/archives/repos1/var/auto-secure.conf and /opt/eprints3/archives/repos2/var/auto-secure.conf, but there are some problems with this:&lt;br /&gt;
&lt;br /&gt;
* Some sections of the configuration overlap;&lt;br /&gt;
* The EPrints_ArchiveID and PerlSetVar EPrints_Secure variables have not been set.&lt;br /&gt;
&lt;br /&gt;
 We&#039;ll therefore create our own configuration. Create a new file called cfg/secure.conf:&lt;br /&gt;
&lt;br /&gt;
  #cfg/secure.conf:&lt;br /&gt;
  NameVirtualHost *:443&lt;br /&gt;
  &amp;lt;VirtualHost *:443&amp;gt;&lt;br /&gt;
    ServerAdmin itsupport@FQDN&lt;br /&gt;
    ServerName  eprints.FQDN&lt;br /&gt;
    &lt;br /&gt;
    SSLEngine On&lt;br /&gt;
    SSLCertificateFile /etc/apache2/ssl/apache.pem&lt;br /&gt;
    &lt;br /&gt;
    ErrorLog /var/log/apache2/error.log&lt;br /&gt;
    &lt;br /&gt;
    # Possible values include: debug, info, notice, warn, error, crit,&lt;br /&gt;
    # alert, emerg.&lt;br /&gt;
    LogLevel warn&lt;br /&gt;
    &lt;br /&gt;
    CustomLog /var/log/apache2/access.log combined&lt;br /&gt;
    ServerSignature On&lt;br /&gt;
    &lt;br /&gt;
   DocumentRoot &amp;quot;/var/www/eprints&amp;quot;&lt;br /&gt;
    &lt;br /&gt;
    &amp;lt;Directory &amp;quot;/opt/eprints3/cgi/users&amp;quot;&amp;gt;&lt;br /&gt;
      AuthName &amp;quot;User Area&amp;quot;&lt;br /&gt;
      AuthType &amp;quot;Basic&amp;quot;&lt;br /&gt;
      PerlAuthenHandler EPrints::Apache::Auth::authen&lt;br /&gt;
      PerlAuthzHandler EPrints::Apache::Auth::authz&lt;br /&gt;
      require valid-user&lt;br /&gt;
     &lt;br /&gt;
      SetHandler perl-script&lt;br /&gt;
      PerlHandler ModPerl::Registry&lt;br /&gt;
      PerlSendHeader Off&lt;br /&gt;
      Options ExecCGI FollowSymLinks&lt;br /&gt;
    &amp;lt;/Directory&amp;gt;&lt;br /&gt;
    &amp;lt;Directory &amp;quot;/opt/eprints3/cgi/users/awstats&amp;quot;&amp;gt;&lt;br /&gt;
      PerlSendHeader On&lt;br /&gt;
    &amp;lt;/Directory&amp;gt;&lt;br /&gt;
    &lt;br /&gt;
    &amp;lt;Directory &amp;quot;/opt/eprints3/cgi&amp;quot;&amp;gt;&lt;br /&gt;
      SetHandler perl-script&lt;br /&gt;
      PerlHandler ModPerl::Registry&lt;br /&gt;
      PerlSendHeader Off&lt;br /&gt;
      Options ExecCGI FollowSymLinks&lt;br /&gt;
    &amp;lt;/Directory&amp;gt;&lt;br /&gt;
    &lt;br /&gt;
    PerlTransHandler EPrints::Apache::Rewrite&lt;br /&gt;
    &lt;br /&gt;
    Include /opt/eprints3/archives/repos1/var/manual-secure.conf &lt;br /&gt;
    Include /opt/eprints3/archives/repos2/var/manual-secure.conf&lt;br /&gt;
  &amp;lt;/VirtualHost&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Not the line &#039;DocumentRoot &amp;quot;/var/www/eprints&amp;quot;&#039;. Create an index.html file in /var/www/eprints/ with a welcome message and links to the home pages of the repositories. Also note that we need to create a manual-secure.conf file for each repository. The contents of this file are as follows:&lt;br /&gt;
&lt;br /&gt;
  #/opt/eprints3/archives/repos1s/var/manual-secure.conf&lt;br /&gt;
  &lt;br /&gt;
  &amp;lt;Location &amp;quot;/repos1&amp;quot;&amp;gt;&lt;br /&gt;
    PerlSetVar EPrints_ArchiveID repos1&lt;br /&gt;
    PerlSetVar EPrints_Secure yes&lt;br /&gt;
    PerlSetVar EPrints_Dir_SecuredCGI /opt/eprints3/cgi/users&lt;br /&gt;
    PerlSetVar EPrints_Dir_Documents /opt/eprints3/archives/repos1/documents&lt;br /&gt;
    PerlLogHandler EPrints::Apache::LogHandler&lt;br /&gt;
  &amp;lt;/Location&amp;gt;&lt;br /&gt;
  &lt;br /&gt;
  Alias /repos1/cgi/accounts/confirm /opt/eprints3/cgi/confirm&lt;br /&gt;
  Alias /repos1/cgi/accounts/register /opt/eprints3/cgi/register&lt;br /&gt;
  Alias /repos1/cgi/accounts/reset_password /opt/eprints3/cgi/reset_password&lt;br /&gt;
  Alias /repos1/cgi/accounts/set_password /opt/eprints3/cgi/set_password&lt;br /&gt;
  Alias /repos1/cgi/users/ /opt/eprints3/cgi/users/&lt;br /&gt;
  Alias /repos1/ /opt/eprints3/archives/publications/html/&lt;br /&gt;
&lt;br /&gt;
For completeness, we&#039;ll also want to add the welcome page to http: Add the following lines to /opt/eprints3/cfg/apache.conf&lt;br /&gt;
&lt;br /&gt;
  &amp;lt;VirtualHost *:80&amp;gt;&lt;br /&gt;
    ServerName eprints.FQDN&lt;br /&gt;
    ServerAdmin itsupport@FQDN&lt;br /&gt;
    DocumentRoot &amp;quot;/var/www/eprints&amp;quot;&lt;br /&gt;
  &amp;lt;/VirtualHost&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Add &#039;Include /opt/eprints3/cfg/secure.conf&#039; to the Apache configuration.&lt;br /&gt;
&lt;br /&gt;
One thing remains. In /opt/eprints3/archives/repos1/cfg/cfg.d/misc.pl and /opt/eprints3/archives/repos2/cfg/cfg.d/misc.pl change the line&lt;br /&gt;
&lt;br /&gt;
  $c-&amp;gt;{cookie_domain} = $c-&amp;gt;{host}; &lt;br /&gt;
&lt;br /&gt;
to read&lt;br /&gt;
&lt;br /&gt;
  $c-&amp;gt;{cookie_domain} = $c-&amp;gt;{securehost}; &lt;br /&gt;
&lt;br /&gt;
Restart Apache. At this point it should be possible to access the repositories at http://publications.modhist.ox.ac.uk and http://oxhistonline.modhist.ox.ac.uk and log in to the secure area. &lt;br /&gt;
&lt;br /&gt;
=== Debian / Ubuntu specific SSL instructions ===&lt;br /&gt;
&lt;br /&gt;
Create a file called ssl in /etc/apache2/sites-available/ssl and add the line &#039;Include /opt/eprints3/cfg/secure.conf&#039;. Run the commands:&lt;br /&gt;
&lt;br /&gt;
  a2ensite ssl&lt;br /&gt;
  a2enmod ssl&lt;br /&gt;
  apache2-ssl-certificate&lt;br /&gt;
  echo &amp;quot;Listen 443&amp;quot; &amp;gt;&amp;gt; /etc/apache2/ports.conf&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== Bugs ==&lt;br /&gt;
&lt;br /&gt;
=== Broken Actions ===&lt;br /&gt;
&lt;br /&gt;
Links which call Perl cgi scripts are broken – e.g. Under Manage Deposits, click New Item. Select an Item Type and then click Next. You will be returned to the Manage Deposits page, rather than to the next step in the workflow. This appears to be because the form action is pointing to http://publications.modhist.ox.ac.uk/cgi/users/home#t rather than /publications/cgi/users/home. As far as I can see, this is a bug, rather than a configuration mistake, though I&#039;m happy to be advised otherwise.&lt;br /&gt;
&lt;br /&gt;
The workaround I have for this bug is to install patch 252, which can be downloaded from http://files.eprints.org/252/&lt;br /&gt;
&lt;br /&gt;
The patch seeks to resolve the problem by introducing a configuration variable users_url in 20_baseurls.pl. The use of perl_url has been replaced with users_url for all links to scripts in cgi/users. For insecure use, users_url can be set to perl_url. When https is requires, it can be adjusted appropriately.&lt;br /&gt;
&lt;br /&gt;
Apply the patch to the EPrints 3.x source (patch -d eprints-3.0/ -p0 &amp;lt; users-url.patch) and re-run configure and install.pl. Add the following lines to /opt/eprints3/archives/repos1/cfg/cfg.d/20_baseurls.pl :&lt;br /&gt;
&lt;br /&gt;
  $c-&amp;gt;{secure_urlpath} = $c-&amp;gt;{securepath};&lt;br /&gt;
  $c-&amp;gt;{secure_url} = &amp;quot;https://&amp;quot;.$c-&amp;gt;{securehost}.($c-&amp;gt;{secureport}!=443?&amp;quot;:&amp;quot;.$c-&amp;gt;{secureport}:&amp;quot;&amp;quot;).$c-&amp;gt;{secure_urlpath};&lt;br /&gt;
&lt;br /&gt;
  # Mod_perl scripts for users scripts&lt;br /&gt;
  # If not using https, make this the same as perl_url&lt;br /&gt;
  # Otherwise make it  $c-&amp;gt;{secure_url}.&amp;quot;/cgi&amp;quot;&lt;br /&gt;
  #$c-&amp;gt;{users_url} = $c-&amp;gt;{perl_url};&lt;br /&gt;
  $c-&amp;gt;{users_url} = $c-&amp;gt;{secure_url}.&amp;quot;/cgi&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
Similarly for /opt/eprints3/archives/repos2/cfg/cfg.d/20_baseurls.pl. Restart Apache. It should now be possible to upload documents, step through workflows etc.&lt;br /&gt;
&lt;br /&gt;
However, some bugs with image urls remain.&lt;br /&gt;
&lt;br /&gt;
=== Internet Explorer &#039;Secure and non Secure items&#039; ===&lt;br /&gt;
&lt;br /&gt;
We&#039;re not done yet! Internet Explorer complains if non-secure (http) and secure (https) items are displayed on the same page. This happens when a full url, beginning http:// is embedded in a page that is https. If the securepath and url_path variables were the same, e.g. we were using http://repos1.FQDN/repos1 and https://eprints.FQDN/repos1 then we could simply make all urls relative, but because they are different, e.g http://repos1.FQDN/ and https://eprints.FQDN/repos1 we must handle the secure and non-secure cases separately.&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints3/archives/repos1/cfg/lang/en/templates/secure.xml to use full https:// urls for included javascript and css and for the logo and .ico files. The head section should look something like this:&lt;br /&gt;
&lt;br /&gt;
  &amp;lt;head&amp;gt;&lt;br /&gt;
    &amp;lt;title&amp;gt;&amp;lt;epc:pin ref=&amp;quot;title&amp;quot; textonly=&amp;quot;yes&amp;quot;/&amp;gt; - &amp;lt;epc:phrase ref=&amp;quot;archive_name&amp;quot;/&amp;gt;&amp;lt;/title&amp;gt;&lt;br /&gt;
    &amp;lt;script src=&amp;quot;{$config{secure_url}}/javascript/auto.js&amp;quot; type=&amp;quot;text/javascript&amp;quot;&amp;gt;&amp;lt;!-- nope --&amp;gt;&amp;lt;/script&amp;gt;&lt;br /&gt;
    &amp;lt;style type=&amp;quot;text/css&amp;quot; media=&amp;quot;screen&amp;quot;&amp;gt;@import url(&amp;lt;epc:print expr=&amp;quot;$config{secure_url}&amp;quot;/&amp;gt;/style/secure_auto.css);&amp;lt;/style&amp;gt;&lt;br /&gt;
    &amp;lt;style type=&amp;quot;text/css&amp;quot; media=&amp;quot;print&amp;quot;&amp;gt;@import url(&amp;lt;epc:print expr=&amp;quot;$config{secure_url}&amp;quot;/&amp;gt;/style/print.css);&amp;lt;/style&amp;gt;&lt;br /&gt;
    &amp;lt;link rel=&amp;quot;icon&amp;quot; href=&amp;quot;{$config{secure_url}}/favicon.ico&amp;quot; type=&amp;quot;image/x-icon&amp;quot;/&amp;gt;&lt;br /&gt;
    &amp;lt;link rel=&amp;quot;shortcut icon&amp;quot; href=&amp;quot;{$config{secure_url}}/favicon.ico&amp;quot; type=&amp;quot;image/x-icon&amp;quot;/&amp;gt;&lt;br /&gt;
    &amp;lt;link rel=&amp;quot;Top&amp;quot; href=&amp;quot;{$config{frontpage}}&amp;quot;/&amp;gt;&lt;br /&gt;
    &amp;lt;link rel=&amp;quot;Search&amp;quot; href=&amp;quot;{$config{perl_url}}/search&amp;quot;/&amp;gt;&lt;br /&gt;
    &amp;lt;epc:pin ref=&amp;quot;head&amp;quot;/&amp;gt;&lt;br /&gt;
  &amp;lt;/head&amp;gt;&lt;br /&gt;
  &amp;lt;body bgcolor=&amp;quot;#ffffff&amp;quot; text=&amp;quot;#000000&amp;quot;&amp;gt;&lt;br /&gt;
  div class=&amp;quot;ep_noprint&amp;quot;&amp;gt;&lt;br /&gt;
  &amp;lt;noscript&amp;gt;&amp;lt;style type=&#039;text/css&#039;&amp;gt;@import url(&amp;lt;epc:print expr=&amp;quot;$config{secure_url}&amp;quot;/&amp;gt;/style/nojs.css);&amp;lt;/style&amp;gt;&amp;lt;/noscript&amp;gt;&lt;br /&gt;
  &amp;lt;/div&amp;gt;&lt;br /&gt;
  &amp;lt;epc:pin ref=&amp;quot;pagetop&amp;quot;/&amp;gt;&lt;br /&gt;
  div class=&amp;quot;ep_tm_header ep_noprint&amp;quot;&amp;gt;&lt;br /&gt;
  div class=&amp;quot;ep_tm_logo&amp;quot;&amp;gt;&amp;lt;a href=&amp;quot;{$config{frontpage}}&amp;quot;&amp;gt;&amp;lt;img alt=&amp;quot;Logo&amp;quot; src=&amp;quot;{$config{secure_url}}{$config{site_logo}}&amp;quot; /&amp;gt;&amp;lt;/a&amp;gt;&amp;lt;/div&amp;gt;&lt;br /&gt;
&lt;br /&gt;
also change the link to the EPrints logo in the footer:&lt;br /&gt;
&lt;br /&gt;
  &amp;lt;a href=&amp;quot;http://eprints.org/software/&amp;quot;&amp;gt;&amp;lt;img src=&amp;quot;{$config{secure_url}}/images/eprintslogo.gif&amp;quot; border=&amp;quot;0&amp;quot;/&amp;gt;&amp;lt;/a&amp;gt;&lt;br /&gt;
&lt;br /&gt;
We now need to modify &#039;generate_static&#039; to create the secure_auto.css file as well as auto.css. The relevant section should be modified like this:&lt;br /&gt;
&lt;br /&gt;
   # do the magic auto.js and auto.css&lt;br /&gt;
        my $js = &amp;quot;&amp;quot;;&lt;br /&gt;
        my $css = &amp;quot;&amp;quot;;&lt;br /&gt;
        my $secure_css =&amp;quot;&amp;quot;;&lt;br /&gt;
        my $fn;&lt;br /&gt;
        my $base_url = $session-&amp;gt;get_repository-&amp;gt;get_conf( &amp;quot;base_url&amp;quot; );&lt;br /&gt;
        my $secure_url =  $session-&amp;gt;get_repository-&amp;gt;get_conf( &amp;quot;secure_url&amp;quot; );&lt;br /&gt;
        foreach my $target ( sort keys %{$map} )&lt;br /&gt;
        {&lt;br /&gt;
                if( $target =~ m/(\/style\/auto\/.*\.css$)/ )&lt;br /&gt;
                {&lt;br /&gt;
                        $css .= &amp;quot;\@import url($base_url$1);\n&amp;quot;;&lt;br /&gt;
                        $secure_css .= &amp;quot;\@import url($secure_url$1);\n&amp;quot;;&lt;br /&gt;
                }       &lt;br /&gt;
                if( $target =~ m/(\/javascript\/auto\/.*\.js$)/ )&lt;br /&gt;
                {&lt;br /&gt;
                        $fn = $map-&amp;gt;{$target};&lt;br /&gt;
                        open( JS, $fn ) || EPrints::abort( &amp;quot;Can&#039;t read $fn: $!&amp;quot; );&lt;br /&gt;
                        $js .= &amp;quot;\n\n\n/* From: $fn */\n\n&amp;quot;;&lt;br /&gt;
                        $js .= join( &amp;quot;&amp;quot;, &amp;lt;JS&amp;gt; );&lt;br /&gt;
                        close JS;                        }        &lt;br /&gt;
        }&lt;br /&gt;
  &lt;br /&gt;
        $fn = &amp;quot;$base_target_dir/style/auto.css&amp;quot;;&lt;br /&gt;
        open( CSS, &amp;quot;&amp;gt;$fn&amp;quot; ) || EPrints::abort( &amp;quot;Can&#039;t write $fn: $!&amp;quot; );&lt;br /&gt;
        $wrote_files-&amp;gt;{$fn} = 1;&lt;br /&gt;
        print CSS $css;&lt;br /&gt;
        close CSS;&lt;br /&gt;
  &lt;br /&gt;
        $fn = &amp;quot;$base_target_dir/style/secure_auto.css&amp;quot;;&lt;br /&gt;
        open( CSS, &amp;quot;&amp;gt;$fn&amp;quot; ) || EPrints::abort( &amp;quot;Can&#039;t write $fn: $!&amp;quot; );&lt;br /&gt;
        $wrote_files-&amp;gt;{$fn} = 1;&lt;br /&gt;
        print CSS $secure_css;&lt;br /&gt;
        close CSS;&lt;br /&gt;
  &lt;br /&gt;
Re-run generate_static repos1.&lt;br /&gt;
&lt;br /&gt;
=== Missing Images ===&lt;br /&gt;
&lt;br /&gt;
A number of image links will be broken because eprints is looking for them on urlpath rather than on secureurl. In some cases this can be fixed by replacing urlpath with secureurl in the code, but some phrases may appear on both secure and insecure pages. Therefore we also need a solution which can be evaluated by a epin in a template. The cleanest way I could find of doing this is as follows:&lt;br /&gt;
&lt;br /&gt;
Add two methods to  EPrints::Session&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
  ######################################################################&lt;br /&gt;
  =pod&lt;br /&gt;
  &lt;br /&gt;
  =item $foo = $session-&amp;gt;get_baseurl()&lt;br /&gt;
  &lt;br /&gt;
  Gets the base url for images, depending on whether the session is secure&lt;br /&gt;
  or not (N.B. by secure we mean EPrints_secure is yes)&lt;br /&gt;
  Added by CSH 26 June 2007&lt;br /&gt;
  &lt;br /&gt;
  =cut&lt;br /&gt;
  ######################################################################&lt;br /&gt;
  sub get_baseurl&lt;br /&gt;
  {&lt;br /&gt;
  	my( $self ) = @_;&lt;br /&gt;
  	&lt;br /&gt;
  	my $esec = $self-&amp;gt;get_request-&amp;gt;dir_config( &amp;quot;EPrints_Secure&amp;quot; );&lt;br /&gt;
     	if( defined $esec &amp;amp;&amp;amp; $esec eq &amp;quot;yes&amp;quot; )&lt;br /&gt;
  	{&lt;br /&gt;
     		return $self-&amp;gt;get_repository-&amp;gt;get_conf( &amp;quot;securepath&amp;quot; );&lt;br /&gt;
   	}&lt;br /&gt;
   	else&lt;br /&gt;
   	{&lt;br /&gt;
   		return $self-&amp;gt;get_repository-&amp;gt;get_conf( &amp;quot;base_url&amp;quot; );&lt;br /&gt;
   	}		&lt;br /&gt;
  }&lt;br /&gt;
  &lt;br /&gt;
  ######################################################################&lt;br /&gt;
  =pod&lt;br /&gt;
   &lt;br /&gt;
  =item $foo = $session-&amp;gt;get_imageurl()&lt;br /&gt;
  &lt;br /&gt;
  Gets the base url for images, depending on whether the session is secure&lt;br /&gt;
  or not (N.B. by secure we mean EPrints_secure is yes)&lt;br /&gt;
  Added by CSH 26 June 2007&lt;br /&gt;
  &lt;br /&gt;
  =cut&lt;br /&gt;
  ######################################################################&lt;br /&gt;
  sub get_imageurl&lt;br /&gt;
  {&lt;br /&gt;
  	my( $self ) = @_;&lt;br /&gt;
  	&lt;br /&gt;
  	return $self-&amp;gt;get_baseurl.&amp;quot;/style/images/&amp;quot;;&lt;br /&gt;
  }  &lt;br /&gt;
&lt;br /&gt;
Search through the eprints code for every occurrence of the string /style/images/ and replace with a call to get_imageurl&lt;br /&gt;
&lt;br /&gt;
e.g. In /opt/eprints/perl_lib/EPrints/Plugin/Screen/Items.pm, change the line&lt;br /&gt;
&lt;br /&gt;
  my $imagesurl = $self-&amp;gt;{session}-&amp;gt;get_repository-&amp;gt;get_conf( &amp;quot;urlpath&amp;quot; ).&amp;quot;/style/images&amp;quot;;&lt;br /&gt;
&lt;br /&gt;
to&lt;br /&gt;
&lt;br /&gt;
  my $imagesurl = $self-&amp;gt;{session}-&amp;gt;get_imageurl;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
We will add a variable called baseurl to the variables available in a script:&lt;br /&gt;
&lt;br /&gt;
In the execute method of EPrints::Script, add:&lt;br /&gt;
&lt;br /&gt;
  $state-&amp;gt;{baseurl} = [$state-&amp;gt;{session}-&amp;gt;get_baseurl, &amp;quot;STRING&amp;quot; ];&lt;br /&gt;
&lt;br /&gt;
before the run command is called on the compiler. It will now be possible to get the url for images in a phrase through {$baseurl}&lt;br /&gt;
&lt;br /&gt;
In /opt/eprints3/lib/lang/en/phrases/system.xml, change the links to images in the following phrases to use $baseurl&lt;br /&gt;
&lt;br /&gt;
sys:ep_form_required&lt;br /&gt;
Plugin/InputForm/Surround/Default:show_help&lt;br /&gt;
Plugin/InputForm/Surround/Default:hide_help&lt;br /&gt;
lib/session:show_help&lt;br /&gt;
lib/session:hide_help&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
e.g. the ep_form_required phrase becomes:&lt;br /&gt;
&lt;br /&gt;
  &amp;lt;epp:phrase id=&amp;quot;sys:ep_form_required&amp;quot;&amp;gt;&amp;lt;img src=&amp;quot;{$baseurl}/style/images/required.png&amp;quot; border=&amp;quot;0&amp;quot; class=&amp;quot;ep_required&amp;quot; alt=&amp;quot;Required&amp;quot;/&amp;gt;&amp;amp;nbsp;&amp;lt;epc:pin name=&amp;quot;label&amp;quot;/&amp;gt;&amp;lt;/epp:phrase&amp;gt;&lt;br /&gt;
&lt;br /&gt;
If some repositories aren&#039;t using https, you may prefer to override these phrases on a per repository basis.&lt;br /&gt;
&lt;br /&gt;
== Troubleshooting ==&lt;br /&gt;
&lt;br /&gt;
Some common problems and solutions:&lt;br /&gt;
&lt;br /&gt;
=== File does not exist: /htdocs ===&lt;br /&gt;
&lt;br /&gt;
In the log file you may see messages like:&lt;br /&gt;
&lt;br /&gt;
File does not exist: /htdocs&lt;br /&gt;
&lt;br /&gt;
This may be generated by https pages with invalid links to images (e.g. /images instead of /repos1/images) if no DocumentRoot is set for the https virtual host. Note that if we  had only one repository per https address we could use DocumentRoot to point to DocumentRoot /opt/eprints3/archives/ARCHIVEID/html/en/ (as suggested by Peter Schober) but this wont work on a per repository base as you can’t put DocumentRoot in a Location block.&lt;br /&gt;
&lt;br /&gt;
=== EPrint 1 has no directory set ===&lt;br /&gt;
&lt;br /&gt;
If you get the message “EPrint 1 has no directory set. This is very dangerous as EPrints has no idea where to write files for this eprint. This may imply a buggy import tool or some other cause of corrupt data.”, it is most probably caused by the web server user having failed to create a target subdirectory for the new eprint under archives/archivename/documents/disk0/... due to insufficient file system permissions. Perhaps you forgot to set Apache to run as eprints:eprints (or alternatively, add the Apache user to the eprints group).&lt;br /&gt;
&lt;br /&gt;
=== Other ===&lt;br /&gt;
&lt;br /&gt;
Remember to check that the EPrints_Dir_SecuredCGI and EPrints_Dir_Documents variables  are set and cookie_domain is securehost not host.&lt;br /&gt;
&lt;br /&gt;
== Useful info ==&lt;br /&gt;
&lt;br /&gt;
You can set $imagesurl to be secure or insecure at runtime with some code like this (taken from MetaField.pm) &lt;br /&gt;
&lt;br /&gt;
  my $esec = $session-&amp;gt;get_request-&amp;gt;dir_config( &amp;quot;EPrints_Secure&amp;quot; );&lt;br /&gt;
  if( defined $esec &amp;amp;&amp;amp; $esec eq &amp;quot;yes&amp;quot; )&lt;br /&gt;
  {&lt;br /&gt;
    $imagesurl = $session-&amp;gt;get_repository-&amp;gt;get_conf( &amp;quot;securepath&amp;quot; ).&amp;quot;/style/images&amp;quot;;&lt;br /&gt;
  }&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=EPrints_Glossary&amp;diff=17578</id>
		<title>EPrints Glossary</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=EPrints_Glossary&amp;diff=17578"/>
		<updated>2026-10-14T09:06:52Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Latest tool */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{glossary}}&lt;br /&gt;
__NOTOC__&lt;br /&gt;
EPrints repository software uses a long list of terminology.  Sometimes this terminology overloads existing terminology in similar realms.  Other times different terms are used interchangeably to mean the same of similar things.  This glossary is intended to help clarify the various terminology you may come across whilst installing, configuring or using EPrints repository software.&lt;br /&gt;
&lt;br /&gt;
== A ==&lt;br /&gt;
=== Abstract page ===&lt;br /&gt;
An abstract page (sometimes referred to as a [[#Summary page|summary page]]) is a web page for an [[#Archive|archive]] providing [[#Metadata|metadata]] about a particular [[#EPrint|eprint]] (a.k.a [[#Publication record|publication record]]).  Most prominently it displays the abstract for the publication but also its title, [[#Citation|citation]] links to download associated [[#Document|documents]] and further metadata in a [[#Summary table|summary table]].&lt;br /&gt;
&lt;br /&gt;
Abstract pages are cached.  This cache is cleared when an eprint is modified.  Otherwise, these caches can be cleared, (so new cached version will be generated on next request), by running the following command or by clicking on the &amp;quot;[[Admin/System Tools/Regenerate Abstracts|Regenerate Abstracts]]&amp;quot; button in the [[#Admin menu|admin menu]]:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVEID&lt;br /&gt;
One or all abstracts pages can be regenerated by using the [[API:bin/generate_abstracts|bin/generate_abstracts]] command.&lt;br /&gt;
&lt;br /&gt;
=== Access ===&lt;br /&gt;
An [[Access Object|access]] is a [[#Data object|data object]] that represent a HTTP request accessing either an [[#Abstract page|abstract page]] or [[#Document|document]].&lt;br /&gt;
=== Actions tab ===&lt;br /&gt;
The actions tab appears on the [[#View page|view page]] for a [[#Data object|data object]].  However, typically the terms are used in the context of an [[#EPrint|eprint]].  This tab includes buttons to carry out various action against the data object.  For an eprint this may include:&lt;br /&gt;
* Depositing an item.&lt;br /&gt;
* Creating a new version (i.e. one that succeeds the current item).&lt;br /&gt;
* Using as a template to create a completely new item based on the current item.&lt;br /&gt;
* Editing an item.&lt;br /&gt;
* Removing an item (i.e. full deleting it from the [[#Archive|archive]]).  With or without a notification.&lt;br /&gt;
* Moving to the [[#Live archive|live archive]].&lt;br /&gt;
* Moving to the [[#Review buffer|review buffer]].&lt;br /&gt;
* Reindexing the item.&lt;br /&gt;
* Changing the [[#Depositing user|depositing user]] of the item.&lt;br /&gt;
* Exporting the item in one of various formats.&lt;br /&gt;
&lt;br /&gt;
=== Admin menu ===&lt;br /&gt;
The [[Admin|admin menu]] is only accessible to [[#Repository admin|repository admins]] that provides access to various administrative tools to manage their [[#Repository|repository]].&lt;br /&gt;
&lt;br /&gt;
=== Advanced search ===&lt;br /&gt;
An advanced search over [[#EPrint|eprints]] in the [[#Live archive|live archive]].  Unlike [[#Simple search|simple search]] this provides multiple input fields to individually search against particular [[#Metadata field|metadata fields]].  Advanced search configuration can be found in [[eprint_search_advanced.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Archive ===&lt;br /&gt;
Often conflated with [[#Repository| repository]].  [[#EPrints repository software|EPrints repository software]] provides a repository that can host multiple archives.  Commonly a repository will only host a single archive, so the terms are often used interchangeably.&lt;br /&gt;
&lt;br /&gt;
New archives can be created using the [[API:bin/epadmin|epadmin command]], as follows:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin create &amp;lt;zero|pub&amp;gt;&lt;br /&gt;
Where &amp;lt;tt&amp;gt;zero&amp;lt;/tt&amp;gt; is to create an archive with no [[#Flavour|flavour]] and &amp;lt;tt&amp;gt;pub&amp;lt;/tt&amp;gt; is to create an archive using the [[#Publication flavour|publication flavour]].  See [[Getting Started]] for more information.&lt;br /&gt;
&lt;br /&gt;
Content, configuration and sometimes code for an archive will be found at its [[#Archive level|archive level]], i.e.&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/&lt;br /&gt;
E.g. &amp;lt;tt&amp;gt;/opt/eprints3/archives/example/&amp;lt;/tt&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Archive ID ===&lt;br /&gt;
The ID of an [[#Archive|archive]].  This is set by the first input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  This will also be the directory name for the archive under [[#EPrints repository software|EPrints&#039;]] &#039;&#039;archives/&#039;&#039; sub-directory.   Guides on this wiki often use the placeholder &amp;lt;tt&amp;gt;ARCHIVEID&amp;lt;/tt&amp;gt;.&lt;br /&gt;
=== Archive level ===&lt;br /&gt;
This is a shorthand term to describe a configuration file that appears under the [[#Archive|archive]]&#039;s directory structure or to an effect that will only apply to a specific archive rather than the [[#Repository|repository]] as a whole, (which may have multiple archives). &lt;br /&gt;
=== Archive name ===&lt;br /&gt;
The name of an [[#Archive|archive]].  This is set by an early input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  Where the value set will be copied as a [[#Phrase|phrase]] to the archive&#039;s &#039;&#039;archive_name.xml&#039;&#039; under [[archives/ARCHIVEID/cfg/lang/en/phrases/]].&lt;br /&gt;
&lt;br /&gt;
== B ==&lt;br /&gt;
=== Back end pages ===&lt;br /&gt;
Same as [[#Management pages|management pages]].&lt;br /&gt;
&lt;br /&gt;
=== Bazaar ===&lt;br /&gt;
The [https://bazaar.eprints.org/ Bazaar] hosts EPrints packages of functionality ([[#EPM|EPMs]]), which can be installed on a [[#Repository|repository]] via the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] tool in the [[Admin]] web interface.&lt;br /&gt;
&lt;br /&gt;
=== Bazaar plugin ===&lt;br /&gt;
See [[#EPM|EPM]].&lt;br /&gt;
=== Box plugin ===&lt;br /&gt;
This is a type of [[#Plugin|plugin]] that generates a box containing some content or functionality, typically to be display at the top, bottom, left or right of an [[#EPrint|eprint]]&#039;s [[#Abstract page|abstract page]].  A common box plugin is the &#039;&#039;Tools&#039;&#039; plugin that typically appears at the top of abstract page provides the user with various export formats for the eprint.  [[#EPM|Bazaar plugins]] often include box plugins such as for [http://bazaar.eprints.org/555/ Altmetric] and the [http://bazaar.eprints.org/466/ CORE Recommender].&lt;br /&gt;
&lt;br /&gt;
=== Branding ===&lt;br /&gt;
Branding refers to the changing of the appearance of the web pages for your [[#Repository|repository]] or just a single [[#Archive|archive]].  Typically to line up with your institutional branding used on its other websites.  Advice is available on [[Branding with confidence]].  Branding is typically done by editing [[#Template|template]] configuration files and adding your own bespoke CSS, JavaScript and images/icons.  This can be done at an [[#Archive level|archive level]] of by creating a [[#Theme|theme]] so it can be applied to multiple archives hosted on the same repository.&lt;br /&gt;
&lt;br /&gt;
=== Browse view ===&lt;br /&gt;
A browse view is a collection of pages that display menus and listings of for all [[#Live archive|live archive]] [[#EPrint|eprints]] in an [[#Archive|archive]], organised by a particular [[#Metadata field|metadata field]]. By default these fields are: &#039;&#039;year&#039;&#039;, &#039;&#039;subjects&#039;&#039;, &#039;&#039;divisions&#039;&#039; and &#039;&#039;creators&#039;&#039;.&lt;br /&gt;
All the browse views can be found under the equivalent URL for archive to the following:&lt;br /&gt;
 https://example.eprints.org/view/&lt;br /&gt;
The configuration for browse views can be found in [[views.pl]], which by default is found under [[flavours/pub_lib/cfg.d/]] but should be copied to the archive&#039;s &#039;&#039;cfg/cfg.d/&#039;&#039; for editing.  See [[:Category:Browse_Views|browse views category]] for more information.&lt;br /&gt;
&lt;br /&gt;
Browse view pages are cached for a set period of time, by default 24 hours. However, these caches can be cleared earlier, (so new cached version will be generated on next request), by running the following command or by clicking on the &amp;quot;[[Admin/System Tools/Regenerate Views|Regenerate Views]]&amp;quot; button in the [[#Admin menu|admin menu]]:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin refresh_views ARCHIVEID&lt;br /&gt;
One, some or all browse views can be regenerated by using the [[API:bin/generate_views|bin/generate_views]] command.  Often these used as a cron job (i.e. scheduled task) so browse views caches can be updated overnight, when the server hosting the archive is less busy.&lt;br /&gt;
&lt;br /&gt;
=== Buffer ===&lt;br /&gt;
Shorthand for [[#Review buffer|Review buffer]].&lt;br /&gt;
&lt;br /&gt;
== C ==&lt;br /&gt;
=== Citation ===&lt;br /&gt;
In [[#EPrints repository software|EPrints repository software]] a citation means something slightly different from what it means in research publication.  For the former it refers to a text string describing a publication, which may more commonly described in research publications as a &#039;&#039;reference&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
EPrints repository software has citation style files, which describe how to generate the text string, not just for [[#EPrint|eprints]] but also other [[#Data object|data objects]], each of which can have different citation style files for different purposes.  These files can be found under [[lib/citations/]], [[flavours/pub_lib/citations/]] and the [[#Archive|archive]]&#039;s &#039;&#039;cfg/citations/&#039;&#039; directory.  &lt;br /&gt;
&lt;br /&gt;
See here for more information about the [[Citation Format|citation formats]] and a training video about [[Training_Video:Citation_Styles|citation styles]].&lt;br /&gt;
&lt;br /&gt;
=== Compound metadata field ===&lt;br /&gt;
A [[Compound field|Compound metadata field]] is a type of [[#Metadata field|metadata field]] that is made up of several sub-fields.  A good example of this is the &#039;&#039;Relationships&#039;&#039; field for an [[#EPrint|eprint]] [[#Data object|data object]].  This has two sub-fields one for the type or relation and the second for the actual thing (represented by a URI), that the eprint is related.&lt;br /&gt;
&lt;br /&gt;
=== Core codebase ===&lt;br /&gt;
The core codebase refers to the main code directories of the [[#EPrints repository software|EPrints repository software]].  In some contexts this refers to all directories except the archives directory which contains the configuration for individual [[#Archive|archives]].  In other contexts this refers to just the following directories (i.e. excludes [[#Flavour|flavours]], [[#Ingredient|ingredients]] and [[#Site lib|site_lib]], as well as non-code directories).&lt;br /&gt;
* [[bin/]]&lt;br /&gt;
* [[cgi/]]&lt;br /&gt;
* [[lib/]]&lt;br /&gt;
* [[perl_lib/]]&lt;br /&gt;
* [[tools/]]&lt;br /&gt;
&lt;br /&gt;
=== Core field ===&lt;br /&gt;
Same as a [[#System field|system field]].&lt;br /&gt;
&lt;br /&gt;
=== Contact page ===&lt;br /&gt;
This is a [[#Static page|static page]] that is accessible on an [[#Archive|archive]] at the equivalent URL to the following:&lt;br /&gt;
 https://example.eprints.org/contact.html&lt;br /&gt;
This page is intended to provided contact information, so to those accessing the archive can contact those responsible for it to report problems or ask questions.&lt;br /&gt;
&lt;br /&gt;
This page can be found at &#039;&#039;EPRINTS_PATH/lib/lang/en/static/contact.xpage&#039;&#039; but should be copied to the archive&#039;s &#039;&#039;cfg/lang/en/static/&#039;&#039; directory for [[How_to_modify_static_pages|editing]].  The email address displayed on this page comes from the &amp;lt;tt&amp;gt;$c-&amp;gt;{adminemail}&amp;lt;/tt&amp;gt; in [[adminemail.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Contributor ===&lt;br /&gt;
Sometimes an [[#EPrint|eprint]] has a contributor who could not usefully be described as a [[#Creator|creator]] or [[#Editor|editor]].  The contributor [[#Metadata field|metadata field]] is intended to allow these people to be associated with the eprint.  As well as being able to add the contributor&#039;s family and given name, the type of contributor can be specified.  This list of types is defined in &#039;&#039;EPRINTS_PATH/lib/namedsets/contributor_type&#039;&#039;.  If additional types are needed, then this file should be copied to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/namedsets/&#039;&#039; directory for editing.&lt;br /&gt;
&lt;br /&gt;
=== Creator ===&lt;br /&gt;
Creator (or creators) is a [[#Metadata field|metadata field]] for an [[#EPrint|eprint]].  Sometimes this is alternatively referred to as author but creator is a more generic term better suited to audio-visual/artistic as well as more traditional research publication items.&lt;br /&gt;
&lt;br /&gt;
A creator typically has several separate sub-fields:&lt;br /&gt;
* Given name (a.k.a. first name)&lt;br /&gt;
* Family name (a.k.a. surname)&lt;br /&gt;
* ID (typically email address)&lt;br /&gt;
&lt;br /&gt;
=== CRUD API ===&lt;br /&gt;
CRUD API (Create, Read, Update Delete Application Programming Interface) refers to a programmatic interface used for the management of [[#Data object|data objects]].  It is often also referred to as the [[#REST API|REST API]] as when it is called over HTTP it meets the requirements of a REST API.&lt;br /&gt;
&lt;br /&gt;
== D ==&lt;br /&gt;
=== Data flavour ===&lt;br /&gt;
As of [[#EPrints repository software|EPrints]] [https://www.eprints.org/uk/index.php/eprints-3.4/ 3.4] there are different flavours to service different purposes for a [[#Repository|repository]].  The data flavour is intended for repository hosted research data items, as opposed to research publications.&lt;br /&gt;
&lt;br /&gt;
=== Data object ===&lt;br /&gt;
A [[:Category:Data Objects|data object]] is a single record made up of [[#Metadata field|metadata fields]]. [[#EPrints repository software|EPrints repository software]] has various types of data object.  The most prominent are:&lt;br /&gt;
* [[EPrint Object]]&lt;br /&gt;
* [[User Object]]&lt;br /&gt;
* [[Document Object]]&lt;br /&gt;
* [[File Object]]&lt;br /&gt;
All the data objects of the same type make a [[#Dataset|dataset]].&lt;br /&gt;
&lt;br /&gt;
=== Dataset ===&lt;br /&gt;
A [[API:EPrints/DataSet|dataset]] is all the [[#Data object|data objects]] of a particular type within a single repository. (E.g. [[#EPrint|eprint]], [[#User|user]], [[#Document|document]], etc.).  [[#Virtual dataset|Virtual datasets]] exist for subsets of datasets such as [[#Live archive|live archive]], [[#Review buffer|review buffer]], etc.&lt;br /&gt;
&lt;br /&gt;
=== Depositing user ===&lt;br /&gt;
This is the user who created the [[#EPrint|eprint]] and has deposited it to the [[#Review buffer|review buffer]].&lt;br /&gt;
&lt;br /&gt;
=== Details tab ===&lt;br /&gt;
This is a tab in a [[#Data object|data object]]&#039;s [[#View page|view page]] that lists all its [[#Metadata field|metadata fields]] and their values.  Where a [[#Workflow|workflow]] exists for the data objects these metadata fields are separated into separate sections, depending on the [[#Workflow stage|workflow stage]] in which they appear.&lt;br /&gt;
&lt;br /&gt;
=== Division ===&lt;br /&gt;
This is a generic term to refer to a part of an organisation or institution, at any level of its hierarchy.  A division may be a faculty, school, department, academic unit or even research group.  If [[#EPrints repository software|EPrints repository software]] is used outside an academic context other names for sub-divisions may be applicable.&lt;br /&gt;
&lt;br /&gt;
Divisions is a default [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]].  It allows one or more divisions to be selected from a hierarchical list provided by the [[#Archive|archive]]&#039;s [[#Subject tree|subject tree]].  This can in turn be used to generate a [[#Browse view|browse view]] for divisions.&lt;br /&gt;
&lt;br /&gt;
=== Document ===&lt;br /&gt;
A [[Document Object|document]] is a [[#Second class data object|second class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]].  Documents must be part of an [[#EPrint|eprint]] object.  Sometimes the term is used interchangeably with the actual document file (e.g. a PDF, Word document, etc.).  To avoid confusion, it is best to refer to a document within EPrints as a &amp;quot;document object&amp;quot;.  A document object can be associated with multiple [[#File|file objects]].  Typically because derived files are generated to provide [[#Preview image|preview and thumbnail images]] but also because multiple files can be uploaded for a single document object.&lt;br /&gt;
&lt;br /&gt;
=== Document content ===&lt;br /&gt;
Document content is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It allows selections of a single value from a pre-defined list (i.e. a [[#Named set|named set]]) metadata field.  The options provided are intended to help describe the version of the document (e.g. draft, submitted version, accepted, updated) within the publication lifecycle or other types of content that may be uploaded (e.g. supplemental, presentation, cover image, metadata, bibliography, other).  These are based on the [http://eprints.lse.ac.uk/64948/1/LSE%20Library_Versions%20toolkit_Author_2008.pdf Versions toolkit for authors] but are analogous to other definitions, such as:&lt;br /&gt;
* Author&#039;s Original Manuscript (AOM) is equivalent to submitted.&lt;br /&gt;
* Accepted Manuscript (AM) is equivalent to accepted.&lt;br /&gt;
* Version of Record (VoR) is equivalent to published.&lt;br /&gt;
&lt;br /&gt;
=== Document security ===&lt;br /&gt;
Document security is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It defines who can access document file and any files in derived document objects (e.g. [[#Preview image|preview images]]).  By default this is one of three values:&lt;br /&gt;
* public - anyone&lt;br /&gt;
* validuser - registered [[#User|users]] (for the [[#Archive|archive]]) only.&lt;br /&gt;
* staffonly - repository staff (i.e. [[#Editor|editor]] and [[#Repository admin|repository administrator]] users) only.&lt;br /&gt;
If one of the last two option is applied with an [[#Embargo|embargo]] that expires on a certain date, then the security value for that document will be updated to &#039;&#039;public&#039;&#039; on that date.&lt;br /&gt;
&lt;br /&gt;
=== Documents directory ===&lt;br /&gt;
This is a directory found under the [[#Archive|archive&#039;s]] directory structure, (i.e. &#039;&#039;EPRINTS_PATH/archives/ARCHIVEID/documents/&#039;&#039;).  This is where the uploaded [[#Document|documents]] for an [[#EPrint|eprint]] are stored under the latter&#039;s own sub-directory (e.g. eprint 1234 has documents sub-directory &#039;&#039;documents/00/00/12/34/&#039;&#039;). Each document is stored in its own two-digit sub-directory based on its &#039;&#039;pos&#039;&#039; [[#Metadata field|metadata field]], which is zero-padded if the number is less than 10. The sub-directory also stores derived &amp;quot;documents&amp;quot; for those uploaded (e.g. preview and thumbnail images).  It also stores [[#Revision file|revision files]] in the eprint&#039;s own &#039;&#039;revisions&#039;&#039; sub-directory.&lt;br /&gt;
&lt;br /&gt;
=== Dynamic Pages ===&lt;br /&gt;
Dynamic pages are pages that are generated each time the page is loaded. The most common example of this is the search pages, another example is the [[#Latest tool | Latest tool]] page. Plugins may add additional pages, eg: irstats2 adds dynamic stats page.&lt;br /&gt;
&lt;br /&gt;
== E ==&lt;br /&gt;
=== Editor ===&lt;br /&gt;
On [[#EPrints repository software|EPrints repository software]] &#039;&#039;&#039;editor&#039;&#039;&#039; could refer to one of two different things:&lt;br /&gt;
# A type of EPrints [[#User|user]] that has permissions to access some or all [[#Publication record|publication records]] in the [[#Review buffer|review buffer]] to make amendments and either push the item to the [[#Live archive|live archive]] or return it to the [[#User workarea|user&#039;s workarea]].&lt;br /&gt;
# A [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]] to record editors of the publication, e.g. the editors for a book.  Like [[#Creator|creator]], by default this field has family name, given name and ID (i.e. email address) sub-fields.&lt;br /&gt;
&lt;br /&gt;
=== Editorial rights restriction ===&lt;br /&gt;
Same as [[#User review scope|user review scope]].&lt;br /&gt;
&lt;br /&gt;
=== Education flavour ===&lt;br /&gt;
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+. It is intended to produce repositories for open education.  I.e. for hosting files such as presentation slides, videos of lectures/seminars, instructions for learning tasks, in-class quizzes, etc.&lt;br /&gt;
&lt;br /&gt;
=== Embargo ===&lt;br /&gt;
[[#Document|Documents]] added to an [[#EPrint|eprint]] can have their access restricted.  Sometimes, this access need only be restricted for a set amount of time.  These documents can be embargoed until a set embargo date.  These can then be lifted of this date using the [[API:bin/lift_embargos|bin/lift_embargos]] script.  More recently embargoes allow a reason to be chosen from a predetermined set of options provided by the &#039;&#039;embargo_reason&#039;&#039; [[#Named set|named set]].&lt;br /&gt;
&lt;br /&gt;
=== EPM ===&lt;br /&gt;
EPM (EPrints Package Manager) is a package of functionality, sometimes referred to as a &#039;&#039;Bazaar plugin&#039;&#039;, which can be installed in an automated fashion, typically from the [[#Bazaar|Bazaar]].  It can sometimes refer to the pages for managing the installing of these packages, (e.g. the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] page available through the [[Admin]] web interface).&lt;br /&gt;
&lt;br /&gt;
=== EPrint ===&lt;br /&gt;
An [[EPrint Object|eprint]] is a [[#First class data object|first class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]]. These are often referred to as &#039;&#039;[[#Item|items]]&#039;&#039; or &#039;&#039;[[#Publication record|publication records]]&#039;&#039; as they are generally intended hold [[#Metadata|metadata]] about a publication of some kind.&lt;br /&gt;
&lt;br /&gt;
=== EPrint control page ===&lt;br /&gt;
Same as an [[#EPrint view page|eprint view page]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint history ===&lt;br /&gt;
This is the history of an [[#EPrint|eprint]] shown in the [[#History tab|history tab]] of the eprint&#039;s [[#View page|view page]].  It is generated from the [[#EPrint revision|eprint revision]] [[#Revision file|files]] generated each time an eprint is modified.  These are compared to display differences between revisions to track the eprint&#039;s history for administration purposes.&lt;br /&gt;
&lt;br /&gt;
=== EPrint locking ===&lt;br /&gt;
Whilst a [[#User|user]] is editing an [[#EPrint|eprint]] it is best that another user does not try to edit it as well.  When an eprint is locked, even permitted users will not be able to edit that record, unless they remove the edit lock.  Locks are automatically released when a user saves or cancels editing an eprint or (by default) 1 hour after the user started editing the eprint.&lt;br /&gt;
&lt;br /&gt;
=== EPrint revision ===&lt;br /&gt;
An EPrint revision is a numbered version of the [[#EPrint|eprint&#039;s]] [[#Metadata|metadata]] stored in the &#039;&#039;rev_number&#039;&#039; [[#Metadata field|metadata field]].  Revisions of eprints metadata are exported as XML [[#Revision file|revision files]] and stored under the [[#Documents directory|documents directory]] of the [[#Archive|archive]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint status ===&lt;br /&gt;
The status of an [[#EPrint|eprint]] represent the stage it is in the depositing lifecycle.  By default in [[#EPrints repository software|EPrints repository software]] this can be one of four states:&lt;br /&gt;
# [[#User workarea|User workarea]] - The eprint is still being edited by the [[#Depositing user|depositing user]] as there is still metadata they need to add or change.&lt;br /&gt;
# [[#Review buffer|Review buffer]] - The eprint has been submitted for review by an [[#Editor|editor]] for the [[#Archive|archive]].&lt;br /&gt;
# [[#Live archive|Live archive]] - The eprint has been reviewed by the editor and they have deposited it into the live archive for public access.&lt;br /&gt;
# [[#Retired|Retired]] - The eprint has been removed from the live archive as it is no longer appropriate for it to have public access.&lt;br /&gt;
&lt;br /&gt;
=== EPrint type ===&lt;br /&gt;
This is the type of publication the [[#EPrint|eprint]] represents.  The available types for a [[#Repository|repository]] are specified in a [[#Named set|named sets]] file. ( &#039;&#039;lib/namedsets/eprint&#039;&#039; or &#039;&#039;flavours/pub_lib/namedsets/eprint&#039;&#039;) or can be copied to the [[#Archive|archive]]&#039;s [[archives/ARCHIVEID/cfg/namedsets/]] directory to add extra types for a specific archive.  By default [[#EPrints repository software|EPrints]]&#039; [[#Publication flavour|publication flavour]] has the following type options:&lt;br /&gt;
 article&lt;br /&gt;
 book_section&lt;br /&gt;
 monograph&lt;br /&gt;
 conference_item&lt;br /&gt;
 book&lt;br /&gt;
 thesis&lt;br /&gt;
 patent&lt;br /&gt;
 artefact&lt;br /&gt;
 exhibition&lt;br /&gt;
 composition&lt;br /&gt;
 performance&lt;br /&gt;
 image&lt;br /&gt;
 video&lt;br /&gt;
 audio&lt;br /&gt;
 dataset&lt;br /&gt;
 experiment&lt;br /&gt;
 teaching_resource&lt;br /&gt;
 other&lt;br /&gt;
Type is by default presented on the first [[#Workflow stage|stage]] of the [[#EPrint workflow|EPrint workflow]], as the option chosen will affect the fields that can/need to be completed in later stages.&lt;br /&gt;
&lt;br /&gt;
=== EPrint URI ===&lt;br /&gt;
The URI for an [[#EPrint|eprint]] is its globally unique identifier.  In a form like:&lt;br /&gt;
 http://example.eprints.org/id/eprint/1234&lt;br /&gt;
Technically, a URI only need be an identifier and therefore not return the resource itself.  However, in the case of [[#EPrints repository software|EPrints repository software]], this will return the resource.  Prior to EPrints 3.4, this would be by redirecting to the [[#EPrint URL|eprint URL]] but since then the [[#Publication flavour|publication flavour]] uses the same string for the eprints URL and URI with the old style URL redirecting the longer URI format URL.&lt;br /&gt;
&lt;br /&gt;
=== EPrint URL ===&lt;br /&gt;
The URL of an [[#EPrint|eprint]] is the location it can be found at on the World Wide Web.  Historically with [[#EPrints repository software|EPrints repository software] it has taken a form like:&lt;br /&gt;
 http://example.eprints.org/1234/&lt;br /&gt;
However, since EPrints 3.4, it has been possible to configure the URL to take a long format like that of the [[#EPrint URI|eprint URI]]:&lt;br /&gt;
 http://example.eprints.org/id/eprint/1234&lt;br /&gt;
By using the following setting (typically in the [[#Archive|archive]]&#039;s &#039;&#039;cfg/cfg.d/[[20_baseurls.pl]]&#039;&#039;): &lt;br /&gt;
 $c-&amp;gt;{use_long_url_format] = 1;&lt;br /&gt;
By making this change the old style URL will still work but will redirect to the new format.  The reason for the change was to make it more apparent that the URL represented a publication within EPrints repository.  Web crawlers and bots often record links (i.e. URLs) they find on web pages but they don&#039;t actually access them.  In particular [https://scholar.google.com Google Scholar] would disregard these URLs without checking them, as there was nothing from the URL to indicate they represented a publication.  By adding &#039;&#039;/id/eprint/&#039;&#039; into the URL it makes it the URL distinct from other common URLs of the form &#039;&#039;&amp;lt;nowiki&amp;gt;http://HOSTNAME/ID&amp;lt;/nowiki&amp;gt;&#039;&#039;, which are mostly not URLs for EPrints [[#Abstract page|abstract pages]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint view page ===&lt;br /&gt;
The view page for an [[#EPrint|eprint]] is a multi-tabbed management page for that particular item.  It can typically be reached by clicking on the &#039;&#039;View Item&#039;&#039; link towards the bottom of an eprint&#039;s [[#Abstract page|abstract page]].  This page will tend to have the following tabs:&lt;br /&gt;
# [[#Preview tab|Preview]] - What will the abstract page look like when the eprint is moved to the [[#Live archive|live archive]].&lt;br /&gt;
# [[#Details tab|Details]] - The values for all the [[#Metadata field|metadata fields]] for the eprint.&lt;br /&gt;
# [[#Actions tab|Actions]] - All the actions that can be carried out against the eprint.&lt;br /&gt;
# [[#History tab|History]] - The [[#EPrint revision|revision]] history of the eprint.&lt;br /&gt;
# [[#Issues tab|Issues]] - The [[#Issue|issues]] detected for this eprint, if any.&lt;br /&gt;
&lt;br /&gt;
=== EPrint workflow ===&lt;br /&gt;
This is the [[#Workflow|workflow]] that pertains specifically to the [[EPrint Object|eprint data object]].&lt;br /&gt;
&lt;br /&gt;
=== EPrints repository software ===&lt;br /&gt;
Often shortened to just &#039;&#039;&#039;EPrints&#039;&#039;&#039; but not to be confused with multiple eprint data objects, (i.e. eprints). The actual software that can be used to create Open Access repositories and available as Open Source from [https://github.com/eprints/eprints3.4 GitHub].&lt;br /&gt;
&lt;br /&gt;
=== EPrints path ===&lt;br /&gt;
The path on your operating system under which EPrints repository software is installed.  Guides on this wiki often use the placeholder &amp;lt;tt&amp;gt;EPRINTS_PATH&amp;lt;/tt&amp;gt; to represent this.  Typically EPrints path will either be &#039;&#039;&#039;/opt/eprints3/&#039;&#039;&#039; or &#039;&#039;&#039;/usr/share/eprints/&#039;&#039;&#039; depending on how EPrints repository software was installed.&lt;br /&gt;
&lt;br /&gt;
=== EPrints release ===&lt;br /&gt;
A release of the [[#EPrints repository software|EPrints repository software]].&lt;br /&gt;
&lt;br /&gt;
=== EPrints version ===&lt;br /&gt;
Same as [[#EPrints release|EPrints release]] but with specific reference to a version number.&lt;br /&gt;
&lt;br /&gt;
=== EPrints XML ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] has its own XML schema for defining how [[#Data object|data objects]] should be described.  This schema can be found at the equivalent URL to:&lt;br /&gt;
 http://example.eprints.org/cgi/schema&lt;br /&gt;
&lt;br /&gt;
=== Event plugin ===&lt;br /&gt;
A type of [[#Plugin|plugin]] that generates [[#Indexer task|Indexer tasks]] to get the [[#Indexer|indexer]] to perform some asynchronous and potential long-running task.&lt;br /&gt;
&lt;br /&gt;
=== Event queue ===&lt;br /&gt;
The event queue contains all generated and yet to be successfully completed [[#Indexer task|indexer tasks]].  It can be accessed through the [[#Admin menu|admin menu]]&#039;s [[Admin/System Tools|System tools]] tab using the [[Admin/System Tools/Status|Status]] button and then clicking on the number next to the &#039;&#039;&#039;Background Task Queue&#039;&#039;&#039;.  There is also the [[Event Queue Object]], which is a [[#Data object|data object]] to represent an individual indexer task.&lt;br /&gt;
&lt;br /&gt;
=== Export plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a formatted export of a [[#Data object|data object]]&#039;s [[#Metadata|metadata]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository software]] has export plugins for many different formats, which can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Export/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/Export/]]&#039;&#039; directories.  Bespoke export plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Export/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Export/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
== F ==&lt;br /&gt;
=== File ===&lt;br /&gt;
A file is a [[#Third class data object|third class]] [[#Data object|data object]].  This is because it is a [[#Sub-object|sub-object]] of a [[#Document|document]] data object, which in turn is a sub-object of an [[#EPrint|eprint]] data object.  A file data object store metadata relevant to the file such as its filename, size, MIME type and modified time and a hash (by default MD5) to maintain the integrity of the file.  Typically uploading a document to an eprint will only create a single data object but it is possible to add additional files to a document after it is uploaded.&lt;br /&gt;
&lt;br /&gt;
File data objects are also used to capture XML [[#Revision file|revision files]] created for recording [[#EPrint revision|eprint revisions]].&lt;br /&gt;
&lt;br /&gt;
=== First class data object ===&lt;br /&gt;
[[#Data object|Data objects]] in [[#EPrints repository software|EPrints repository software]] take a particular order.  First class data objects are those that are not a sub-objects of other data objects, such as:&lt;br /&gt;
* [[#EPrint|eprint]]&lt;br /&gt;
* [[#User|user]]&lt;br /&gt;
Other data object may be described as either [[#Second class data object|second class]] or [[#Third class data object|third class]].  Usually a data object is only described as &amp;quot;first class&amp;quot; if it contains sub-objects.  Technically, [[#Subject|subject]] is a first class data object but as it contains no sub-objects, it in unnecessary to make the distinction.&lt;br /&gt;
&lt;br /&gt;
=== Flavour ===&lt;br /&gt;
From version 3.4 of [[#EPrints repository software|EPrints repository software]] different flavours have been introduced.  EPrints was originally designed as a [[#Repository|repository]] for research publications but over the years it has been repurposed for different tasks, which has led to the codebase getting a little messy.  So in [https://www.eprints.org/uk/index.php/eprints-3.4/ EPrints 3.4] a separate sub-directory structure was created to store code and configuration that makes EPrints suitable for a particular task, (i.e. a flavour).  There are three main flavours but most development has continued to focus on research publication:&lt;br /&gt;
# [[#Publication flavour|Publication flavour]] - For research publications.  Provided in &#039;&#039;[[flavours/pub_lib/]]&#039;&#039;.&lt;br /&gt;
# [[#Data flavour|Data flavour]] - For research data.  Provided in &#039;&#039;flavours/data_lib/&#039;&#039;.&lt;br /&gt;
# [[#Education flavour|Education flavour]] - For Open Education, i.e. teaching materials.  Provided in &#039;&#039;flavours/edu_lib/&#039;&#039;.&lt;br /&gt;
As well as flavours in EPrints 3.4, there are also &#039;&#039;[[#Ingredient|ingredients]]&#039;&#039;, which provide additional functionality, similar to a [[#Bazaar plugin|Bazaar plugin]] / [[#EPM|EPM]].  Any EPrints flavour has an &#039;&#039;inc&#039;&#039; file found in its top-level directory (e.g. &#039;&#039;flavours/pub_lib/inc&#039;&#039;).  This tells the flavour which paths to include.  By default, this would include the flavour itself.  It may also contain various ingredients and potentially [[#Site lib|site_lib]] if the repository has multiple [[#Archive|archives]], which require the same bespoke functionality.  However, it is better if this bespoke functionality can be converted into ingredients to separate out discrete parts of functionality.&lt;br /&gt;
&lt;br /&gt;
=== Front end pages ===&lt;br /&gt;
Same as [[#Public facing pages|public facing pages]].&lt;br /&gt;
&lt;br /&gt;
== G ==&lt;br /&gt;
== H ==&lt;br /&gt;
=== Help text ===&lt;br /&gt;
A help text is associated with a [[#Metadata field|metadata field]], providing advice on how this should be filled in as part of the [[#Workflow|workflow]].  This text is defined using a [[#Phrase|phrase]].  E.g. the phrase ID for the &#039;&#039;title&#039;&#039; metadata field of the [[#EPrint|eprint]] [[#Data object|data object]] is &#039;&#039;eprint_fieldhelp_title&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== History ===&lt;br /&gt;
A [[History Object]] is a [[#Second class data object|second class]] [[#Data object|data object]].  It is a [[#Sub-object|sub-object]] of any [[#First class data object|first class data object]] that supports [[#Revision|revisions]].  By default, this is only the [[#EPrint|eprint]] data object.  A history data object contains a revision number, a timestamp, a reference to a [[#User|user]] or an &amp;quot;actor&amp;quot; if the new revision is generated by a script and the &amp;quot;action&amp;quot; that is being carried out, (e.g. &#039;&#039;create&#039;&#039;, &#039;&#039;modify&#039;&#039;, &#039;&#039;move_buffer_to_archive&#039;&#039;, &#039;&#039;destroy&#039;&#039;, etc.)&lt;br /&gt;
&lt;br /&gt;
=== History tab ===&lt;br /&gt;
This tab refers to [[#EPrint history|eprint history]] or [[#User history|user history]] both make reference to changes between [[#Revision file|revision files]].  This tab can be found in the [[#View page|view page]] of the particular [[#EPrint|eprint]] or [[#User|user]]. (In the case of users this tab is labelled &amp;quot;User History&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Homepage ===&lt;br /&gt;
The homepage for an [[#Archive|archive]] is found at the top-level URL for a repository.  Usually, that is something like:&lt;br /&gt;
 https://example.eprints.org/&lt;br /&gt;
The homepage is a [[#Static page|static page]] although often contains dynamic elements, like the list of latest publications.  By default, the file is located at either &#039;&#039;[[lib/lang/en/static/|lib/lang/en/static]]/index.xpage&#039;&#039; or &#039;&#039;[[flavours/pub_lib/lang/en/static/|flavours/pub_lib/lang/en/static]]/index.xpage&#039;&#039; with the latter taking precedence if it exists.  Configuration for the archive ensure this page display bespoke information for your archive such as the [[#Archive name|archive name]].  However, you will most likely want to [[How_to_modify_static_pages|make changes to your homepage]], so you should copy the appropriate &#039;&#039;index.xpage&#039;&#039; to your archive&#039;s &#039;&#039;cfg/lang/en/static/&#039;&#039; directory, creating the directory if it does not already exist.&lt;br /&gt;
&lt;br /&gt;
== I ==&lt;br /&gt;
=== Import plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a formatted import of [[#Metadata|metadata]] for a [[#Data object|data object]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository software]] has import plugins for numerous different formats, which can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Import/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/Import/]]&#039;&#039; directories.  Bespoke import plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Import/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Import/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Inbox ===&lt;br /&gt;
Same as [[#User workarea|User workarea]].&lt;br /&gt;
&lt;br /&gt;
=== Inc file ===&lt;br /&gt;
The &#039;&#039;inc&#039;&#039; file is the critical part of a [[#Flavour|flavour]], which defines the paths that should be included for code and configuration.  It is found in the top-level directory of the flavour (e.g. &#039;&#039;/flavours/pub_lib/inc&#039;&#039;). Initially from the first sub-version of [[#EPrints repository software|EPrints]] 3.4 this will be just the path for the flavour (e.g. &#039;&#039;flavours/pub_lib&#039;&#039;) but increasingly core [[#Ingredient|ingredients]] will be added to this (e.g. for providing integration with the [[#Bazaar|Bazaar]] or for enabling different JavaScript libraries.  This is the only file outside the [[Archives/ARCHIVEID/|archive&#039;s directory structure]] that should need to be modified, unless you have a [[#Site lib|site_lib]].  However, the default inc file will probably not need changing in the case of most [[#Repository|repositories]].&lt;br /&gt;
&lt;br /&gt;
The ordering of paths within the inc file is important, as it determines, which configuration files get loaded and which takes precedence.  If you have a configuration file with the same filename in the &#039;&#039;cfg.d/&#039;&#039; directories for all three paths in the example inc file below, the file in &#039;&#039;site_lib&#039;&#039; will be used in precedence to the other two:&lt;br /&gt;
 flavours/pub_lib&lt;br /&gt;
 ingredients/bazaar&lt;br /&gt;
 site_lib&lt;br /&gt;
However, if you also have the same filename is the [[#Archive|archive]]&#039;s &#039;&#039;cfg/cfg.d/&#039;&#039; directory this will take precedence, although only for that archive, if you have a multi-archive repository.&lt;br /&gt;
&lt;br /&gt;
=== Indexer ===&lt;br /&gt;
The indexer is used by [[#EPrints repository software|EPrints repository software]] to carry out asynchronously tasks that may take a long time.  Typically, this would be indexing tasks, which include indexing of both the [[#Metadata|metadata]] for an [[#EPrint|eprint]] [[#Data object|data object]] and the full text (i.e. all the words in the PDF, Word, etc. document) for [[#Document|documents]] uploaded for those eprints.&lt;br /&gt;
&lt;br /&gt;
The Indexer can be managed through the [[#Admin menu|admin menu]] specifically, its [[Admin/System Tools|System Tools]] tab, which provides options to stop, start and force start the indexer.  Also, the [[Admin/System Tools/Status|Status]] option takes you to a page that lists the number of [[#Indexer task|tasks]] yet to be successfully completed by the indexer.  Commonly referred to as the &#039;&#039;[[#Event queue|event queue]]&#039;&#039; or &#039;&#039;background task queue&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== Indexer task ===&lt;br /&gt;
An indexer task is a scheduled operation to be carried out by the [[#Indexer|indexer]].  It is also a [[#Data object|data object]] in its own right but in this context is referred to as an [[Event Queue Object|event queue object]].  As until it is successfully completed it will appear in the [[#Event queue|event queue]].  An indexer task has several significant attributes:&lt;br /&gt;
* Status - Whether the task is &#039;&#039;Waiting&#039;&#039;, &#039;&#039;In Progress&#039;&#039; or &#039;&#039;Failed&#039;&#039;.&lt;br /&gt;
* Start time - The earliest time the indexer task can start.&lt;br /&gt;
* Plugin - The [[#Event plugin|event plugin]] that can perform this indexer task.&lt;br /&gt;
* Action - The specific action of the Event plugin for this indexer task.&lt;br /&gt;
* Parameters - The parameters needed to run the indexer task (e.g. the data object and potentially [[#Metadata field|metadata fields]] to be used by the indexer task.&lt;br /&gt;
&lt;br /&gt;
=== Ingredient ===&lt;br /&gt;
Since [[#EPrints repository software|EPrints]] version 3.4, the concept of [[EPrints Ingredients|ingredients]] has been introduced along with [[#Flavour|flavours]].  The main purpose of ingredients is to allow complex functionality to be developed but deployed in a way that does not make a mess of the existing [[#Core codebase|core codebase]] by spewing files in different places, like some [[#Bazaar plugin|Bazaar plugins]] can do.  Also, as Bazaar plugins are designed to be one-click install, they should require limited configuration, as this takes away from ease of deployment that one-click install implies.  Instead, ingredients can be much more complex.  Although effort should be taken to avoid mixing distinctly separate pieces of functionality when they could be kept apart.  &lt;br /&gt;
&lt;br /&gt;
Typically, an ingredient would be deployed by checking out a tagged version of the Git repository for that ingredient on [https://github.com/ GitHub].  Although that requires more technical knowledge than a one-click install, this is also inherently a safety feature, to avoid accidental installation of new functionality that could damage the data stored by the [[#Repository|repository]], which could happen when installing some of the more complex Bazaar plugins, without understanding of how they behave.&lt;br /&gt;
&lt;br /&gt;
=== Issue ===&lt;br /&gt;
An issue is a single row in a [[#Compound metadata field|compound]] [[#Multiple metadata field|multiple]] [[#Metadata field|metadata field]] that is part of an [[#EPrint|eprint]] [[#Data object|data object]]. It describes a potential problem discovered about a particular eprint. Unlike validation errors for specific metadata fields displayed whilst navigating the [[#EPrint workflow|eprint workflow]] issues are determined by comparing eprints across the [[#Dataset|dataset]] or checking for more subjective problems.  By default this includes:&lt;br /&gt;
* Duplicate titles - Two or more eprints have the exact same title.&lt;br /&gt;
* Similar titles - Two or more eprints share very similar titles.&lt;br /&gt;
* Old but unpublished - Date set for eprint is more than two years in the past but its publication status is still not published.&lt;br /&gt;
* Short family name - Family name for a creator is less than two characters or not set.  (Single name creators should always put this under family name).&lt;br /&gt;
Issues are checked for across all eprints in the [[#Live archive|live archive]] and [[#Review buffer|review buffer]] through a scheduled task running the &#039;&#039;bin/issues_audit&#039;&#039; script.  This can be deployed with a cron job similar to the following in the &#039;&#039;eprints&#039;&#039; user&#039;s crontab (substituting &#039;&#039;EPRINTS_PATH&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate&#039;&#039;):&lt;br /&gt;
 38 23 * * * EPRINTS_PATH/bin/issues_audit ARCHIVEID --quiet&lt;br /&gt;
Additional types of issue can be added in one of two ways:&lt;br /&gt;
# Creating a new Issues [[#Plugin|plugin]].&lt;br /&gt;
# Adding XML markup to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/issues.xml&#039;&#039;.&lt;br /&gt;
Issues for a particular eprint can be found under its [[#Issues tab|Issues tab]] of its [[#EPrint view page|view page]] or searched for through the [[#Admin menu|admin menu]]&#039;s [[Admin/Editorial Tools/Search issues|Search issues]] tool (under the [[Admin/Editorial Tools|Editorial Tools]] tab).&lt;br /&gt;
&lt;br /&gt;
=== Issues tab ===&lt;br /&gt;
This is a tab that appear on the [[#EPrint view page|eprint view page]] and lists the [[#Issue|issues]] associated with that [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
=== Item ===&lt;br /&gt;
Same as [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
== J ==&lt;br /&gt;
== K ==&lt;br /&gt;
&lt;br /&gt;
=== Key tools ===&lt;br /&gt;
Same as [[#User menu|user menu]].&lt;br /&gt;
&lt;br /&gt;
== L ==&lt;br /&gt;
=== Latest tool ===&lt;br /&gt;
The latest tool is a piece of functionally that allows JavaScript to be used to include a dynamically updating list of the latest [[#EPrint|eprints]] from a [[#Dynamic Pages | dynamic page]] to be put into the [[#Live archive|live archive]] on to a [[#Static page|static page]] like the [[#Homepage|homepage]].  This is provided through a script that can be requested at the equivalent following URL:&lt;br /&gt;
 http://example.eprints.org/cgi/latest_tool&lt;br /&gt;
It can be configured in the archive&#039;s &#039;&#039;cfg/cfg.d/[[latest_tool.pl]]&#039;&#039; to set the number of eprints shown and the [[#Citation|citation]] style used.&lt;br /&gt;
&lt;br /&gt;
=== License ===&lt;br /&gt;
Sometimes spelt &#039;&#039;licence&#039;&#039;, is the licence under which a [[#Document|document]] is made available in an [[#Archive|archive]].  By default, [[#EPrints repository software|EPrints repository software]] provides the [https://creativecommons.org/licenses/ Creative Commons (v4) licenses] as options in the [[#Named set|named set]] file &#039;&#039;licenses&#039;&#039; in [[lib/namedsets/]]. These include:&lt;br /&gt;
* [https://creativecommons.org/licenses/by/4.0/ Creative Commons Attribution 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons: Attribution-ShareAlike 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc/4.0/ Creative Commons: Attribution-NonCommercial 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nd/4.0/ Creative Commons: Attribution-NoDerivatives 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc-sa/4.0/ Creative Commons: Attribution-NonCommercial-ShareAlike 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc-nd/4.0/ Creative Commons: Attribution-NonCommercial-NoDerivatives 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/publicdomain/ Creative Commons: Public Domain Dedication]&lt;br /&gt;
* [https://creativecommons.org/licenses/GPL/2.0/ Software: Creative Commons: GNU GPL 2.0]&lt;br /&gt;
* [https://creativecommons.org/licenses/LGPL/2.1/ Software: Creative Commons: GNU LGPL 2.1]&lt;br /&gt;
&lt;br /&gt;
=== Live archive ===&lt;br /&gt;
Live archive refers to both the [[#EPrint status|status]] or an [[#EPrint|eprint]] as well as a [[#Virtual dataset|virtual dataset]] of all eprints that have their status set to &#039;&#039;live archive&#039;&#039;.  When an editor reviews and is happy with an eprint, they will change its status to live archive, so it becomes publicly accessible.&lt;br /&gt;
&lt;br /&gt;
== M == &lt;br /&gt;
=== Main menu ===&lt;br /&gt;
The [[#EPrints repository software|EPrints]] main menu by default contains links to the main pages of interest for a [[#Visitor|visitor]] to an [[#Archive|archive]], this includes:&lt;br /&gt;
* Home - A link back to the archive&#039;s [[#Homepage|homepage]].&lt;br /&gt;
* About - A [[#Static page|static page]] providing information about the archive.&lt;br /&gt;
* Browse - A listing of [[#Browse view|browse views]] available for the archive.&lt;br /&gt;
** Browse by Year&lt;br /&gt;
** Browse by Subject&lt;br /&gt;
** Browse by Division&lt;br /&gt;
** Browse by Author&lt;br /&gt;
&lt;br /&gt;
=== Management pages ===&lt;br /&gt;
These are the pages in an [[#Archive|archive]] that can only be accessed by [[#User|users]] after they have logged in.  They include those pages accessible to [[#Regular user|regular users]] to add/edit their own [[#EPrint|eprints]] or manage their [[#User profile|user profile]].  But also more restricted administration pages such as those accessible through the [[#Admin menu|admin menu]].  &lt;br /&gt;
&lt;br /&gt;
These pages are sometimes alternatively referred to as [[#Back end pages|back end pages]].&lt;br /&gt;
&lt;br /&gt;
=== Metadata ===&lt;br /&gt;
[[Metadata]] is all the values for the [[#Metadata field|metadata fields]] for a particular [[#Data object|data object]].&lt;br /&gt;
&lt;br /&gt;
=== Metadata field ===&lt;br /&gt;
A [[:Category:EPrints_Metadata_Fields|metadata field]], sometimes shortened to &#039;&#039;&#039;metafield&#039;&#039;&#039; (or even just &#039;&#039;field&#039;&#039;) is part of a [[#Data object|data object]] and store a particular piece of pieces of information for that data object.  Metadata fields have different [[:Category:EPrints_Metadata_Fields#Metadata Field Types|types]] and have different types of properties roughly broken down into the following categories:&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Core Properties|Core]]&#039;&#039;&#039; - This includes the &#039;&#039;name&#039;&#039;, aforementioned &#039;&#039;type&#039;&#039;, whether it should have &#039;&#039;multiple&#039;&#039; values and whether to add an SQL index for it.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Rendering Properties|Rendering]]&#039;&#039;&#039; - This includes how the render the metadata field within [[#Abstract page|abstract pages]], [[#Browse view|browse views]] and search results, where applicable.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Input and Validation Properties|Input and validation]]&#039;&#039;&#039; -  This includes how to display the input for the metadata field within a [[#Workflow|workflow]] and any additional functionality to how this field is used of subsequently validated.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Ordering, Indexing and Searching|Ordering, indexing and searching]]&#039;&#039;&#039; - Whether the metadata field should be included in [[#EPrints repository software|EPrints repository software]]&#039;s full-text indexing and how the data object can be ordered or search over using this field.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Other Properties|Other]]&#039;&#039;&#039; - Miscellaneous properties, such as whether the metadata field&#039;s value(s) should be copied across to a cloned version of the data object or be able to be set through an import.  Also, whether the field its value should appear in various management pages within the [[#Repository|repository]] or in exports.&lt;br /&gt;
&lt;br /&gt;
=== Minimal user ===&lt;br /&gt;
Sometimes also referred to as &amp;quot;min user&amp;quot;.  This is a type of user account that only has minimal access to an [[#Archive|archive]].  Typically, these accounts are intended for those users that may need to access restricted [[#Document|documents]] but do not need to submit their own [[#EPrint|eprints]].  Also, if you have open [[#User registration|user registration]] enabled, you may want to prevent newly registered users from submitting eprints until you can confirm you are happy with their registration.&lt;br /&gt;
&lt;br /&gt;
=== Multiple metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] that allows for more than one value to be stored for it against a particular [[#Data object|data object]].  This can be configured by setting the field definition&#039;s &amp;lt;tt&amp;gt;multiple&amp;lt;/tt&amp;gt; attribute to 1.  A good example of a multiple metadata field is the &#039;&#039;Roles&#039;&#039; field for the [[#User|user]] data object.  This allow multiple roles to be assigned to a user, to enable bespoke permissions for that user.&lt;br /&gt;
&lt;br /&gt;
== N == &lt;br /&gt;
=== Named set ===&lt;br /&gt;
A [[Namedset_field|named set]] refers to both a type of [[#Metadata field|metadata field]] with the type name &#039;&#039;namedset&#039;&#039; and the file that defines the options for this type of metadata field.  A named set metadata field is much like a &#039;&#039;set&#039;&#039; field.  However, rather than defining the options within [[#EPrints repository software|EPrints repository software]]&#039;s Perl-based configuration, they can be added to a simple text file where each new option is separated by a new line.  Such as for [[#EPrint type|eprint types]].  &lt;br /&gt;
&lt;br /&gt;
Named set files by default can be found in either the [[lib/namedsets/]] or [[flavours/pub_lib/namedsets/]] directories.  If you need to edit them to add or remove options, then the file should be copied to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/namedsets/&#039;&#039; directory before editing.  It is generally advised not to modify an option in this file once your archive is in use.  It is better to change the [[#Phrase|phrase]] that relates to that option.  E.g.  the &#039;&#039;type&#039;&#039; field for an &#039;&#039;[[#EPrint|eprint]]&#039;&#039; would have the phrase &amp;lt;tt&amp;gt;eprint_typename_article&amp;lt;/tt&amp;gt; for the value &#039;&#039;article&#039;&#039; in &#039;&#039;flavours/pub_lib/namedsets/eprint&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
== O ==&lt;br /&gt;
=== OAI-PMH ===&lt;br /&gt;
[https://www.openarchives.org/pmh/ Open Archives Initiative - Protocol for Metadata Harvesting (OAI-PMH)] is a standard for harvesting metadata from Open Access [[#Archive|repository archives]] like those provided by [[#EPrints repository software|EPrints repository software]].  For this EPrints has a [[OAI_FAQ|separate interface for accessing OAI-PMH]], which is available at the equivalent following URL:&lt;br /&gt;
 http://example.eprints.org/cgi/oai2&lt;br /&gt;
&lt;br /&gt;
=== Order key ===&lt;br /&gt;
An &#039;&#039;&#039;order key&#039;&#039;&#039; or &#039;&#039;&#039;orderkey&#039;&#039;&#039; is the (potentially language-specific) string used to order by a particular [[#Metadata field|metadata field]]. [[#EPrints repository software|EPrints repository software]]&#039;s default orderkey generation can be overridden by defining your own orderkey method and assigning it to the &#039;&#039;make_value_orderkey&#039;&#039; or &#039;&#039;make_single_value_orderkey&#039;&#039; property of the metadata field. This property is passed value(s) and returns (an) &#039;&#039;ordervalue&#039;&#039; string(s) after processing the value(s) for that metadata field.  Typically, you may want to define your own order keys to manage special characters, maybe to avoid accented characters appearing separately in a browse view.  Some examples of bespoke order keys can be found in [[make_orderkey.pl]].&lt;br /&gt;
&lt;br /&gt;
== P ==&lt;br /&gt;
=== Plugin ===&lt;br /&gt;
These are Perl modules that &amp;quot;Plug in&amp;quot; to the EPrints software to provide a particular piece of functionality.  Default plugins for [[#EPrints repository software|EPrints repository software]] can be found under the &#039;&#039;[[perl_lib/EPrints/Plugin/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/]]&#039;&#039; directories  They break down into several categories.  The most prominent being:&lt;br /&gt;
* [[EPrints Glossary#Export plugin|Export plugins]]&lt;br /&gt;
* [[EPrints Glossary#Import plugin|Import plugins]]&lt;br /&gt;
* [[EPrints Glossary#Screen plugin|Screen plugins]]&lt;br /&gt;
Other plugin categories include [[#Box plugin|Box]], Convert, [[#Event plugin|Event]], InputForm, [[#Issue|Issues]], Search and Storage.  &lt;br /&gt;
&lt;br /&gt;
[[How_to_contribute#Write_a_Plugin|Bespoke plugins]] can be written for an [[#Archive|archive]] and located in the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
Often the term &amp;quot;[[#Bazaar plugin|Bazaar plugin]]&amp;quot; is used to refer to a package of functionality (a.k.a. [[#EPM|EPM]]) that can be installed from the [[#Bazaar|Bazaar]].  Although an EPM can often contain individual plugins, it is a complex set of files rather than a single plugin file.  If an EPM does contain individual plugins, they will be installed to the &#039;&#039;lib/plugins/EPrints/Plugin/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Phrase ===&lt;br /&gt;
A phrase in [[#EPrints repository software|EPrints repository software]] is some text or HTML markup associated with an associated placeholder ID defined using [[Phrase_Format|EPrints&#039; bespoke XML markup]].  Phrases have various purposes.  One is to ensure consistent use of terminology throughout the [[#Archive|archive]].  It also essential for supporting multi-language archives.  They are used for defining all [[#Metadata field|metadata field]] names and their [[#Help text|help texts]].  They are also used extensively in [[#Screen plugin|screen plugins]] to allow them to be customised with informative messages.&lt;br /&gt;
&lt;br /&gt;
A prominent example of a phrase is an archive&#039;s name which is appears in the archive&#039;s &#039;&#039;[[archives/ARCHIVEID/cfg/lang/en/phrases/|cfg/lang/en/phrases]]/archive_name.xml&#039;&#039;, as follows:&lt;br /&gt;
 &amp;lt;epp:phrase id=&amp;quot;archive_name&amp;quot;&amp;gt;Example Archive&amp;lt;/epp:phrase&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Policies page ===&lt;br /&gt;
The policies page is a [[#Static page|static page]] available at the equivalent URL to:&lt;br /&gt;
 http://example.eprints.org/policies.html&lt;br /&gt;
The page contains policies for use of the [[#Archive|archive]] typically based on [https://scholarlycommunications.jiscinvolve.org/wp/2020/04/03/an-update-from-opendoar-policy-support-and-repositories-galore/ OpenDOAR].  This contains sections for:&lt;br /&gt;
* &#039;&#039;&#039;Metadata Policy&#039;&#039;&#039; stating the access rights and permissions for information describing items in the repository, and the minimum metadata requirements.&lt;br /&gt;
* &#039;&#039;&#039;Data Policy&#039;&#039;&#039; stating the access rights and (re-)use permissions for full-text and other full data items.&lt;br /&gt;
* &#039;&#039;&#039;Content Policy&#039;&#039;&#039; stating the types and versions of documents and datasets held.&lt;br /&gt;
* &#039;&#039;&#039;Submission Policy&#039;&#039;&#039; concerning eligible depositors, quality control and copyright statements.&lt;br /&gt;
* &#039;&#039;&#039;Preservation Policy&#039;&#039;&#039; concerning the long-term retention, migration, and withdrawal protocols.&lt;br /&gt;
&lt;br /&gt;
=== Preview image ===&lt;br /&gt;
This is a thumbnails or larger image that is a snapshot of the uploaded [[#Document|document]].  This is typically displayed on the [[#Abstract page|abstract page]], where hovering over it will display a larger version, which may be useful in determining if the document in the one the [[#Visitor|visitor]] expected.  Preview images for a document can be generate from the command line using the [[API:bin/epadmin|epadmin]] command&#039;s &#039;&#039;redo_thumbnails&#039;&#039; option.&lt;br /&gt;
&lt;br /&gt;
=== Preview tab ===&lt;br /&gt;
The preview tab is part of the [[#EPrint view page|eprint view page]] which displays a preview of the [[#Abstract page|abstract page]] for the [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
=== Public facing pages ===&lt;br /&gt;
This is used to refer to web pages in an [[#Archive|archive]] that are accessible to [[#Visitors|visitors]] without need to login.  This are also sometimes referred to as [[#Front end pages|front end pages]].&lt;br /&gt;
&lt;br /&gt;
=== Publication flavour ===&lt;br /&gt;
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+.  It is intended to produce [[#Repository|repositories]] for research publications.  This code for this flavour was separated from the [[#Core codebase|core codebase]] for EPrints 3.4, so that EPrints as a whole could be more easily customisable for other purpose such as [[#Data flavour|research data]] and [[#Education flavour|open education]].  The separated code and configuration can be found under [[flavours/pub_lib/]], where configuration files override those under [[lib/]] but are overridden by those at an [[#Archive level|archive level]].&lt;br /&gt;
&lt;br /&gt;
=== Publication record ===&lt;br /&gt;
Same as [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
== Q ==&lt;br /&gt;
== R ==&lt;br /&gt;
=== Regular user ===&lt;br /&gt;
This is a [[#User|user]] whose account provides them with standard access to an [[#Archive|archive]] allowing then to deposit [[#EPrint|eprints]] for [[#Review buffer|review]] and manage their [[#User profile|user profile]].  With [[#EPrints repository software|EPrints repository software]] this type of user account just referred to as &amp;quot;user&amp;quot;.  When describing this user, the adjective &amp;quot;regular&amp;quot; is used to distinguish this specific type of user from users more generally.&lt;br /&gt;
&lt;br /&gt;
=== Repository ===&lt;br /&gt;
This is an individual installation of the [[#EPrints repository software|EPrints repository software]] onto a server.  A repository may host many [[#Archive|archives]] but they all use the same [[#Core codebase|core codebase]].  Sometimes a repository will host only a single archive and therefore, the terms repository and archive are often used interchangeably and often the latter is referred to as a &amp;quot;repository archive&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Repository admin ===&lt;br /&gt;
Short for repository administrator, this is a level of [[#User|user]] account that give maximum access to an [[#Archive|archive]].  Allowing the user to carry out [[#Regular user|regular user]] actions such as depositing an [[#EPrint|eprint]], [[#Editor|editorial]] actions like reviewing eprints submitted by a regular user and administrative actions, in particular those available through the [[#Admin menu|admin menu]].&lt;br /&gt;
&lt;br /&gt;
=== Request ===&lt;br /&gt;
This is a [[#Data object|data object]] that relates to a request made by a [[#User|user]] or [[#Visitor|visitor]] about a specific [[#EPrint|eprint]] or [[#Document|document]].  The most common request is [[#Request copy|request copy]] by a visitor for access to a document that is [[#Document security|restricted]].  In some [[#Archive|archives]] it may also be enabled to allow users to submit change requests to eprints in the [[#Live archive|live archive]], if they notice an error in their [[#Metadata|metadata]].&lt;br /&gt;
&lt;br /&gt;
=== Request copy ===&lt;br /&gt;
Sometimes also referred to as &amp;quot;request a copy&amp;quot; this is a button or link on an [[#Abstract page|abstract page]], allowing a [[#Visitor|visitor]] to request a copy of a [[#Document|document]] that is [[#Embargo|currently]] [[#Document security|restricted]].  If the [[#EPrint|eprint]] has its &#039;&#039;contact email&#039;&#039; [[#Metadata field|metadata field]] this will email that address with the request sent by the visitor.  If that email addresses matches that of a [[#User|user]] the email sent will contain accept and reject links.  Where the former will provide a link in the email response to the visitor, giving them temporary access to the restricted document.&lt;br /&gt;
&lt;br /&gt;
=== REST API ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] provides a standard [https://www.redhat.com/en/topics/api/what-is-a-rest-api REST API] that allows third-party applications to create, read, update and destroy various [[#Data object|data objects]] within an [[#Archive|archive]].  In EPrints, the REST API provides similar functionality to the [[#CRUD API|CRUD API]], albeit under a URL path like:&lt;br /&gt;
 https://example.eprints.org/rest/&lt;br /&gt;
&lt;br /&gt;
=== Retired ===&lt;br /&gt;
This is an [[#EPrint status|eprint status]] for [[#EPrint|eprints]] that have been in the [[#Live archive|live archive]] but have been removed for some reason.  The advantage of retiring an eprint rather than deleting it, is that it can be restored, if it was removed erroneously from the live archive.  Also, the [[#Abstract page|abstract page]] will display a message saying the eprint has been removed rather than a &amp;quot;404 Not Found&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Review buffer ===&lt;br /&gt;
This is an [[#EPrint status|eprint status]] of [[#EPrint|eprints]] that have be deposited by a [[#User|user]] but need to be reviewed by an [[#Editor|editor]] before being added to the [[#Live archive|live archive]].  Review buffer also refers to all eprints that currently have this status and can be accessed view the &#039;&#039;Review&#039;&#039; link in the [[#User menu|user menu]].&lt;br /&gt;
&lt;br /&gt;
=== Revision ===&lt;br /&gt;
Some [[#First class data object|first class data objects]] support [[#Revision file|revision files]] and [[#History|history data objects]] to track their changes over time.  By default there are only [[#EPrint revision|eprint revisions]].&lt;br /&gt;
&lt;br /&gt;
=== Revision file ===&lt;br /&gt;
This is a file on disk that stores [[#EPrints XML|EPrints XML]] markup for the [[#Metadata|metadata]] for a [[#Data object|data object]].  By default, revision files are only generated for [[#EPrint|eprints]] and can be found within the &#039;&#039;revisions&#039;&#039; directory for that eprint&#039;s sub-directory under the [[#Documents directory|documents directory]].  E.g.&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/documents/disk0/00/00/00/01/revisions/1.xml&lt;br /&gt;
The revisions are used in an eprint&#039;s [[#History tab|history tab]] to generate a listing of changes between one [[#EPrint revision|revision]] and the next.&lt;br /&gt;
&lt;br /&gt;
== S ==&lt;br /&gt;
=== Saved search ===&lt;br /&gt;
This is a [[#Second class data object|second class]] [[#Data object|data object]] that records the criteria of a particular search made by a [[#User|user]].  Its purpose is to allow the user (or even some [[Additional_Recipients_on_Saved_Searches|additional recipients]]) to receive regular email updates about results that meet these criteria.&lt;br /&gt;
&lt;br /&gt;
=== Screen plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a &amp;quot;screen&amp;quot;, which is effectively a dynamic page to allow the [[#User|user]] to carry out some action on the [[#Archive|archive]].  Some of the most significant screen plugins are for:&lt;br /&gt;
# Logging in and out of the archive.&lt;br /&gt;
# Managing a [[#Data object|data object]]&#039;s [[#Workflow|workflow]].&lt;br /&gt;
# Providing the [[#Admin menu|admin menu]].&lt;br /&gt;
# Reviewing [[#EPrint|eprints]].&lt;br /&gt;
# Editing [[#Subject|subjects]].&lt;br /&gt;
# Searching for users or eprints.&lt;br /&gt;
By default, screen plugins can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Screen/]]&#039;&#039; directory.  Bespoke screen plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Screen/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Screen/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Second class data object ===&lt;br /&gt;
These are [[#Data object|data objects]] that are [[#Sub-object|sub-objects]] of a [[#First class data object|first class data object]].  These include:&lt;br /&gt;
* [[Document Object]] (sub-object of [[#EPrint|eprint]]).&lt;br /&gt;
* [[History Object]] (sub-object of eprint or potentially any data object that has its history recorded).&lt;br /&gt;
* [[Saved Search Object]] (sub-object of [[#User|user]]).&lt;br /&gt;
&lt;br /&gt;
=== Simple search ===&lt;br /&gt;
A simple search over [[#EPrint|eprints]] in the [[#Live archive|live archive]].  Unlike [[#Advanced search|advanced search]] this provides a single input field to search against multiple [[#Metadata field|metadata fields]].  Simple search configuration can be found in [[eprint_search_simple.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Site lib ===&lt;br /&gt;
Creating a directory in the [[#EPrints path|EPrints path]] with the name &#039;&#039;site_lib&#039;&#039;, will allow you modify [[#Core codebase|core code and configuration]], which will apply to all of the [[#Archive|archives]] in your [[#Repository|repository]].  If you are running EPrints version 3.4+, be sure to also add &#039;&#039;site_lib&#039;&#039; to your [[#Flavour|flavour&#039;s]] [[#Inc file|inc file]].&lt;br /&gt;
&lt;br /&gt;
Sometimes you may need modify the functionality of files in the core codebase but you don&#039;t want to change them, as this will involve having to merge any future changes when you upgrade [[#EPrints repository software|EPrints repository software]].  This is particularly useful if you need to modify a non-plugin code file, ([[#Plugin|plugin]] files can be [[Instructions_for_local_plugins|overridden]] by [[#Archive level|archive level]] versions), E.g. &#039;&#039;[[API:EPrints/Repository|perl_lib/EPrints/Repository.pm]]&#039;&#039;, which can simply be copied to &#039;&#039;site_lib/EPrints/plugins/Repository.pm&#039;&#039; rather than modifying it in place.  However, when you do upgrade EPrints, you will still need to reconcile any updates to the &#039;&#039;perl_lib/&#039;&#039; version of this file with your version in &#039;&#039;site_lib/plugins/&#039;&#039;.  This will be a much more straightforward task, (than if you had just modified the version in &#039;&#039;perl_lib/&#039;&#039;), as both files will still be in place to compare.  One particular use of &#039;&#039;site_lib&#039;&#039; is for inter-version patches from [https://github.com/eprints/eprints3.4|EPrints&#039; GitHub].  As when it comes to an upgrade, the versions of the files in &#039;&#039;site_lib/plugins/&#039;&#039; can just be removed, as their modifications will be present in their &#039;&#039;perl_lib/&#039;&#039; equivalents.&lt;br /&gt;
&lt;br /&gt;
=== Staff search ===&lt;br /&gt;
Search across all [[#EPrint|eprints]] whatever their [[#EPrint status|eprint status]].  See [[Admin/Editorial Tools/Search items]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== Static page ===&lt;br /&gt;
This is a page for an [[#Archive|archive]] that contains static content that can be cached.  Although it may also contain dynamic elements through the use of JavaScript and [https://en.wikipedia.org/wiki/Ajax_(programming) Ajax].  Examples of static pages are:&lt;br /&gt;
* The [[#Homepage|homepage]]&lt;br /&gt;
* The about/information page (e.g. &amp;lt;tt&amp;gt;http://example.eprints.org/information.html&amp;lt;/tt&amp;gt;)&lt;br /&gt;
* The [[#Contact page|contact page]] &lt;br /&gt;
* The [[#Policies page|policies page]]&lt;br /&gt;
To clear the caches of old static pages and other static content (like JavaScript and CSS) and generate new cached versions, the [[API:bin/generate_static|bin/generate_static]] command can be used.&lt;br /&gt;
&lt;br /&gt;
Other pages like [[#Browse view|browse view]] menus and listings and [[#Abstract page|abstract pages]] are also cached as they contain static content, which only need be updated periodically or when the underlying [[#EPrint|eprint]] changes.  These are sometimes also referred to as static pages but can be refreshed using [[API:bin/epadmin#|bin/epadmin]] command (or through the [[Admin/System Tools|Admin menu]]) or regenerated using the [[API:bin/generate_views|bin/generate_views]] and [[API:bin/generate_abstracts|bin/generate_abstracts]] commands.&lt;br /&gt;
&lt;br /&gt;
=== Sub-object ===&lt;br /&gt;
This is a concept where a [[#Data object|data object]] is part of another data object, such as a [[#Document|document]] being part of an [[#EPrint|eprint]].  Where the former is known as a [[#Second class data object|second class data object]] and the latter is known as a [[#First class data object|first class data object]].  &lt;br /&gt;
&lt;br /&gt;
[[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]] is an abstract class within [[#EPrints repository software|EPrints repository software]], which second class (and [[#Third class data object|third class]]) data object classes extend.&lt;br /&gt;
&lt;br /&gt;
=== Subject ===&lt;br /&gt;
A [[Subject Object|subject]] is a [[#Data object|data object]] that stores a node for the [[#Subject tree|subject tree]] of an [[#Archive|archive]].  &lt;br /&gt;
&lt;br /&gt;
A subject has three separate [[#Metadata field|metadata fields]] to describe the value it represents:&lt;br /&gt;
* &#039;&#039;&#039;ID&#039;&#039;&#039; - A short text string providing the unique ID for that subject.&lt;br /&gt;
* &#039;&#039;&#039;Name&#039;&#039;&#039; - The human-readable name for that subject.&lt;br /&gt;
* &#039;&#039;&#039;Sort value&#039;&#039;&#039; - The value used to determine the ordering of the subject amongst its siblings in the subject tree (e.g. in a [[#Browse view|browse view]]).&lt;br /&gt;
&lt;br /&gt;
A subject also contains a &#039;&#039;&#039;parent&#039;&#039;&#039; metadata field that links it into the rest of the subject tree and a &#039;&#039;&#039;depositable&#039;&#039;&#039; metadata field that indicate whether it is an option that can be selected when the subject tree or part thereof is used to provide a metadata field for another data object (e.g. [[#EPrint|eprint]]).&lt;br /&gt;
&lt;br /&gt;
=== Subject tree ===&lt;br /&gt;
This is made up of [[#Subject|subject]] [[#Data object|data objects]] and is used to provide hierarchical sets of options for various [[#Metadata field|metadata fields]] or other data objects, such as [[#EPrint|eprints]], as a [[Subject_field|subject metadata field]].  In particular:&lt;br /&gt;
* &#039;&#039;&#039;eprint subjects&#039;&#039;&#039; - Records one or more subjects (e.g. from the Library of Congress or Dewey decimal classifications) under which the publication represented by this eprint covers.&lt;br /&gt;
* &#039;&#039;&#039;eprint [[#Division|divisions]]&#039;&#039;&#039; - Records one or more divisions within an organisation/institution (e.g. faculty, school, department, etc.) for which authors of the publication represented by the eprint are members.&lt;br /&gt;
The subject tree can be edited by the [[#Admin menu|admin menu]] using the &amp;quot;[[Admin/Config. Tools/Edit subject|Edit subject]]&amp;quot; page.&lt;br /&gt;
&lt;br /&gt;
=== Succeeds ===&lt;br /&gt;
An [[#EPrint|eprint]] [[#Data object|data object]] contains a [[#Metadata field|metadata field]] called &#039;&#039;succeeds&#039;&#039;.  This metadata field can store the ID of an eprint for which the current eprint supersedes.  This may be used where a new version of the publication is produced but you don&#039;t want to or cannot replace the [[#Document|document]] in the original eprint.  By using the succeeds field, the original eprint will be removed from search and its [[#Abstract page|abstract page]] will display a warning saying it is not the latest version of the eprint.&lt;br /&gt;
&lt;br /&gt;
=== Summary page ===&lt;br /&gt;
Same as [[#Abstract page|abstract page]].  Sometimes even referred to as the abstract/summary page.&lt;br /&gt;
&lt;br /&gt;
=== Summary table ===&lt;br /&gt;
A table on an [[#Abstract page|abstract page]] that lists the names and values for specific [[#Metadata field|Metadata fields]] for the [[#EPrint|eprint]].  These can be specified, typically in the archive&#039;s &#039;&#039;cfg/cfg.d/[[eprint_render.pl]]&#039;&#039;, under &amp;lt;tt&amp;gt;$c-&amp;gt;{summary_page_metadata}&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Sword API ===&lt;br /&gt;
This is an API provided by [[#EPrints repository software|EPrints repository software]] that complies with the [https://guides.dataverse.org/en/latest/api/sword.html SWORD specification] for a RESTful API.  It is similar to EPrints&#039; [[#CRUD API|CRUD]] and [[#REST API|REST]] APIs but is intended to facilitate smoother interoperability between different types of Open Access repository, using an [https://datatracker.ietf.org/wg/atompub/about/ atompub] based XML format and the [https://www.dublincore.org/specifications/dublin-core/dcmi-terms/ Dublin Core schema] for [[#Metadata|metadata]] terms.&lt;br /&gt;
&lt;br /&gt;
=== System field ===&lt;br /&gt;
A [[#Metadata field|metadata field]] that is core to a [[#Data object|data object]].  Usually this field is for administrative field of little interest to a visitor or regular user but required for the management of the data object.  Typically such fields are hard-coded into the data object rather than customisable in configuration.  E.g. the &amp;lt;tt&amp;gt;dir&amp;lt;/tt&amp;gt; field for an [[#EPrint|eprint]] that records the location where uploaded [[#Document|documents]] to an eprint should be store on the filesystem.&lt;br /&gt;
&lt;br /&gt;
== T ==&lt;br /&gt;
=== Template ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] uses templates to apply [[#Branding|branding]] to a [[#Repository|repository]] or individual [[#Archive|archive]].  These templates provide the HTML structure for an archive&#039;s web pages and can be found in one of the following directories:&lt;br /&gt;
# [[lib/templates/]]&lt;br /&gt;
# [[flavours/pub_lib/lang/en/templates/]]&lt;br /&gt;
# [[archives/ARCHIVEID/cfg/templates/]]&lt;br /&gt;
# [[archives/ARCHIVEID/cfg/lang/en/templates/]]&lt;br /&gt;
However, there are additional directories templates maybe found if you use [[#Site lib|site_lib]] or a [[#Theme|theme]].  The higher the number determines which template will be used if they have the same name.&lt;br /&gt;
&lt;br /&gt;
The main template file is called &#039;&#039;&#039;default.xml&#039;&#039;&#039;, which will be used if not otherwise specified in the XML markup for the [[#Static page|static page]]. Also, other [[#Public facing pages|public facing pages]] such as [[#Simple search|simple]] and [[#Advanced search|advanced]] search, [[#Abstract page|abstract pages]] and [[#Browse view|browse views]] will use the default template.  Since EPrints version 3.4. [[#Management pages|management pages]] will use the &#039;&#039;&#039;default_internal.xml&#039;&#039;&#039; template.&lt;br /&gt;
&lt;br /&gt;
Bespoke template files can be defined and used (e.g. &#039;&#039;mytemplate.xml&#039;&#039;).  For applying to static pages this can be done by setting the &amp;lt;tt&amp;gt;&amp;lt;xpage:template&amp;gt;&amp;lt;/tt&amp;gt;.  For applying to browse views by setting the &amp;lt;tt&amp;gt;template&amp;lt;/tt&amp;gt; attribute for the view in [[views.pl]] and for applying to abstract pages setting the &amp;lt;tt&amp;gt;$template&amp;lt;/tt&amp;gt; in the parameters returned by &amp;lt;tt&amp;gt;$c-&amp;gt;{eprint_render}&amp;lt;/tt&amp;gt; in [[eprint_render.pl]].  See [[Branding_with_confidence#Taking_control|Branding with confidence - Taking control]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== Theme ===&lt;br /&gt;
If you have multiple [[#Archive|archives]] you want to apply the same [[#Branding|branding]] you may want to create a theme.  Themes can be found at &#039;&#039;[[lib/themes/]]&#039;&#039; and can be used by an archive by modifying the following setting in [[branding.pl]]:&lt;br /&gt;
 $c-&amp;gt;{theme} = &#039;THEMEID&#039;;&lt;br /&gt;
A theme can contain [[#Template|templates]], [[#Phrase|phrases]], [[#Static page|static pages]], JavaScript, CSS, images and icons.  Also, as the theme has its own  directory structure, it is easy to manage under version control and checkout across multiple [[#Repository|repositories]] or even make into an [[#EPM|EPM]].&lt;br /&gt;
&lt;br /&gt;
=== Third class data object ===&lt;br /&gt;
These are [[#Data object|data objects]] that are sub-objects of [[#Second class data object|second class data objects]] to exist, which in turn are sub-objects of [[#First class data object|first class data objects]].  The main example of such a data object in [[#EPrints repository software|EPrints repository software]] is a [[#File|file]] data object.&lt;br /&gt;
 File --sub-object of--&amp;gt; Document --sub-object of--&amp;gt; EPrint&lt;br /&gt;
&lt;br /&gt;
=== Trigger ===&lt;br /&gt;
[[Triggers]] allow a function to be defined that will be called at a particular execution point.  Such as before or after an eprint record is committed or when rewriting the request for a URL to return the appropriate resource.&lt;br /&gt;
&lt;br /&gt;
== U ==&lt;br /&gt;
=== User ===&lt;br /&gt;
A [[User Object|User]] is a [[#First class data object|first class]] [[#Data object|Data object]] in [[#EPrints repository software|EPrints repository software]].  It represents a user of [[#Repository|Repository]] and provides an account under which that user can login.  Storing [[#Metadata|metadata]] about that user, such as their username, given and family names, email address, department, etc.&lt;br /&gt;
&lt;br /&gt;
=== User history ===&lt;br /&gt;
This is the history of changes the [[#User|user]] has made to an [[#EPrint|eprint]] (or in fact any [[#First order data object|first order data object]] that supports [[#Revision|revisions]]) and can be found in the [[#History tab|user history tab]] on the user&#039;s [[#View page|view page]].  This is compiled by finding all [[#History|history data objects]] for the particular user and then comparing these associated revision files with their previous revision files.&lt;br /&gt;
&lt;br /&gt;
=== User menu ===&lt;br /&gt;
This is the menu available to [[#User|users]] once they are logged in.  (Although it does contain the &amp;quot;Login&amp;quot; and &amp;quot;[[#User registration|Create account]]&amp;quot; links when a user is not logged in).  This is sometimes also referred to as [[#Key tools|key tools]], as that is the ID used in configuration. By default, this contains the following options:&lt;br /&gt;
* &#039;&#039;&#039;Manage deposits&#039;&#039;&#039; - Create and edit [[#EPrint|eprint]] [[#Data object|data objects]].&lt;br /&gt;
* &#039;&#039;&#039;Manage records&#039;&#039;&#039; - Create and edit various types of data object &#039;&#039;([[#Repository admin|repository admins only]])&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Profile&#039;&#039;&#039; - View and edit the current [[#User profile|user&#039;s profile]].&lt;br /&gt;
* &#039;&#039;&#039;Saved searches&#039;&#039;&#039; - View and edit the current user&#039;s [[#Saved search|saved searches]].&lt;br /&gt;
* &#039;&#039;&#039;Review&#039;&#039;&#039; - Review eprints deposited by users into the [[#Review buffer|review buffer]] to see if they can be moved to the [[#Live archive|live archive]] &#039;&#039;([[#Editor|editors]] and repository admins only)&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Admin&#039;&#039;&#039; - Links to the [[#Admin menu|admin menu]] &#039;&#039;(repository admins only)&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Logout&#039;&#039;&#039; - logout of the [[#Archive|archive]] as the current user.&lt;br /&gt;
Additional links (for [[#Screen plugin|screen plugins]]) can be added to the user menu by editing adding a line like the following to a configuration file in the archive&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory:&lt;br /&gt;
 $c-&amp;gt;{plugins}-&amp;gt;{&amp;quot;Screen::MyScreenPlugin&amp;quot;}-&amp;gt;{appears}-&amp;gt;{key_tools} = 1000;&lt;br /&gt;
The number (i.e. 1000) specifies the position the link to this screen plugin will appear relative to others.  The higher the number the later in the menu it will appear.&lt;br /&gt;
&lt;br /&gt;
To add the user menu to a [[#Template|template]], you need to include the following snippet of [[#EPrints XML|EPrints XML]]:&lt;br /&gt;
 &amp;lt;epc:pin ref=&amp;quot;login_status&amp;quot;/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== User privilege ===&lt;br /&gt;
An action a [[#User|user]] is permitted to perform.  See [[User Roles and Privileges]].&lt;br /&gt;
&lt;br /&gt;
=== User profile ===&lt;br /&gt;
A page displaying the [[#Metadata|metadata]] about a [[#User|user]].  This often links to a page where these metadata can be modified.&lt;br /&gt;
&lt;br /&gt;
=== User registration ===&lt;br /&gt;
By default, [[#EPrints repository software|EPrints repository software]] allows [[#User|users]] to register by following the &amp;quot;Create account&amp;quot; link in the [[#User menu|user menu]].  This allows them to create a user account, which most then be activated by clicking the link on an email sent to the email address for the is registered user.  &lt;br /&gt;
&lt;br /&gt;
Often you may not want unrestricted user registration.  If this is the case, you should copy [[registration.pl]] that can be found in [[lib/cfg.d/]] to the [[#Archive level|archive level]] (i.e. the archive&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory) and change the following setting to 0:&lt;br /&gt;
 $c-&amp;gt;{allow_web_signup} = 0;&lt;br /&gt;
&lt;br /&gt;
=== User review scope ===&lt;br /&gt;
[[#Editor|editor]] [[#User|users]] are allowed to review deposited [[#EPrint|eprints]] in the [[#Review buffer|review buffer]] to check whether the can be moved to the [[#Live archive|live archive]] and make any modifications required.  Sometimes you may only want a particular editor to be able to review certain eprints, which are in their area of expertise.  This can be done by setting their [[#Editorial rights restriction|editorial rights restriction]] in their [[#User profile|user profile]].  By default, restrictions can be set on the following three eprint fields:&lt;br /&gt;
* [[#Division|divisions]]&lt;br /&gt;
* [[#Subject|subjects]]&lt;br /&gt;
* [[#EPrint type|type]]&lt;br /&gt;
However, this can be modified by copying [[user_review_scope.pl]] to the [[#Archive level|archive level]] (i.e. the [[#Archive|archive]]&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory) and edit the setting &amp;lt;tt&amp;gt;$c-&amp;gt;{editor_limit_fields}&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== User role ===&lt;br /&gt;
A set of [[#User privileges|privileges]] that a [[#User|user]] has permission to perform.  See [[User Roles and Privileges]].&lt;br /&gt;
&lt;br /&gt;
=== User search ===&lt;br /&gt;
A form for searching across the [[#User|users]] in an [[#Archive|archive]].  See [[Admin/Editorial Tools/Search users|Search users]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== User workarea ===&lt;br /&gt;
This is the status of an [[#EPrint|eprint]] whilst it is being edited by the [[#Depositing user|depositing user]].  This status is often also referred to as [[#Inbox|inbox]].  User workarea can sometimes refer to the &#039;&#039;Manage deposits&#039;&#039; page where the current [[#User|user]] can see a listing of all the EPrints they have created.&lt;br /&gt;
&lt;br /&gt;
== V ==&lt;br /&gt;
=== View page ===&lt;br /&gt;
The view page displays information about a [[#Data object|data object]], typically an [[#EPrint|eprint]].  This is why &amp;quot;view page&amp;quot; is often used as shorthand for [[#EPrint view page|eprint view page]].&lt;br /&gt;
&lt;br /&gt;
=== Virtual dataset ===&lt;br /&gt;
A virtual [[#Dataset|dataset]] is one that is derived from a real dataset.  In particular, [[#EPrints repository software|EPrints repository software]] has virtual datasets for:&lt;br /&gt;
* [[#Live archive|Live archive]] &lt;br /&gt;
* [[#Review buffer|Review buffer]] &lt;br /&gt;
* [[#User workarea|User workarea]] &lt;br /&gt;
* [[#Retired|Retired]] &lt;br /&gt;
All of these are sub-sets of the [[#EPrint|eprint]] dataset where the [[#EPrint status|eprint status]] is a particular value.  &lt;br /&gt;
&lt;br /&gt;
Additional virtual datasets can be configured for a [[#Repository|repository]] or at an [[#Archive level|archive level]]. &lt;br /&gt;
&lt;br /&gt;
=== Virtual metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] whose values are not actually stored in the database but are generated dynamically by a function probably using the values of one or more other metadata fields.  This may be useful when editing the [[#Citation|citation]] style as part of designing your [[#Archive|archive]]&#039;s [[#Abstract page|abstract page]], as being able to reference a field is very straightforward.  A basic example might be that you want to display on the abstract page the number of [[#Document|documents]] for the [[#EPrint|eprint]].  Creating a virtual field for the eprint called &#039;&#039;num_docs&#039;&#039; might look as follows:&lt;br /&gt;
 {&lt;br /&gt;
   name =&amp;gt; &#039;num_docs&#039;,&lt;br /&gt;
   type =&amp;gt; &#039;int&#039;,&lt;br /&gt;
   virtual =&amp;gt; 1,&lt;br /&gt;
   render_value =&amp;gt; &#039;get_num_docs&#039;,&lt;br /&gt;
 },&lt;br /&gt;
Then you would define a function in a configuration file and assign it to &amp;lt;tt&amp;gt;$c-&amp;gt;{get_num_docs}&amp;lt;/tt&amp;gt;.  You could then simply include this in the &#039;&#039;summary_page.xml&#039;&#039; eprint citation file as:&lt;br /&gt;
 &amp;lt;epc:print expr=&amp;quot;num_docs&amp;quot;/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Visitor ===&lt;br /&gt;
A visitor to an [[#Archive|archive]] is distinguished from a [[#User|user]], as they are not logged in and they are accessing the archive anonymously.  They are probably just wanting to view an [[#Abstract page|abstract page]] or download an open access publication [[#Document|document]].&lt;br /&gt;
&lt;br /&gt;
=== Volatile metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] that is liable to change on a regular basis but does not really affect the overall content of the [[#Data object|data object]]&#039;s [[#Metadata|metadata]], so should not prompt a new [[#Revision|revision]] to be generated.  A metadata field can be made volatile by setting the following attribute in the field definition:&lt;br /&gt;
 volatile =&amp;gt; 1,&lt;br /&gt;
Metadata fields that are only intended for administrative purposes are often defined as volatile, such as the [[#EPrint|eprint]] [[#EPrint locking|edit_lock]] metadata field.  If a [[#User|user]] takes an edit lock on an eprint, if the edit_lock metadata field was non-volatile, this would lead to a new revision being create for the eprint when ultimately nothing had yet changed.  In fact, worse still, if the edit lock was released without making any changes, a further revision would be created, which would be basically the same as the revision before the user took the edit lock.&lt;br /&gt;
&lt;br /&gt;
== W ==&lt;br /&gt;
=== Workflow ===&lt;br /&gt;
[[#First class data object|First class]] [[#Data object|data objects]] in [[#EPrints repository software|EPrints repository software]] have a workflow to allow the metadata they store to be edited via a sequence of forms.  The most common of these is the [[#EPrint workflow|eprint workflow]] for the [[EPrint Object|eprint data object]].  By default the configuration for this workflow is written in XML and can be found in &#039;&#039;default.xml&#039;&#039; in either [[lib/workflows/eprint/]] or [[flavours/pub_lib/workflows/eprint/]]. If this needs to be modified it should be copied to the archive&#039;s [[Archives/ARCHIVEID/cfg/workflows/eprint/|cfg/workflows/eprint/]] directory before editing.  Explanation of the various elements and attributes are described in the [[Workflow_Format|workflow format guide]].&lt;br /&gt;
&lt;br /&gt;
=== Workflow component ===&lt;br /&gt;
These provide sections (i.e. boxes) within each [[#Workflow stage|workflow stage]].  A workflow component contain one or more [[#Metadata field|metadata fields]] or some other content to assist the [[#Metadata|metadata]] submission process.  There are various different types of workflow component that serve different purposes:&lt;br /&gt;
* &#039;&#039;&#039;Documents&#039;&#039;&#039; - For managing [[#Document|document]] [[#Sub-object|sub-objects]].&lt;br /&gt;
* &#039;&#039;&#039;Error&#039;&#039;&#039; - Used when there is an issue with the workflow component, (e.g. the metadata field included does not exist).&lt;br /&gt;
* &#039;&#039;&#039;Field&#039;&#039;&#039; - This has various sub-types for including one, several or [[#Subject|subjects]] type metadata fields.&lt;br /&gt;
* &#039;&#039;&#039;Upload&#039;&#039;&#039; - For uploading a file, (e.g. a document to an [[#EPrint|eprint]]).&lt;br /&gt;
* &#039;&#039;&#039;XHTML&#039;&#039;&#039; - Just some HTML markup.&lt;br /&gt;
&lt;br /&gt;
=== Workflow stage ===&lt;br /&gt;
As a [[#Workflow|workflow]] is a sequence (or flow) of forms a workflow stage defines one of these forms.  Stages can be defined within the [[Workflow_Format|workflow format]] to produce the order of forms required.  Each workflow stage contains one or more [[#Workflow component|workflow components]], that in turn include [[#Metadata field|metadata fields]] for the relevant [[#Data object|data object]].  Below, is the [[#EPrints XML|EPrints XML]] markup for the default ordering of workflow stages for an eprint data object:&lt;br /&gt;
 &amp;lt;flow&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;type&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;files&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;core&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;subjects&amp;quot;/&amp;gt;&lt;br /&gt;
 &amp;lt;/flow&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== X ==&lt;br /&gt;
=== Xapian search ===&lt;br /&gt;
Originally [[#EPrints repository software|EPrints repository software]] created its own database index to support search.  However, this was not particularly efficient or quick to return results, so it started to use a [https://xapian.org/ Xapian] search index to speed up [[#Simple search|simple search]].  ([[#Advanced search|Advanced search]] still uses the database index).  Also, it made it possible to provide relevance based ordering, so that more relevant results could be displayed nearer the top of the search results.  Xapian also gives the potential to provide faceted based search, where search results can be refined by limiting the values for a particular facet (i.e. for EPrints, a [[#Metadata field|metadata field]]).&lt;br /&gt;
&lt;br /&gt;
== Y ==&lt;br /&gt;
== Z ==&lt;br /&gt;
=== Zero flavour ===&lt;br /&gt;
This is a minimal [[#Flavour|flavour]] to create very basic [[#Archive|archives]] with simple [[#EPrint|eprint]] [[#Data object|data objects]].  This may be useful if you want to develop a non-publications repository that requires a lot of bespoke configuration.  As it saves having to override exisiting publications-based configuration.&lt;br /&gt;
&lt;br /&gt;
[[Category:FAQ]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=EPrints_Glossary&amp;diff=17577</id>
		<title>EPrints Glossary</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=EPrints_Glossary&amp;diff=17577"/>
		<updated>2026-10-14T09:06:01Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Dynamic Pages */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{glossary}}&lt;br /&gt;
__NOTOC__&lt;br /&gt;
EPrints repository software uses a long list of terminology.  Sometimes this terminology overloads existing terminology in similar realms.  Other times different terms are used interchangeably to mean the same of similar things.  This glossary is intended to help clarify the various terminology you may come across whilst installing, configuring or using EPrints repository software.&lt;br /&gt;
&lt;br /&gt;
== A ==&lt;br /&gt;
=== Abstract page ===&lt;br /&gt;
An abstract page (sometimes referred to as a [[#Summary page|summary page]]) is a web page for an [[#Archive|archive]] providing [[#Metadata|metadata]] about a particular [[#EPrint|eprint]] (a.k.a [[#Publication record|publication record]]).  Most prominently it displays the abstract for the publication but also its title, [[#Citation|citation]] links to download associated [[#Document|documents]] and further metadata in a [[#Summary table|summary table]].&lt;br /&gt;
&lt;br /&gt;
Abstract pages are cached.  This cache is cleared when an eprint is modified.  Otherwise, these caches can be cleared, (so new cached version will be generated on next request), by running the following command or by clicking on the &amp;quot;[[Admin/System Tools/Regenerate Abstracts|Regenerate Abstracts]]&amp;quot; button in the [[#Admin menu|admin menu]]:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVEID&lt;br /&gt;
One or all abstracts pages can be regenerated by using the [[API:bin/generate_abstracts|bin/generate_abstracts]] command.&lt;br /&gt;
&lt;br /&gt;
=== Access ===&lt;br /&gt;
An [[Access Object|access]] is a [[#Data object|data object]] that represent a HTTP request accessing either an [[#Abstract page|abstract page]] or [[#Document|document]].&lt;br /&gt;
=== Actions tab ===&lt;br /&gt;
The actions tab appears on the [[#View page|view page]] for a [[#Data object|data object]].  However, typically the terms are used in the context of an [[#EPrint|eprint]].  This tab includes buttons to carry out various action against the data object.  For an eprint this may include:&lt;br /&gt;
* Depositing an item.&lt;br /&gt;
* Creating a new version (i.e. one that succeeds the current item).&lt;br /&gt;
* Using as a template to create a completely new item based on the current item.&lt;br /&gt;
* Editing an item.&lt;br /&gt;
* Removing an item (i.e. full deleting it from the [[#Archive|archive]]).  With or without a notification.&lt;br /&gt;
* Moving to the [[#Live archive|live archive]].&lt;br /&gt;
* Moving to the [[#Review buffer|review buffer]].&lt;br /&gt;
* Reindexing the item.&lt;br /&gt;
* Changing the [[#Depositing user|depositing user]] of the item.&lt;br /&gt;
* Exporting the item in one of various formats.&lt;br /&gt;
&lt;br /&gt;
=== Admin menu ===&lt;br /&gt;
The [[Admin|admin menu]] is only accessible to [[#Repository admin|repository admins]] that provides access to various administrative tools to manage their [[#Repository|repository]].&lt;br /&gt;
&lt;br /&gt;
=== Advanced search ===&lt;br /&gt;
An advanced search over [[#EPrint|eprints]] in the [[#Live archive|live archive]].  Unlike [[#Simple search|simple search]] this provides multiple input fields to individually search against particular [[#Metadata field|metadata fields]].  Advanced search configuration can be found in [[eprint_search_advanced.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Archive ===&lt;br /&gt;
Often conflated with [[#Repository| repository]].  [[#EPrints repository software|EPrints repository software]] provides a repository that can host multiple archives.  Commonly a repository will only host a single archive, so the terms are often used interchangeably.&lt;br /&gt;
&lt;br /&gt;
New archives can be created using the [[API:bin/epadmin|epadmin command]], as follows:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin create &amp;lt;zero|pub&amp;gt;&lt;br /&gt;
Where &amp;lt;tt&amp;gt;zero&amp;lt;/tt&amp;gt; is to create an archive with no [[#Flavour|flavour]] and &amp;lt;tt&amp;gt;pub&amp;lt;/tt&amp;gt; is to create an archive using the [[#Publication flavour|publication flavour]].  See [[Getting Started]] for more information.&lt;br /&gt;
&lt;br /&gt;
Content, configuration and sometimes code for an archive will be found at its [[#Archive level|archive level]], i.e.&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/&lt;br /&gt;
E.g. &amp;lt;tt&amp;gt;/opt/eprints3/archives/example/&amp;lt;/tt&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Archive ID ===&lt;br /&gt;
The ID of an [[#Archive|archive]].  This is set by the first input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  This will also be the directory name for the archive under [[#EPrints repository software|EPrints&#039;]] &#039;&#039;archives/&#039;&#039; sub-directory.   Guides on this wiki often use the placeholder &amp;lt;tt&amp;gt;ARCHIVEID&amp;lt;/tt&amp;gt;.&lt;br /&gt;
=== Archive level ===&lt;br /&gt;
This is a shorthand term to describe a configuration file that appears under the [[#Archive|archive]]&#039;s directory structure or to an effect that will only apply to a specific archive rather than the [[#Repository|repository]] as a whole, (which may have multiple archives). &lt;br /&gt;
=== Archive name ===&lt;br /&gt;
The name of an [[#Archive|archive]].  This is set by an early input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  Where the value set will be copied as a [[#Phrase|phrase]] to the archive&#039;s &#039;&#039;archive_name.xml&#039;&#039; under [[archives/ARCHIVEID/cfg/lang/en/phrases/]].&lt;br /&gt;
&lt;br /&gt;
== B ==&lt;br /&gt;
=== Back end pages ===&lt;br /&gt;
Same as [[#Management pages|management pages]].&lt;br /&gt;
&lt;br /&gt;
=== Bazaar ===&lt;br /&gt;
The [https://bazaar.eprints.org/ Bazaar] hosts EPrints packages of functionality ([[#EPM|EPMs]]), which can be installed on a [[#Repository|repository]] via the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] tool in the [[Admin]] web interface.&lt;br /&gt;
&lt;br /&gt;
=== Bazaar plugin ===&lt;br /&gt;
See [[#EPM|EPM]].&lt;br /&gt;
=== Box plugin ===&lt;br /&gt;
This is a type of [[#Plugin|plugin]] that generates a box containing some content or functionality, typically to be display at the top, bottom, left or right of an [[#EPrint|eprint]]&#039;s [[#Abstract page|abstract page]].  A common box plugin is the &#039;&#039;Tools&#039;&#039; plugin that typically appears at the top of abstract page provides the user with various export formats for the eprint.  [[#EPM|Bazaar plugins]] often include box plugins such as for [http://bazaar.eprints.org/555/ Altmetric] and the [http://bazaar.eprints.org/466/ CORE Recommender].&lt;br /&gt;
&lt;br /&gt;
=== Branding ===&lt;br /&gt;
Branding refers to the changing of the appearance of the web pages for your [[#Repository|repository]] or just a single [[#Archive|archive]].  Typically to line up with your institutional branding used on its other websites.  Advice is available on [[Branding with confidence]].  Branding is typically done by editing [[#Template|template]] configuration files and adding your own bespoke CSS, JavaScript and images/icons.  This can be done at an [[#Archive level|archive level]] of by creating a [[#Theme|theme]] so it can be applied to multiple archives hosted on the same repository.&lt;br /&gt;
&lt;br /&gt;
=== Browse view ===&lt;br /&gt;
A browse view is a collection of pages that display menus and listings of for all [[#Live archive|live archive]] [[#EPrint|eprints]] in an [[#Archive|archive]], organised by a particular [[#Metadata field|metadata field]]. By default these fields are: &#039;&#039;year&#039;&#039;, &#039;&#039;subjects&#039;&#039;, &#039;&#039;divisions&#039;&#039; and &#039;&#039;creators&#039;&#039;.&lt;br /&gt;
All the browse views can be found under the equivalent URL for archive to the following:&lt;br /&gt;
 https://example.eprints.org/view/&lt;br /&gt;
The configuration for browse views can be found in [[views.pl]], which by default is found under [[flavours/pub_lib/cfg.d/]] but should be copied to the archive&#039;s &#039;&#039;cfg/cfg.d/&#039;&#039; for editing.  See [[:Category:Browse_Views|browse views category]] for more information.&lt;br /&gt;
&lt;br /&gt;
Browse view pages are cached for a set period of time, by default 24 hours. However, these caches can be cleared earlier, (so new cached version will be generated on next request), by running the following command or by clicking on the &amp;quot;[[Admin/System Tools/Regenerate Views|Regenerate Views]]&amp;quot; button in the [[#Admin menu|admin menu]]:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin refresh_views ARCHIVEID&lt;br /&gt;
One, some or all browse views can be regenerated by using the [[API:bin/generate_views|bin/generate_views]] command.  Often these used as a cron job (i.e. scheduled task) so browse views caches can be updated overnight, when the server hosting the archive is less busy.&lt;br /&gt;
&lt;br /&gt;
=== Buffer ===&lt;br /&gt;
Shorthand for [[#Review buffer|Review buffer]].&lt;br /&gt;
&lt;br /&gt;
== C ==&lt;br /&gt;
=== Citation ===&lt;br /&gt;
In [[#EPrints repository software|EPrints repository software]] a citation means something slightly different from what it means in research publication.  For the former it refers to a text string describing a publication, which may more commonly described in research publications as a &#039;&#039;reference&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
EPrints repository software has citation style files, which describe how to generate the text string, not just for [[#EPrint|eprints]] but also other [[#Data object|data objects]], each of which can have different citation style files for different purposes.  These files can be found under [[lib/citations/]], [[flavours/pub_lib/citations/]] and the [[#Archive|archive]]&#039;s &#039;&#039;cfg/citations/&#039;&#039; directory.  &lt;br /&gt;
&lt;br /&gt;
See here for more information about the [[Citation Format|citation formats]] and a training video about [[Training_Video:Citation_Styles|citation styles]].&lt;br /&gt;
&lt;br /&gt;
=== Compound metadata field ===&lt;br /&gt;
A [[Compound field|Compound metadata field]] is a type of [[#Metadata field|metadata field]] that is made up of several sub-fields.  A good example of this is the &#039;&#039;Relationships&#039;&#039; field for an [[#EPrint|eprint]] [[#Data object|data object]].  This has two sub-fields one for the type or relation and the second for the actual thing (represented by a URI), that the eprint is related.&lt;br /&gt;
&lt;br /&gt;
=== Core codebase ===&lt;br /&gt;
The core codebase refers to the main code directories of the [[#EPrints repository software|EPrints repository software]].  In some contexts this refers to all directories except the archives directory which contains the configuration for individual [[#Archive|archives]].  In other contexts this refers to just the following directories (i.e. excludes [[#Flavour|flavours]], [[#Ingredient|ingredients]] and [[#Site lib|site_lib]], as well as non-code directories).&lt;br /&gt;
* [[bin/]]&lt;br /&gt;
* [[cgi/]]&lt;br /&gt;
* [[lib/]]&lt;br /&gt;
* [[perl_lib/]]&lt;br /&gt;
* [[tools/]]&lt;br /&gt;
&lt;br /&gt;
=== Core field ===&lt;br /&gt;
Same as a [[#System field|system field]].&lt;br /&gt;
&lt;br /&gt;
=== Contact page ===&lt;br /&gt;
This is a [[#Static page|static page]] that is accessible on an [[#Archive|archive]] at the equivalent URL to the following:&lt;br /&gt;
 https://example.eprints.org/contact.html&lt;br /&gt;
This page is intended to provided contact information, so to those accessing the archive can contact those responsible for it to report problems or ask questions.&lt;br /&gt;
&lt;br /&gt;
This page can be found at &#039;&#039;EPRINTS_PATH/lib/lang/en/static/contact.xpage&#039;&#039; but should be copied to the archive&#039;s &#039;&#039;cfg/lang/en/static/&#039;&#039; directory for [[How_to_modify_static_pages|editing]].  The email address displayed on this page comes from the &amp;lt;tt&amp;gt;$c-&amp;gt;{adminemail}&amp;lt;/tt&amp;gt; in [[adminemail.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Contributor ===&lt;br /&gt;
Sometimes an [[#EPrint|eprint]] has a contributor who could not usefully be described as a [[#Creator|creator]] or [[#Editor|editor]].  The contributor [[#Metadata field|metadata field]] is intended to allow these people to be associated with the eprint.  As well as being able to add the contributor&#039;s family and given name, the type of contributor can be specified.  This list of types is defined in &#039;&#039;EPRINTS_PATH/lib/namedsets/contributor_type&#039;&#039;.  If additional types are needed, then this file should be copied to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/namedsets/&#039;&#039; directory for editing.&lt;br /&gt;
&lt;br /&gt;
=== Creator ===&lt;br /&gt;
Creator (or creators) is a [[#Metadata field|metadata field]] for an [[#EPrint|eprint]].  Sometimes this is alternatively referred to as author but creator is a more generic term better suited to audio-visual/artistic as well as more traditional research publication items.&lt;br /&gt;
&lt;br /&gt;
A creator typically has several separate sub-fields:&lt;br /&gt;
* Given name (a.k.a. first name)&lt;br /&gt;
* Family name (a.k.a. surname)&lt;br /&gt;
* ID (typically email address)&lt;br /&gt;
&lt;br /&gt;
=== CRUD API ===&lt;br /&gt;
CRUD API (Create, Read, Update Delete Application Programming Interface) refers to a programmatic interface used for the management of [[#Data object|data objects]].  It is often also referred to as the [[#REST API|REST API]] as when it is called over HTTP it meets the requirements of a REST API.&lt;br /&gt;
&lt;br /&gt;
== D ==&lt;br /&gt;
=== Data flavour ===&lt;br /&gt;
As of [[#EPrints repository software|EPrints]] [https://www.eprints.org/uk/index.php/eprints-3.4/ 3.4] there are different flavours to service different purposes for a [[#Repository|repository]].  The data flavour is intended for repository hosted research data items, as opposed to research publications.&lt;br /&gt;
&lt;br /&gt;
=== Data object ===&lt;br /&gt;
A [[:Category:Data Objects|data object]] is a single record made up of [[#Metadata field|metadata fields]]. [[#EPrints repository software|EPrints repository software]] has various types of data object.  The most prominent are:&lt;br /&gt;
* [[EPrint Object]]&lt;br /&gt;
* [[User Object]]&lt;br /&gt;
* [[Document Object]]&lt;br /&gt;
* [[File Object]]&lt;br /&gt;
All the data objects of the same type make a [[#Dataset|dataset]].&lt;br /&gt;
&lt;br /&gt;
=== Dataset ===&lt;br /&gt;
A [[API:EPrints/DataSet|dataset]] is all the [[#Data object|data objects]] of a particular type within a single repository. (E.g. [[#EPrint|eprint]], [[#User|user]], [[#Document|document]], etc.).  [[#Virtual dataset|Virtual datasets]] exist for subsets of datasets such as [[#Live archive|live archive]], [[#Review buffer|review buffer]], etc.&lt;br /&gt;
&lt;br /&gt;
=== Depositing user ===&lt;br /&gt;
This is the user who created the [[#EPrint|eprint]] and has deposited it to the [[#Review buffer|review buffer]].&lt;br /&gt;
&lt;br /&gt;
=== Details tab ===&lt;br /&gt;
This is a tab in a [[#Data object|data object]]&#039;s [[#View page|view page]] that lists all its [[#Metadata field|metadata fields]] and their values.  Where a [[#Workflow|workflow]] exists for the data objects these metadata fields are separated into separate sections, depending on the [[#Workflow stage|workflow stage]] in which they appear.&lt;br /&gt;
&lt;br /&gt;
=== Division ===&lt;br /&gt;
This is a generic term to refer to a part of an organisation or institution, at any level of its hierarchy.  A division may be a faculty, school, department, academic unit or even research group.  If [[#EPrints repository software|EPrints repository software]] is used outside an academic context other names for sub-divisions may be applicable.&lt;br /&gt;
&lt;br /&gt;
Divisions is a default [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]].  It allows one or more divisions to be selected from a hierarchical list provided by the [[#Archive|archive]]&#039;s [[#Subject tree|subject tree]].  This can in turn be used to generate a [[#Browse view|browse view]] for divisions.&lt;br /&gt;
&lt;br /&gt;
=== Document ===&lt;br /&gt;
A [[Document Object|document]] is a [[#Second class data object|second class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]].  Documents must be part of an [[#EPrint|eprint]] object.  Sometimes the term is used interchangeably with the actual document file (e.g. a PDF, Word document, etc.).  To avoid confusion, it is best to refer to a document within EPrints as a &amp;quot;document object&amp;quot;.  A document object can be associated with multiple [[#File|file objects]].  Typically because derived files are generated to provide [[#Preview image|preview and thumbnail images]] but also because multiple files can be uploaded for a single document object.&lt;br /&gt;
&lt;br /&gt;
=== Document content ===&lt;br /&gt;
Document content is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It allows selections of a single value from a pre-defined list (i.e. a [[#Named set|named set]]) metadata field.  The options provided are intended to help describe the version of the document (e.g. draft, submitted version, accepted, updated) within the publication lifecycle or other types of content that may be uploaded (e.g. supplemental, presentation, cover image, metadata, bibliography, other).  These are based on the [http://eprints.lse.ac.uk/64948/1/LSE%20Library_Versions%20toolkit_Author_2008.pdf Versions toolkit for authors] but are analogous to other definitions, such as:&lt;br /&gt;
* Author&#039;s Original Manuscript (AOM) is equivalent to submitted.&lt;br /&gt;
* Accepted Manuscript (AM) is equivalent to accepted.&lt;br /&gt;
* Version of Record (VoR) is equivalent to published.&lt;br /&gt;
&lt;br /&gt;
=== Document security ===&lt;br /&gt;
Document security is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It defines who can access document file and any files in derived document objects (e.g. [[#Preview image|preview images]]).  By default this is one of three values:&lt;br /&gt;
* public - anyone&lt;br /&gt;
* validuser - registered [[#User|users]] (for the [[#Archive|archive]]) only.&lt;br /&gt;
* staffonly - repository staff (i.e. [[#Editor|editor]] and [[#Repository admin|repository administrator]] users) only.&lt;br /&gt;
If one of the last two option is applied with an [[#Embargo|embargo]] that expires on a certain date, then the security value for that document will be updated to &#039;&#039;public&#039;&#039; on that date.&lt;br /&gt;
&lt;br /&gt;
=== Documents directory ===&lt;br /&gt;
This is a directory found under the [[#Archive|archive&#039;s]] directory structure, (i.e. &#039;&#039;EPRINTS_PATH/archives/ARCHIVEID/documents/&#039;&#039;).  This is where the uploaded [[#Document|documents]] for an [[#EPrint|eprint]] are stored under the latter&#039;s own sub-directory (e.g. eprint 1234 has documents sub-directory &#039;&#039;documents/00/00/12/34/&#039;&#039;). Each document is stored in its own two-digit sub-directory based on its &#039;&#039;pos&#039;&#039; [[#Metadata field|metadata field]], which is zero-padded if the number is less than 10. The sub-directory also stores derived &amp;quot;documents&amp;quot; for those uploaded (e.g. preview and thumbnail images).  It also stores [[#Revision file|revision files]] in the eprint&#039;s own &#039;&#039;revisions&#039;&#039; sub-directory.&lt;br /&gt;
&lt;br /&gt;
=== Dynamic Pages ===&lt;br /&gt;
Dynamic pages are pages that are generated each time the page is loaded. The most common example of this is the search pages, another example is the [[#Latest tool | Latest tool]] page. Plugins may add additional pages, eg: irstats2 adds dynamic stats page.&lt;br /&gt;
&lt;br /&gt;
== E ==&lt;br /&gt;
=== Editor ===&lt;br /&gt;
On [[#EPrints repository software|EPrints repository software]] &#039;&#039;&#039;editor&#039;&#039;&#039; could refer to one of two different things:&lt;br /&gt;
# A type of EPrints [[#User|user]] that has permissions to access some or all [[#Publication record|publication records]] in the [[#Review buffer|review buffer]] to make amendments and either push the item to the [[#Live archive|live archive]] or return it to the [[#User workarea|user&#039;s workarea]].&lt;br /&gt;
# A [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]] to record editors of the publication, e.g. the editors for a book.  Like [[#Creator|creator]], by default this field has family name, given name and ID (i.e. email address) sub-fields.&lt;br /&gt;
&lt;br /&gt;
=== Editorial rights restriction ===&lt;br /&gt;
Same as [[#User review scope|user review scope]].&lt;br /&gt;
&lt;br /&gt;
=== Education flavour ===&lt;br /&gt;
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+. It is intended to produce repositories for open education.  I.e. for hosting files such as presentation slides, videos of lectures/seminars, instructions for learning tasks, in-class quizzes, etc.&lt;br /&gt;
&lt;br /&gt;
=== Embargo ===&lt;br /&gt;
[[#Document|Documents]] added to an [[#EPrint|eprint]] can have their access restricted.  Sometimes, this access need only be restricted for a set amount of time.  These documents can be embargoed until a set embargo date.  These can then be lifted of this date using the [[API:bin/lift_embargos|bin/lift_embargos]] script.  More recently embargoes allow a reason to be chosen from a predetermined set of options provided by the &#039;&#039;embargo_reason&#039;&#039; [[#Named set|named set]].&lt;br /&gt;
&lt;br /&gt;
=== EPM ===&lt;br /&gt;
EPM (EPrints Package Manager) is a package of functionality, sometimes referred to as a &#039;&#039;Bazaar plugin&#039;&#039;, which can be installed in an automated fashion, typically from the [[#Bazaar|Bazaar]].  It can sometimes refer to the pages for managing the installing of these packages, (e.g. the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] page available through the [[Admin]] web interface).&lt;br /&gt;
&lt;br /&gt;
=== EPrint ===&lt;br /&gt;
An [[EPrint Object|eprint]] is a [[#First class data object|first class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]]. These are often referred to as &#039;&#039;[[#Item|items]]&#039;&#039; or &#039;&#039;[[#Publication record|publication records]]&#039;&#039; as they are generally intended hold [[#Metadata|metadata]] about a publication of some kind.&lt;br /&gt;
&lt;br /&gt;
=== EPrint control page ===&lt;br /&gt;
Same as an [[#EPrint view page|eprint view page]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint history ===&lt;br /&gt;
This is the history of an [[#EPrint|eprint]] shown in the [[#History tab|history tab]] of the eprint&#039;s [[#View page|view page]].  It is generated from the [[#EPrint revision|eprint revision]] [[#Revision file|files]] generated each time an eprint is modified.  These are compared to display differences between revisions to track the eprint&#039;s history for administration purposes.&lt;br /&gt;
&lt;br /&gt;
=== EPrint locking ===&lt;br /&gt;
Whilst a [[#User|user]] is editing an [[#EPrint|eprint]] it is best that another user does not try to edit it as well.  When an eprint is locked, even permitted users will not be able to edit that record, unless they remove the edit lock.  Locks are automatically released when a user saves or cancels editing an eprint or (by default) 1 hour after the user started editing the eprint.&lt;br /&gt;
&lt;br /&gt;
=== EPrint revision ===&lt;br /&gt;
An EPrint revision is a numbered version of the [[#EPrint|eprint&#039;s]] [[#Metadata|metadata]] stored in the &#039;&#039;rev_number&#039;&#039; [[#Metadata field|metadata field]].  Revisions of eprints metadata are exported as XML [[#Revision file|revision files]] and stored under the [[#Documents directory|documents directory]] of the [[#Archive|archive]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint status ===&lt;br /&gt;
The status of an [[#EPrint|eprint]] represent the stage it is in the depositing lifecycle.  By default in [[#EPrints repository software|EPrints repository software]] this can be one of four states:&lt;br /&gt;
# [[#User workarea|User workarea]] - The eprint is still being edited by the [[#Depositing user|depositing user]] as there is still metadata they need to add or change.&lt;br /&gt;
# [[#Review buffer|Review buffer]] - The eprint has been submitted for review by an [[#Editor|editor]] for the [[#Archive|archive]].&lt;br /&gt;
# [[#Live archive|Live archive]] - The eprint has been reviewed by the editor and they have deposited it into the live archive for public access.&lt;br /&gt;
# [[#Retired|Retired]] - The eprint has been removed from the live archive as it is no longer appropriate for it to have public access.&lt;br /&gt;
&lt;br /&gt;
=== EPrint type ===&lt;br /&gt;
This is the type of publication the [[#EPrint|eprint]] represents.  The available types for a [[#Repository|repository]] are specified in a [[#Named set|named sets]] file. ( &#039;&#039;lib/namedsets/eprint&#039;&#039; or &#039;&#039;flavours/pub_lib/namedsets/eprint&#039;&#039;) or can be copied to the [[#Archive|archive]]&#039;s [[archives/ARCHIVEID/cfg/namedsets/]] directory to add extra types for a specific archive.  By default [[#EPrints repository software|EPrints]]&#039; [[#Publication flavour|publication flavour]] has the following type options:&lt;br /&gt;
 article&lt;br /&gt;
 book_section&lt;br /&gt;
 monograph&lt;br /&gt;
 conference_item&lt;br /&gt;
 book&lt;br /&gt;
 thesis&lt;br /&gt;
 patent&lt;br /&gt;
 artefact&lt;br /&gt;
 exhibition&lt;br /&gt;
 composition&lt;br /&gt;
 performance&lt;br /&gt;
 image&lt;br /&gt;
 video&lt;br /&gt;
 audio&lt;br /&gt;
 dataset&lt;br /&gt;
 experiment&lt;br /&gt;
 teaching_resource&lt;br /&gt;
 other&lt;br /&gt;
Type is by default presented on the first [[#Workflow stage|stage]] of the [[#EPrint workflow|EPrint workflow]], as the option chosen will affect the fields that can/need to be completed in later stages.&lt;br /&gt;
&lt;br /&gt;
=== EPrint URI ===&lt;br /&gt;
The URI for an [[#EPrint|eprint]] is its globally unique identifier.  In a form like:&lt;br /&gt;
 http://example.eprints.org/id/eprint/1234&lt;br /&gt;
Technically, a URI only need be an identifier and therefore not return the resource itself.  However, in the case of [[#EPrints repository software|EPrints repository software]], this will return the resource.  Prior to EPrints 3.4, this would be by redirecting to the [[#EPrint URL|eprint URL]] but since then the [[#Publication flavour|publication flavour]] uses the same string for the eprints URL and URI with the old style URL redirecting the longer URI format URL.&lt;br /&gt;
&lt;br /&gt;
=== EPrint URL ===&lt;br /&gt;
The URL of an [[#EPrint|eprint]] is the location it can be found at on the World Wide Web.  Historically with [[#EPrints repository software|EPrints repository software] it has taken a form like:&lt;br /&gt;
 http://example.eprints.org/1234/&lt;br /&gt;
However, since EPrints 3.4, it has been possible to configure the URL to take a long format like that of the [[#EPrint URI|eprint URI]]:&lt;br /&gt;
 http://example.eprints.org/id/eprint/1234&lt;br /&gt;
By using the following setting (typically in the [[#Archive|archive]]&#039;s &#039;&#039;cfg/cfg.d/[[20_baseurls.pl]]&#039;&#039;): &lt;br /&gt;
 $c-&amp;gt;{use_long_url_format] = 1;&lt;br /&gt;
By making this change the old style URL will still work but will redirect to the new format.  The reason for the change was to make it more apparent that the URL represented a publication within EPrints repository.  Web crawlers and bots often record links (i.e. URLs) they find on web pages but they don&#039;t actually access them.  In particular [https://scholar.google.com Google Scholar] would disregard these URLs without checking them, as there was nothing from the URL to indicate they represented a publication.  By adding &#039;&#039;/id/eprint/&#039;&#039; into the URL it makes it the URL distinct from other common URLs of the form &#039;&#039;&amp;lt;nowiki&amp;gt;http://HOSTNAME/ID&amp;lt;/nowiki&amp;gt;&#039;&#039;, which are mostly not URLs for EPrints [[#Abstract page|abstract pages]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint view page ===&lt;br /&gt;
The view page for an [[#EPrint|eprint]] is a multi-tabbed management page for that particular item.  It can typically be reached by clicking on the &#039;&#039;View Item&#039;&#039; link towards the bottom of an eprint&#039;s [[#Abstract page|abstract page]].  This page will tend to have the following tabs:&lt;br /&gt;
# [[#Preview tab|Preview]] - What will the abstract page look like when the eprint is moved to the [[#Live archive|live archive]].&lt;br /&gt;
# [[#Details tab|Details]] - The values for all the [[#Metadata field|metadata fields]] for the eprint.&lt;br /&gt;
# [[#Actions tab|Actions]] - All the actions that can be carried out against the eprint.&lt;br /&gt;
# [[#History tab|History]] - The [[#EPrint revision|revision]] history of the eprint.&lt;br /&gt;
# [[#Issues tab|Issues]] - The [[#Issue|issues]] detected for this eprint, if any.&lt;br /&gt;
&lt;br /&gt;
=== EPrint workflow ===&lt;br /&gt;
This is the [[#Workflow|workflow]] that pertains specifically to the [[EPrint Object|eprint data object]].&lt;br /&gt;
&lt;br /&gt;
=== EPrints repository software ===&lt;br /&gt;
Often shortened to just &#039;&#039;&#039;EPrints&#039;&#039;&#039; but not to be confused with multiple eprint data objects, (i.e. eprints). The actual software that can be used to create Open Access repositories and available as Open Source from [https://github.com/eprints/eprints3.4 GitHub].&lt;br /&gt;
&lt;br /&gt;
=== EPrints path ===&lt;br /&gt;
The path on your operating system under which EPrints repository software is installed.  Guides on this wiki often use the placeholder &amp;lt;tt&amp;gt;EPRINTS_PATH&amp;lt;/tt&amp;gt; to represent this.  Typically EPrints path will either be &#039;&#039;&#039;/opt/eprints3/&#039;&#039;&#039; or &#039;&#039;&#039;/usr/share/eprints/&#039;&#039;&#039; depending on how EPrints repository software was installed.&lt;br /&gt;
&lt;br /&gt;
=== EPrints release ===&lt;br /&gt;
A release of the [[#EPrints repository software|EPrints repository software]].&lt;br /&gt;
&lt;br /&gt;
=== EPrints version ===&lt;br /&gt;
Same as [[#EPrints release|EPrints release]] but with specific reference to a version number.&lt;br /&gt;
&lt;br /&gt;
=== EPrints XML ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] has its own XML schema for defining how [[#Data object|data objects]] should be described.  This schema can be found at the equivalent URL to:&lt;br /&gt;
 http://example.eprints.org/cgi/schema&lt;br /&gt;
&lt;br /&gt;
=== Event plugin ===&lt;br /&gt;
A type of [[#Plugin|plugin]] that generates [[#Indexer task|Indexer tasks]] to get the [[#Indexer|indexer]] to perform some asynchronous and potential long-running task.&lt;br /&gt;
&lt;br /&gt;
=== Event queue ===&lt;br /&gt;
The event queue contains all generated and yet to be successfully completed [[#Indexer task|indexer tasks]].  It can be accessed through the [[#Admin menu|admin menu]]&#039;s [[Admin/System Tools|System tools]] tab using the [[Admin/System Tools/Status|Status]] button and then clicking on the number next to the &#039;&#039;&#039;Background Task Queue&#039;&#039;&#039;.  There is also the [[Event Queue Object]], which is a [[#Data object|data object]] to represent an individual indexer task.&lt;br /&gt;
&lt;br /&gt;
=== Export plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a formatted export of a [[#Data object|data object]]&#039;s [[#Metadata|metadata]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository software]] has export plugins for many different formats, which can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Export/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/Export/]]&#039;&#039; directories.  Bespoke export plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Export/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Export/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
== F ==&lt;br /&gt;
=== File ===&lt;br /&gt;
A file is a [[#Third class data object|third class]] [[#Data object|data object]].  This is because it is a [[#Sub-object|sub-object]] of a [[#Document|document]] data object, which in turn is a sub-object of an [[#EPrint|eprint]] data object.  A file data object store metadata relevant to the file such as its filename, size, MIME type and modified time and a hash (by default MD5) to maintain the integrity of the file.  Typically uploading a document to an eprint will only create a single data object but it is possible to add additional files to a document after it is uploaded.&lt;br /&gt;
&lt;br /&gt;
File data objects are also used to capture XML [[#Revision file|revision files]] created for recording [[#EPrint revision|eprint revisions]].&lt;br /&gt;
&lt;br /&gt;
=== First class data object ===&lt;br /&gt;
[[#Data object|Data objects]] in [[#EPrints repository software|EPrints repository software]] take a particular order.  First class data objects are those that are not a sub-objects of other data objects, such as:&lt;br /&gt;
* [[#EPrint|eprint]]&lt;br /&gt;
* [[#User|user]]&lt;br /&gt;
Other data object may be described as either [[#Second class data object|second class]] or [[#Third class data object|third class]].  Usually a data object is only described as &amp;quot;first class&amp;quot; if it contains sub-objects.  Technically, [[#Subject|subject]] is a first class data object but as it contains no sub-objects, it in unnecessary to make the distinction.&lt;br /&gt;
&lt;br /&gt;
=== Flavour ===&lt;br /&gt;
From version 3.4 of [[#EPrints repository software|EPrints repository software]] different flavours have been introduced.  EPrints was originally designed as a [[#Repository|repository]] for research publications but over the years it has been repurposed for different tasks, which has led to the codebase getting a little messy.  So in [https://www.eprints.org/uk/index.php/eprints-3.4/ EPrints 3.4] a separate sub-directory structure was created to store code and configuration that makes EPrints suitable for a particular task, (i.e. a flavour).  There are three main flavours but most development has continued to focus on research publication:&lt;br /&gt;
# [[#Publication flavour|Publication flavour]] - For research publications.  Provided in &#039;&#039;[[flavours/pub_lib/]]&#039;&#039;.&lt;br /&gt;
# [[#Data flavour|Data flavour]] - For research data.  Provided in &#039;&#039;flavours/data_lib/&#039;&#039;.&lt;br /&gt;
# [[#Education flavour|Education flavour]] - For Open Education, i.e. teaching materials.  Provided in &#039;&#039;flavours/edu_lib/&#039;&#039;.&lt;br /&gt;
As well as flavours in EPrints 3.4, there are also &#039;&#039;[[#Ingredient|ingredients]]&#039;&#039;, which provide additional functionality, similar to a [[#Bazaar plugin|Bazaar plugin]] / [[#EPM|EPM]].  Any EPrints flavour has an &#039;&#039;inc&#039;&#039; file found in its top-level directory (e.g. &#039;&#039;flavours/pub_lib/inc&#039;&#039;).  This tells the flavour which paths to include.  By default, this would include the flavour itself.  It may also contain various ingredients and potentially [[#Site lib|site_lib]] if the repository has multiple [[#Archive|archives]], which require the same bespoke functionality.  However, it is better if this bespoke functionality can be converted into ingredients to separate out discrete parts of functionality.&lt;br /&gt;
&lt;br /&gt;
=== Front end pages ===&lt;br /&gt;
Same as [[#Public facing pages|public facing pages]].&lt;br /&gt;
&lt;br /&gt;
== G ==&lt;br /&gt;
== H ==&lt;br /&gt;
=== Help text ===&lt;br /&gt;
A help text is associated with a [[#Metadata field|metadata field]], providing advice on how this should be filled in as part of the [[#Workflow|workflow]].  This text is defined using a [[#Phrase|phrase]].  E.g. the phrase ID for the &#039;&#039;title&#039;&#039; metadata field of the [[#EPrint|eprint]] [[#Data object|data object]] is &#039;&#039;eprint_fieldhelp_title&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== History ===&lt;br /&gt;
A [[History Object]] is a [[#Second class data object|second class]] [[#Data object|data object]].  It is a [[#Sub-object|sub-object]] of any [[#First class data object|first class data object]] that supports [[#Revision|revisions]].  By default, this is only the [[#EPrint|eprint]] data object.  A history data object contains a revision number, a timestamp, a reference to a [[#User|user]] or an &amp;quot;actor&amp;quot; if the new revision is generated by a script and the &amp;quot;action&amp;quot; that is being carried out, (e.g. &#039;&#039;create&#039;&#039;, &#039;&#039;modify&#039;&#039;, &#039;&#039;move_buffer_to_archive&#039;&#039;, &#039;&#039;destroy&#039;&#039;, etc.)&lt;br /&gt;
&lt;br /&gt;
=== History tab ===&lt;br /&gt;
This tab refers to [[#EPrint history|eprint history]] or [[#User history|user history]] both make reference to changes between [[#Revision file|revision files]].  This tab can be found in the [[#View page|view page]] of the particular [[#EPrint|eprint]] or [[#User|user]]. (In the case of users this tab is labelled &amp;quot;User History&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Homepage ===&lt;br /&gt;
The homepage for an [[#Archive|archive]] is found at the top-level URL for a repository.  Usually, that is something like:&lt;br /&gt;
 https://example.eprints.org/&lt;br /&gt;
The homepage is a [[#Static page|static page]] although often contains dynamic elements, like the list of latest publications.  By default, the file is located at either &#039;&#039;[[lib/lang/en/static/|lib/lang/en/static]]/index.xpage&#039;&#039; or &#039;&#039;[[flavours/pub_lib/lang/en/static/|flavours/pub_lib/lang/en/static]]/index.xpage&#039;&#039; with the latter taking precedence if it exists.  Configuration for the archive ensure this page display bespoke information for your archive such as the [[#Archive name|archive name]].  However, you will most likely want to [[How_to_modify_static_pages|make changes to your homepage]], so you should copy the appropriate &#039;&#039;index.xpage&#039;&#039; to your archive&#039;s &#039;&#039;cfg/lang/en/static/&#039;&#039; directory, creating the directory if it does not already exist.&lt;br /&gt;
&lt;br /&gt;
== I ==&lt;br /&gt;
=== Import plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a formatted import of [[#Metadata|metadata]] for a [[#Data object|data object]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository software]] has import plugins for numerous different formats, which can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Import/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/Import/]]&#039;&#039; directories.  Bespoke import plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Import/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Import/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Inbox ===&lt;br /&gt;
Same as [[#User workarea|User workarea]].&lt;br /&gt;
&lt;br /&gt;
=== Inc file ===&lt;br /&gt;
The &#039;&#039;inc&#039;&#039; file is the critical part of a [[#Flavour|flavour]], which defines the paths that should be included for code and configuration.  It is found in the top-level directory of the flavour (e.g. &#039;&#039;/flavours/pub_lib/inc&#039;&#039;). Initially from the first sub-version of [[#EPrints repository software|EPrints]] 3.4 this will be just the path for the flavour (e.g. &#039;&#039;flavours/pub_lib&#039;&#039;) but increasingly core [[#Ingredient|ingredients]] will be added to this (e.g. for providing integration with the [[#Bazaar|Bazaar]] or for enabling different JavaScript libraries.  This is the only file outside the [[Archives/ARCHIVEID/|archive&#039;s directory structure]] that should need to be modified, unless you have a [[#Site lib|site_lib]].  However, the default inc file will probably not need changing in the case of most [[#Repository|repositories]].&lt;br /&gt;
&lt;br /&gt;
The ordering of paths within the inc file is important, as it determines, which configuration files get loaded and which takes precedence.  If you have a configuration file with the same filename in the &#039;&#039;cfg.d/&#039;&#039; directories for all three paths in the example inc file below, the file in &#039;&#039;site_lib&#039;&#039; will be used in precedence to the other two:&lt;br /&gt;
 flavours/pub_lib&lt;br /&gt;
 ingredients/bazaar&lt;br /&gt;
 site_lib&lt;br /&gt;
However, if you also have the same filename is the [[#Archive|archive]]&#039;s &#039;&#039;cfg/cfg.d/&#039;&#039; directory this will take precedence, although only for that archive, if you have a multi-archive repository.&lt;br /&gt;
&lt;br /&gt;
=== Indexer ===&lt;br /&gt;
The indexer is used by [[#EPrints repository software|EPrints repository software]] to carry out asynchronously tasks that may take a long time.  Typically, this would be indexing tasks, which include indexing of both the [[#Metadata|metadata]] for an [[#EPrint|eprint]] [[#Data object|data object]] and the full text (i.e. all the words in the PDF, Word, etc. document) for [[#Document|documents]] uploaded for those eprints.&lt;br /&gt;
&lt;br /&gt;
The Indexer can be managed through the [[#Admin menu|admin menu]] specifically, its [[Admin/System Tools|System Tools]] tab, which provides options to stop, start and force start the indexer.  Also, the [[Admin/System Tools/Status|Status]] option takes you to a page that lists the number of [[#Indexer task|tasks]] yet to be successfully completed by the indexer.  Commonly referred to as the &#039;&#039;[[#Event queue|event queue]]&#039;&#039; or &#039;&#039;background task queue&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== Indexer task ===&lt;br /&gt;
An indexer task is a scheduled operation to be carried out by the [[#Indexer|indexer]].  It is also a [[#Data object|data object]] in its own right but in this context is referred to as an [[Event Queue Object|event queue object]].  As until it is successfully completed it will appear in the [[#Event queue|event queue]].  An indexer task has several significant attributes:&lt;br /&gt;
* Status - Whether the task is &#039;&#039;Waiting&#039;&#039;, &#039;&#039;In Progress&#039;&#039; or &#039;&#039;Failed&#039;&#039;.&lt;br /&gt;
* Start time - The earliest time the indexer task can start.&lt;br /&gt;
* Plugin - The [[#Event plugin|event plugin]] that can perform this indexer task.&lt;br /&gt;
* Action - The specific action of the Event plugin for this indexer task.&lt;br /&gt;
* Parameters - The parameters needed to run the indexer task (e.g. the data object and potentially [[#Metadata field|metadata fields]] to be used by the indexer task.&lt;br /&gt;
&lt;br /&gt;
=== Ingredient ===&lt;br /&gt;
Since [[#EPrints repository software|EPrints]] version 3.4, the concept of [[EPrints Ingredients|ingredients]] has been introduced along with [[#Flavour|flavours]].  The main purpose of ingredients is to allow complex functionality to be developed but deployed in a way that does not make a mess of the existing [[#Core codebase|core codebase]] by spewing files in different places, like some [[#Bazaar plugin|Bazaar plugins]] can do.  Also, as Bazaar plugins are designed to be one-click install, they should require limited configuration, as this takes away from ease of deployment that one-click install implies.  Instead, ingredients can be much more complex.  Although effort should be taken to avoid mixing distinctly separate pieces of functionality when they could be kept apart.  &lt;br /&gt;
&lt;br /&gt;
Typically, an ingredient would be deployed by checking out a tagged version of the Git repository for that ingredient on [https://github.com/ GitHub].  Although that requires more technical knowledge than a one-click install, this is also inherently a safety feature, to avoid accidental installation of new functionality that could damage the data stored by the [[#Repository|repository]], which could happen when installing some of the more complex Bazaar plugins, without understanding of how they behave.&lt;br /&gt;
&lt;br /&gt;
=== Issue ===&lt;br /&gt;
An issue is a single row in a [[#Compound metadata field|compound]] [[#Multiple metadata field|multiple]] [[#Metadata field|metadata field]] that is part of an [[#EPrint|eprint]] [[#Data object|data object]]. It describes a potential problem discovered about a particular eprint. Unlike validation errors for specific metadata fields displayed whilst navigating the [[#EPrint workflow|eprint workflow]] issues are determined by comparing eprints across the [[#Dataset|dataset]] or checking for more subjective problems.  By default this includes:&lt;br /&gt;
* Duplicate titles - Two or more eprints have the exact same title.&lt;br /&gt;
* Similar titles - Two or more eprints share very similar titles.&lt;br /&gt;
* Old but unpublished - Date set for eprint is more than two years in the past but its publication status is still not published.&lt;br /&gt;
* Short family name - Family name for a creator is less than two characters or not set.  (Single name creators should always put this under family name).&lt;br /&gt;
Issues are checked for across all eprints in the [[#Live archive|live archive]] and [[#Review buffer|review buffer]] through a scheduled task running the &#039;&#039;bin/issues_audit&#039;&#039; script.  This can be deployed with a cron job similar to the following in the &#039;&#039;eprints&#039;&#039; user&#039;s crontab (substituting &#039;&#039;EPRINTS_PATH&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate&#039;&#039;):&lt;br /&gt;
 38 23 * * * EPRINTS_PATH/bin/issues_audit ARCHIVEID --quiet&lt;br /&gt;
Additional types of issue can be added in one of two ways:&lt;br /&gt;
# Creating a new Issues [[#Plugin|plugin]].&lt;br /&gt;
# Adding XML markup to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/issues.xml&#039;&#039;.&lt;br /&gt;
Issues for a particular eprint can be found under its [[#Issues tab|Issues tab]] of its [[#EPrint view page|view page]] or searched for through the [[#Admin menu|admin menu]]&#039;s [[Admin/Editorial Tools/Search issues|Search issues]] tool (under the [[Admin/Editorial Tools|Editorial Tools]] tab).&lt;br /&gt;
&lt;br /&gt;
=== Issues tab ===&lt;br /&gt;
This is a tab that appear on the [[#EPrint view page|eprint view page]] and lists the [[#Issue|issues]] associated with that [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
=== Item ===&lt;br /&gt;
Same as [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
== J ==&lt;br /&gt;
== K ==&lt;br /&gt;
&lt;br /&gt;
=== Key tools ===&lt;br /&gt;
Same as [[#User menu|user menu]].&lt;br /&gt;
&lt;br /&gt;
== L ==&lt;br /&gt;
=== Latest tool ===&lt;br /&gt;
The latest tool is a piece of functionally that allows JavaScript to be used to include a dynamically updating list of the latest [[#EPrint|eprints]] to be put into the [[#Live archive|live archive]] on to a [[#Static page|static page]] like the [[#Homepage|homepage]].  This is provided through a script that can be requested at the equivalent following URL:&lt;br /&gt;
 http://example.eprints.org/cgi/latest_tool&lt;br /&gt;
It can be configured in the archive&#039;s &#039;&#039;cfg/cfg.d/[[latest_tool.pl]]&#039;&#039; to set the number of eprints shown and the [[#Citation|citation]] style used.&lt;br /&gt;
&lt;br /&gt;
=== License ===&lt;br /&gt;
Sometimes spelt &#039;&#039;licence&#039;&#039;, is the licence under which a [[#Document|document]] is made available in an [[#Archive|archive]].  By default, [[#EPrints repository software|EPrints repository software]] provides the [https://creativecommons.org/licenses/ Creative Commons (v4) licenses] as options in the [[#Named set|named set]] file &#039;&#039;licenses&#039;&#039; in [[lib/namedsets/]]. These include:&lt;br /&gt;
* [https://creativecommons.org/licenses/by/4.0/ Creative Commons Attribution 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons: Attribution-ShareAlike 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc/4.0/ Creative Commons: Attribution-NonCommercial 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nd/4.0/ Creative Commons: Attribution-NoDerivatives 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc-sa/4.0/ Creative Commons: Attribution-NonCommercial-ShareAlike 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc-nd/4.0/ Creative Commons: Attribution-NonCommercial-NoDerivatives 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/publicdomain/ Creative Commons: Public Domain Dedication]&lt;br /&gt;
* [https://creativecommons.org/licenses/GPL/2.0/ Software: Creative Commons: GNU GPL 2.0]&lt;br /&gt;
* [https://creativecommons.org/licenses/LGPL/2.1/ Software: Creative Commons: GNU LGPL 2.1]&lt;br /&gt;
&lt;br /&gt;
=== Live archive ===&lt;br /&gt;
Live archive refers to both the [[#EPrint status|status]] or an [[#EPrint|eprint]] as well as a [[#Virtual dataset|virtual dataset]] of all eprints that have their status set to &#039;&#039;live archive&#039;&#039;.  When an editor reviews and is happy with an eprint, they will change its status to live archive, so it becomes publicly accessible.&lt;br /&gt;
&lt;br /&gt;
== M == &lt;br /&gt;
=== Main menu ===&lt;br /&gt;
The [[#EPrints repository software|EPrints]] main menu by default contains links to the main pages of interest for a [[#Visitor|visitor]] to an [[#Archive|archive]], this includes:&lt;br /&gt;
* Home - A link back to the archive&#039;s [[#Homepage|homepage]].&lt;br /&gt;
* About - A [[#Static page|static page]] providing information about the archive.&lt;br /&gt;
* Browse - A listing of [[#Browse view|browse views]] available for the archive.&lt;br /&gt;
** Browse by Year&lt;br /&gt;
** Browse by Subject&lt;br /&gt;
** Browse by Division&lt;br /&gt;
** Browse by Author&lt;br /&gt;
&lt;br /&gt;
=== Management pages ===&lt;br /&gt;
These are the pages in an [[#Archive|archive]] that can only be accessed by [[#User|users]] after they have logged in.  They include those pages accessible to [[#Regular user|regular users]] to add/edit their own [[#EPrint|eprints]] or manage their [[#User profile|user profile]].  But also more restricted administration pages such as those accessible through the [[#Admin menu|admin menu]].  &lt;br /&gt;
&lt;br /&gt;
These pages are sometimes alternatively referred to as [[#Back end pages|back end pages]].&lt;br /&gt;
&lt;br /&gt;
=== Metadata ===&lt;br /&gt;
[[Metadata]] is all the values for the [[#Metadata field|metadata fields]] for a particular [[#Data object|data object]].&lt;br /&gt;
&lt;br /&gt;
=== Metadata field ===&lt;br /&gt;
A [[:Category:EPrints_Metadata_Fields|metadata field]], sometimes shortened to &#039;&#039;&#039;metafield&#039;&#039;&#039; (or even just &#039;&#039;field&#039;&#039;) is part of a [[#Data object|data object]] and store a particular piece of pieces of information for that data object.  Metadata fields have different [[:Category:EPrints_Metadata_Fields#Metadata Field Types|types]] and have different types of properties roughly broken down into the following categories:&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Core Properties|Core]]&#039;&#039;&#039; - This includes the &#039;&#039;name&#039;&#039;, aforementioned &#039;&#039;type&#039;&#039;, whether it should have &#039;&#039;multiple&#039;&#039; values and whether to add an SQL index for it.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Rendering Properties|Rendering]]&#039;&#039;&#039; - This includes how the render the metadata field within [[#Abstract page|abstract pages]], [[#Browse view|browse views]] and search results, where applicable.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Input and Validation Properties|Input and validation]]&#039;&#039;&#039; -  This includes how to display the input for the metadata field within a [[#Workflow|workflow]] and any additional functionality to how this field is used of subsequently validated.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Ordering, Indexing and Searching|Ordering, indexing and searching]]&#039;&#039;&#039; - Whether the metadata field should be included in [[#EPrints repository software|EPrints repository software]]&#039;s full-text indexing and how the data object can be ordered or search over using this field.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Other Properties|Other]]&#039;&#039;&#039; - Miscellaneous properties, such as whether the metadata field&#039;s value(s) should be copied across to a cloned version of the data object or be able to be set through an import.  Also, whether the field its value should appear in various management pages within the [[#Repository|repository]] or in exports.&lt;br /&gt;
&lt;br /&gt;
=== Minimal user ===&lt;br /&gt;
Sometimes also referred to as &amp;quot;min user&amp;quot;.  This is a type of user account that only has minimal access to an [[#Archive|archive]].  Typically, these accounts are intended for those users that may need to access restricted [[#Document|documents]] but do not need to submit their own [[#EPrint|eprints]].  Also, if you have open [[#User registration|user registration]] enabled, you may want to prevent newly registered users from submitting eprints until you can confirm you are happy with their registration.&lt;br /&gt;
&lt;br /&gt;
=== Multiple metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] that allows for more than one value to be stored for it against a particular [[#Data object|data object]].  This can be configured by setting the field definition&#039;s &amp;lt;tt&amp;gt;multiple&amp;lt;/tt&amp;gt; attribute to 1.  A good example of a multiple metadata field is the &#039;&#039;Roles&#039;&#039; field for the [[#User|user]] data object.  This allow multiple roles to be assigned to a user, to enable bespoke permissions for that user.&lt;br /&gt;
&lt;br /&gt;
== N == &lt;br /&gt;
=== Named set ===&lt;br /&gt;
A [[Namedset_field|named set]] refers to both a type of [[#Metadata field|metadata field]] with the type name &#039;&#039;namedset&#039;&#039; and the file that defines the options for this type of metadata field.  A named set metadata field is much like a &#039;&#039;set&#039;&#039; field.  However, rather than defining the options within [[#EPrints repository software|EPrints repository software]]&#039;s Perl-based configuration, they can be added to a simple text file where each new option is separated by a new line.  Such as for [[#EPrint type|eprint types]].  &lt;br /&gt;
&lt;br /&gt;
Named set files by default can be found in either the [[lib/namedsets/]] or [[flavours/pub_lib/namedsets/]] directories.  If you need to edit them to add or remove options, then the file should be copied to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/namedsets/&#039;&#039; directory before editing.  It is generally advised not to modify an option in this file once your archive is in use.  It is better to change the [[#Phrase|phrase]] that relates to that option.  E.g.  the &#039;&#039;type&#039;&#039; field for an &#039;&#039;[[#EPrint|eprint]]&#039;&#039; would have the phrase &amp;lt;tt&amp;gt;eprint_typename_article&amp;lt;/tt&amp;gt; for the value &#039;&#039;article&#039;&#039; in &#039;&#039;flavours/pub_lib/namedsets/eprint&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
== O ==&lt;br /&gt;
=== OAI-PMH ===&lt;br /&gt;
[https://www.openarchives.org/pmh/ Open Archives Initiative - Protocol for Metadata Harvesting (OAI-PMH)] is a standard for harvesting metadata from Open Access [[#Archive|repository archives]] like those provided by [[#EPrints repository software|EPrints repository software]].  For this EPrints has a [[OAI_FAQ|separate interface for accessing OAI-PMH]], which is available at the equivalent following URL:&lt;br /&gt;
 http://example.eprints.org/cgi/oai2&lt;br /&gt;
&lt;br /&gt;
=== Order key ===&lt;br /&gt;
An &#039;&#039;&#039;order key&#039;&#039;&#039; or &#039;&#039;&#039;orderkey&#039;&#039;&#039; is the (potentially language-specific) string used to order by a particular [[#Metadata field|metadata field]]. [[#EPrints repository software|EPrints repository software]]&#039;s default orderkey generation can be overridden by defining your own orderkey method and assigning it to the &#039;&#039;make_value_orderkey&#039;&#039; or &#039;&#039;make_single_value_orderkey&#039;&#039; property of the metadata field. This property is passed value(s) and returns (an) &#039;&#039;ordervalue&#039;&#039; string(s) after processing the value(s) for that metadata field.  Typically, you may want to define your own order keys to manage special characters, maybe to avoid accented characters appearing separately in a browse view.  Some examples of bespoke order keys can be found in [[make_orderkey.pl]].&lt;br /&gt;
&lt;br /&gt;
== P ==&lt;br /&gt;
=== Plugin ===&lt;br /&gt;
These are Perl modules that &amp;quot;Plug in&amp;quot; to the EPrints software to provide a particular piece of functionality.  Default plugins for [[#EPrints repository software|EPrints repository software]] can be found under the &#039;&#039;[[perl_lib/EPrints/Plugin/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/]]&#039;&#039; directories  They break down into several categories.  The most prominent being:&lt;br /&gt;
* [[EPrints Glossary#Export plugin|Export plugins]]&lt;br /&gt;
* [[EPrints Glossary#Import plugin|Import plugins]]&lt;br /&gt;
* [[EPrints Glossary#Screen plugin|Screen plugins]]&lt;br /&gt;
Other plugin categories include [[#Box plugin|Box]], Convert, [[#Event plugin|Event]], InputForm, [[#Issue|Issues]], Search and Storage.  &lt;br /&gt;
&lt;br /&gt;
[[How_to_contribute#Write_a_Plugin|Bespoke plugins]] can be written for an [[#Archive|archive]] and located in the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
Often the term &amp;quot;[[#Bazaar plugin|Bazaar plugin]]&amp;quot; is used to refer to a package of functionality (a.k.a. [[#EPM|EPM]]) that can be installed from the [[#Bazaar|Bazaar]].  Although an EPM can often contain individual plugins, it is a complex set of files rather than a single plugin file.  If an EPM does contain individual plugins, they will be installed to the &#039;&#039;lib/plugins/EPrints/Plugin/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Phrase ===&lt;br /&gt;
A phrase in [[#EPrints repository software|EPrints repository software]] is some text or HTML markup associated with an associated placeholder ID defined using [[Phrase_Format|EPrints&#039; bespoke XML markup]].  Phrases have various purposes.  One is to ensure consistent use of terminology throughout the [[#Archive|archive]].  It also essential for supporting multi-language archives.  They are used for defining all [[#Metadata field|metadata field]] names and their [[#Help text|help texts]].  They are also used extensively in [[#Screen plugin|screen plugins]] to allow them to be customised with informative messages.&lt;br /&gt;
&lt;br /&gt;
A prominent example of a phrase is an archive&#039;s name which is appears in the archive&#039;s &#039;&#039;[[archives/ARCHIVEID/cfg/lang/en/phrases/|cfg/lang/en/phrases]]/archive_name.xml&#039;&#039;, as follows:&lt;br /&gt;
 &amp;lt;epp:phrase id=&amp;quot;archive_name&amp;quot;&amp;gt;Example Archive&amp;lt;/epp:phrase&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Policies page ===&lt;br /&gt;
The policies page is a [[#Static page|static page]] available at the equivalent URL to:&lt;br /&gt;
 http://example.eprints.org/policies.html&lt;br /&gt;
The page contains policies for use of the [[#Archive|archive]] typically based on [https://scholarlycommunications.jiscinvolve.org/wp/2020/04/03/an-update-from-opendoar-policy-support-and-repositories-galore/ OpenDOAR].  This contains sections for:&lt;br /&gt;
* &#039;&#039;&#039;Metadata Policy&#039;&#039;&#039; stating the access rights and permissions for information describing items in the repository, and the minimum metadata requirements.&lt;br /&gt;
* &#039;&#039;&#039;Data Policy&#039;&#039;&#039; stating the access rights and (re-)use permissions for full-text and other full data items.&lt;br /&gt;
* &#039;&#039;&#039;Content Policy&#039;&#039;&#039; stating the types and versions of documents and datasets held.&lt;br /&gt;
* &#039;&#039;&#039;Submission Policy&#039;&#039;&#039; concerning eligible depositors, quality control and copyright statements.&lt;br /&gt;
* &#039;&#039;&#039;Preservation Policy&#039;&#039;&#039; concerning the long-term retention, migration, and withdrawal protocols.&lt;br /&gt;
&lt;br /&gt;
=== Preview image ===&lt;br /&gt;
This is a thumbnails or larger image that is a snapshot of the uploaded [[#Document|document]].  This is typically displayed on the [[#Abstract page|abstract page]], where hovering over it will display a larger version, which may be useful in determining if the document in the one the [[#Visitor|visitor]] expected.  Preview images for a document can be generate from the command line using the [[API:bin/epadmin|epadmin]] command&#039;s &#039;&#039;redo_thumbnails&#039;&#039; option.&lt;br /&gt;
&lt;br /&gt;
=== Preview tab ===&lt;br /&gt;
The preview tab is part of the [[#EPrint view page|eprint view page]] which displays a preview of the [[#Abstract page|abstract page]] for the [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
=== Public facing pages ===&lt;br /&gt;
This is used to refer to web pages in an [[#Archive|archive]] that are accessible to [[#Visitors|visitors]] without need to login.  This are also sometimes referred to as [[#Front end pages|front end pages]].&lt;br /&gt;
&lt;br /&gt;
=== Publication flavour ===&lt;br /&gt;
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+.  It is intended to produce [[#Repository|repositories]] for research publications.  This code for this flavour was separated from the [[#Core codebase|core codebase]] for EPrints 3.4, so that EPrints as a whole could be more easily customisable for other purpose such as [[#Data flavour|research data]] and [[#Education flavour|open education]].  The separated code and configuration can be found under [[flavours/pub_lib/]], where configuration files override those under [[lib/]] but are overridden by those at an [[#Archive level|archive level]].&lt;br /&gt;
&lt;br /&gt;
=== Publication record ===&lt;br /&gt;
Same as [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
== Q ==&lt;br /&gt;
== R ==&lt;br /&gt;
=== Regular user ===&lt;br /&gt;
This is a [[#User|user]] whose account provides them with standard access to an [[#Archive|archive]] allowing then to deposit [[#EPrint|eprints]] for [[#Review buffer|review]] and manage their [[#User profile|user profile]].  With [[#EPrints repository software|EPrints repository software]] this type of user account just referred to as &amp;quot;user&amp;quot;.  When describing this user, the adjective &amp;quot;regular&amp;quot; is used to distinguish this specific type of user from users more generally.&lt;br /&gt;
&lt;br /&gt;
=== Repository ===&lt;br /&gt;
This is an individual installation of the [[#EPrints repository software|EPrints repository software]] onto a server.  A repository may host many [[#Archive|archives]] but they all use the same [[#Core codebase|core codebase]].  Sometimes a repository will host only a single archive and therefore, the terms repository and archive are often used interchangeably and often the latter is referred to as a &amp;quot;repository archive&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Repository admin ===&lt;br /&gt;
Short for repository administrator, this is a level of [[#User|user]] account that give maximum access to an [[#Archive|archive]].  Allowing the user to carry out [[#Regular user|regular user]] actions such as depositing an [[#EPrint|eprint]], [[#Editor|editorial]] actions like reviewing eprints submitted by a regular user and administrative actions, in particular those available through the [[#Admin menu|admin menu]].&lt;br /&gt;
&lt;br /&gt;
=== Request ===&lt;br /&gt;
This is a [[#Data object|data object]] that relates to a request made by a [[#User|user]] or [[#Visitor|visitor]] about a specific [[#EPrint|eprint]] or [[#Document|document]].  The most common request is [[#Request copy|request copy]] by a visitor for access to a document that is [[#Document security|restricted]].  In some [[#Archive|archives]] it may also be enabled to allow users to submit change requests to eprints in the [[#Live archive|live archive]], if they notice an error in their [[#Metadata|metadata]].&lt;br /&gt;
&lt;br /&gt;
=== Request copy ===&lt;br /&gt;
Sometimes also referred to as &amp;quot;request a copy&amp;quot; this is a button or link on an [[#Abstract page|abstract page]], allowing a [[#Visitor|visitor]] to request a copy of a [[#Document|document]] that is [[#Embargo|currently]] [[#Document security|restricted]].  If the [[#EPrint|eprint]] has its &#039;&#039;contact email&#039;&#039; [[#Metadata field|metadata field]] this will email that address with the request sent by the visitor.  If that email addresses matches that of a [[#User|user]] the email sent will contain accept and reject links.  Where the former will provide a link in the email response to the visitor, giving them temporary access to the restricted document.&lt;br /&gt;
&lt;br /&gt;
=== REST API ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] provides a standard [https://www.redhat.com/en/topics/api/what-is-a-rest-api REST API] that allows third-party applications to create, read, update and destroy various [[#Data object|data objects]] within an [[#Archive|archive]].  In EPrints, the REST API provides similar functionality to the [[#CRUD API|CRUD API]], albeit under a URL path like:&lt;br /&gt;
 https://example.eprints.org/rest/&lt;br /&gt;
&lt;br /&gt;
=== Retired ===&lt;br /&gt;
This is an [[#EPrint status|eprint status]] for [[#EPrint|eprints]] that have been in the [[#Live archive|live archive]] but have been removed for some reason.  The advantage of retiring an eprint rather than deleting it, is that it can be restored, if it was removed erroneously from the live archive.  Also, the [[#Abstract page|abstract page]] will display a message saying the eprint has been removed rather than a &amp;quot;404 Not Found&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Review buffer ===&lt;br /&gt;
This is an [[#EPrint status|eprint status]] of [[#EPrint|eprints]] that have be deposited by a [[#User|user]] but need to be reviewed by an [[#Editor|editor]] before being added to the [[#Live archive|live archive]].  Review buffer also refers to all eprints that currently have this status and can be accessed view the &#039;&#039;Review&#039;&#039; link in the [[#User menu|user menu]].&lt;br /&gt;
&lt;br /&gt;
=== Revision ===&lt;br /&gt;
Some [[#First class data object|first class data objects]] support [[#Revision file|revision files]] and [[#History|history data objects]] to track their changes over time.  By default there are only [[#EPrint revision|eprint revisions]].&lt;br /&gt;
&lt;br /&gt;
=== Revision file ===&lt;br /&gt;
This is a file on disk that stores [[#EPrints XML|EPrints XML]] markup for the [[#Metadata|metadata]] for a [[#Data object|data object]].  By default, revision files are only generated for [[#EPrint|eprints]] and can be found within the &#039;&#039;revisions&#039;&#039; directory for that eprint&#039;s sub-directory under the [[#Documents directory|documents directory]].  E.g.&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/documents/disk0/00/00/00/01/revisions/1.xml&lt;br /&gt;
The revisions are used in an eprint&#039;s [[#History tab|history tab]] to generate a listing of changes between one [[#EPrint revision|revision]] and the next.&lt;br /&gt;
&lt;br /&gt;
== S ==&lt;br /&gt;
=== Saved search ===&lt;br /&gt;
This is a [[#Second class data object|second class]] [[#Data object|data object]] that records the criteria of a particular search made by a [[#User|user]].  Its purpose is to allow the user (or even some [[Additional_Recipients_on_Saved_Searches|additional recipients]]) to receive regular email updates about results that meet these criteria.&lt;br /&gt;
&lt;br /&gt;
=== Screen plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a &amp;quot;screen&amp;quot;, which is effectively a dynamic page to allow the [[#User|user]] to carry out some action on the [[#Archive|archive]].  Some of the most significant screen plugins are for:&lt;br /&gt;
# Logging in and out of the archive.&lt;br /&gt;
# Managing a [[#Data object|data object]]&#039;s [[#Workflow|workflow]].&lt;br /&gt;
# Providing the [[#Admin menu|admin menu]].&lt;br /&gt;
# Reviewing [[#EPrint|eprints]].&lt;br /&gt;
# Editing [[#Subject|subjects]].&lt;br /&gt;
# Searching for users or eprints.&lt;br /&gt;
By default, screen plugins can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Screen/]]&#039;&#039; directory.  Bespoke screen plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Screen/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Screen/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Second class data object ===&lt;br /&gt;
These are [[#Data object|data objects]] that are [[#Sub-object|sub-objects]] of a [[#First class data object|first class data object]].  These include:&lt;br /&gt;
* [[Document Object]] (sub-object of [[#EPrint|eprint]]).&lt;br /&gt;
* [[History Object]] (sub-object of eprint or potentially any data object that has its history recorded).&lt;br /&gt;
* [[Saved Search Object]] (sub-object of [[#User|user]]).&lt;br /&gt;
&lt;br /&gt;
=== Simple search ===&lt;br /&gt;
A simple search over [[#EPrint|eprints]] in the [[#Live archive|live archive]].  Unlike [[#Advanced search|advanced search]] this provides a single input field to search against multiple [[#Metadata field|metadata fields]].  Simple search configuration can be found in [[eprint_search_simple.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Site lib ===&lt;br /&gt;
Creating a directory in the [[#EPrints path|EPrints path]] with the name &#039;&#039;site_lib&#039;&#039;, will allow you modify [[#Core codebase|core code and configuration]], which will apply to all of the [[#Archive|archives]] in your [[#Repository|repository]].  If you are running EPrints version 3.4+, be sure to also add &#039;&#039;site_lib&#039;&#039; to your [[#Flavour|flavour&#039;s]] [[#Inc file|inc file]].&lt;br /&gt;
&lt;br /&gt;
Sometimes you may need modify the functionality of files in the core codebase but you don&#039;t want to change them, as this will involve having to merge any future changes when you upgrade [[#EPrints repository software|EPrints repository software]].  This is particularly useful if you need to modify a non-plugin code file, ([[#Plugin|plugin]] files can be [[Instructions_for_local_plugins|overridden]] by [[#Archive level|archive level]] versions), E.g. &#039;&#039;[[API:EPrints/Repository|perl_lib/EPrints/Repository.pm]]&#039;&#039;, which can simply be copied to &#039;&#039;site_lib/EPrints/plugins/Repository.pm&#039;&#039; rather than modifying it in place.  However, when you do upgrade EPrints, you will still need to reconcile any updates to the &#039;&#039;perl_lib/&#039;&#039; version of this file with your version in &#039;&#039;site_lib/plugins/&#039;&#039;.  This will be a much more straightforward task, (than if you had just modified the version in &#039;&#039;perl_lib/&#039;&#039;), as both files will still be in place to compare.  One particular use of &#039;&#039;site_lib&#039;&#039; is for inter-version patches from [https://github.com/eprints/eprints3.4|EPrints&#039; GitHub].  As when it comes to an upgrade, the versions of the files in &#039;&#039;site_lib/plugins/&#039;&#039; can just be removed, as their modifications will be present in their &#039;&#039;perl_lib/&#039;&#039; equivalents.&lt;br /&gt;
&lt;br /&gt;
=== Staff search ===&lt;br /&gt;
Search across all [[#EPrint|eprints]] whatever their [[#EPrint status|eprint status]].  See [[Admin/Editorial Tools/Search items]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== Static page ===&lt;br /&gt;
This is a page for an [[#Archive|archive]] that contains static content that can be cached.  Although it may also contain dynamic elements through the use of JavaScript and [https://en.wikipedia.org/wiki/Ajax_(programming) Ajax].  Examples of static pages are:&lt;br /&gt;
* The [[#Homepage|homepage]]&lt;br /&gt;
* The about/information page (e.g. &amp;lt;tt&amp;gt;http://example.eprints.org/information.html&amp;lt;/tt&amp;gt;)&lt;br /&gt;
* The [[#Contact page|contact page]] &lt;br /&gt;
* The [[#Policies page|policies page]]&lt;br /&gt;
To clear the caches of old static pages and other static content (like JavaScript and CSS) and generate new cached versions, the [[API:bin/generate_static|bin/generate_static]] command can be used.&lt;br /&gt;
&lt;br /&gt;
Other pages like [[#Browse view|browse view]] menus and listings and [[#Abstract page|abstract pages]] are also cached as they contain static content, which only need be updated periodically or when the underlying [[#EPrint|eprint]] changes.  These are sometimes also referred to as static pages but can be refreshed using [[API:bin/epadmin#|bin/epadmin]] command (or through the [[Admin/System Tools|Admin menu]]) or regenerated using the [[API:bin/generate_views|bin/generate_views]] and [[API:bin/generate_abstracts|bin/generate_abstracts]] commands.&lt;br /&gt;
&lt;br /&gt;
=== Sub-object ===&lt;br /&gt;
This is a concept where a [[#Data object|data object]] is part of another data object, such as a [[#Document|document]] being part of an [[#EPrint|eprint]].  Where the former is known as a [[#Second class data object|second class data object]] and the latter is known as a [[#First class data object|first class data object]].  &lt;br /&gt;
&lt;br /&gt;
[[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]] is an abstract class within [[#EPrints repository software|EPrints repository software]], which second class (and [[#Third class data object|third class]]) data object classes extend.&lt;br /&gt;
&lt;br /&gt;
=== Subject ===&lt;br /&gt;
A [[Subject Object|subject]] is a [[#Data object|data object]] that stores a node for the [[#Subject tree|subject tree]] of an [[#Archive|archive]].  &lt;br /&gt;
&lt;br /&gt;
A subject has three separate [[#Metadata field|metadata fields]] to describe the value it represents:&lt;br /&gt;
* &#039;&#039;&#039;ID&#039;&#039;&#039; - A short text string providing the unique ID for that subject.&lt;br /&gt;
* &#039;&#039;&#039;Name&#039;&#039;&#039; - The human-readable name for that subject.&lt;br /&gt;
* &#039;&#039;&#039;Sort value&#039;&#039;&#039; - The value used to determine the ordering of the subject amongst its siblings in the subject tree (e.g. in a [[#Browse view|browse view]]).&lt;br /&gt;
&lt;br /&gt;
A subject also contains a &#039;&#039;&#039;parent&#039;&#039;&#039; metadata field that links it into the rest of the subject tree and a &#039;&#039;&#039;depositable&#039;&#039;&#039; metadata field that indicate whether it is an option that can be selected when the subject tree or part thereof is used to provide a metadata field for another data object (e.g. [[#EPrint|eprint]]).&lt;br /&gt;
&lt;br /&gt;
=== Subject tree ===&lt;br /&gt;
This is made up of [[#Subject|subject]] [[#Data object|data objects]] and is used to provide hierarchical sets of options for various [[#Metadata field|metadata fields]] or other data objects, such as [[#EPrint|eprints]], as a [[Subject_field|subject metadata field]].  In particular:&lt;br /&gt;
* &#039;&#039;&#039;eprint subjects&#039;&#039;&#039; - Records one or more subjects (e.g. from the Library of Congress or Dewey decimal classifications) under which the publication represented by this eprint covers.&lt;br /&gt;
* &#039;&#039;&#039;eprint [[#Division|divisions]]&#039;&#039;&#039; - Records one or more divisions within an organisation/institution (e.g. faculty, school, department, etc.) for which authors of the publication represented by the eprint are members.&lt;br /&gt;
The subject tree can be edited by the [[#Admin menu|admin menu]] using the &amp;quot;[[Admin/Config. Tools/Edit subject|Edit subject]]&amp;quot; page.&lt;br /&gt;
&lt;br /&gt;
=== Succeeds ===&lt;br /&gt;
An [[#EPrint|eprint]] [[#Data object|data object]] contains a [[#Metadata field|metadata field]] called &#039;&#039;succeeds&#039;&#039;.  This metadata field can store the ID of an eprint for which the current eprint supersedes.  This may be used where a new version of the publication is produced but you don&#039;t want to or cannot replace the [[#Document|document]] in the original eprint.  By using the succeeds field, the original eprint will be removed from search and its [[#Abstract page|abstract page]] will display a warning saying it is not the latest version of the eprint.&lt;br /&gt;
&lt;br /&gt;
=== Summary page ===&lt;br /&gt;
Same as [[#Abstract page|abstract page]].  Sometimes even referred to as the abstract/summary page.&lt;br /&gt;
&lt;br /&gt;
=== Summary table ===&lt;br /&gt;
A table on an [[#Abstract page|abstract page]] that lists the names and values for specific [[#Metadata field|Metadata fields]] for the [[#EPrint|eprint]].  These can be specified, typically in the archive&#039;s &#039;&#039;cfg/cfg.d/[[eprint_render.pl]]&#039;&#039;, under &amp;lt;tt&amp;gt;$c-&amp;gt;{summary_page_metadata}&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Sword API ===&lt;br /&gt;
This is an API provided by [[#EPrints repository software|EPrints repository software]] that complies with the [https://guides.dataverse.org/en/latest/api/sword.html SWORD specification] for a RESTful API.  It is similar to EPrints&#039; [[#CRUD API|CRUD]] and [[#REST API|REST]] APIs but is intended to facilitate smoother interoperability between different types of Open Access repository, using an [https://datatracker.ietf.org/wg/atompub/about/ atompub] based XML format and the [https://www.dublincore.org/specifications/dublin-core/dcmi-terms/ Dublin Core schema] for [[#Metadata|metadata]] terms.&lt;br /&gt;
&lt;br /&gt;
=== System field ===&lt;br /&gt;
A [[#Metadata field|metadata field]] that is core to a [[#Data object|data object]].  Usually this field is for administrative field of little interest to a visitor or regular user but required for the management of the data object.  Typically such fields are hard-coded into the data object rather than customisable in configuration.  E.g. the &amp;lt;tt&amp;gt;dir&amp;lt;/tt&amp;gt; field for an [[#EPrint|eprint]] that records the location where uploaded [[#Document|documents]] to an eprint should be store on the filesystem.&lt;br /&gt;
&lt;br /&gt;
== T ==&lt;br /&gt;
=== Template ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] uses templates to apply [[#Branding|branding]] to a [[#Repository|repository]] or individual [[#Archive|archive]].  These templates provide the HTML structure for an archive&#039;s web pages and can be found in one of the following directories:&lt;br /&gt;
# [[lib/templates/]]&lt;br /&gt;
# [[flavours/pub_lib/lang/en/templates/]]&lt;br /&gt;
# [[archives/ARCHIVEID/cfg/templates/]]&lt;br /&gt;
# [[archives/ARCHIVEID/cfg/lang/en/templates/]]&lt;br /&gt;
However, there are additional directories templates maybe found if you use [[#Site lib|site_lib]] or a [[#Theme|theme]].  The higher the number determines which template will be used if they have the same name.&lt;br /&gt;
&lt;br /&gt;
The main template file is called &#039;&#039;&#039;default.xml&#039;&#039;&#039;, which will be used if not otherwise specified in the XML markup for the [[#Static page|static page]]. Also, other [[#Public facing pages|public facing pages]] such as [[#Simple search|simple]] and [[#Advanced search|advanced]] search, [[#Abstract page|abstract pages]] and [[#Browse view|browse views]] will use the default template.  Since EPrints version 3.4. [[#Management pages|management pages]] will use the &#039;&#039;&#039;default_internal.xml&#039;&#039;&#039; template.&lt;br /&gt;
&lt;br /&gt;
Bespoke template files can be defined and used (e.g. &#039;&#039;mytemplate.xml&#039;&#039;).  For applying to static pages this can be done by setting the &amp;lt;tt&amp;gt;&amp;lt;xpage:template&amp;gt;&amp;lt;/tt&amp;gt;.  For applying to browse views by setting the &amp;lt;tt&amp;gt;template&amp;lt;/tt&amp;gt; attribute for the view in [[views.pl]] and for applying to abstract pages setting the &amp;lt;tt&amp;gt;$template&amp;lt;/tt&amp;gt; in the parameters returned by &amp;lt;tt&amp;gt;$c-&amp;gt;{eprint_render}&amp;lt;/tt&amp;gt; in [[eprint_render.pl]].  See [[Branding_with_confidence#Taking_control|Branding with confidence - Taking control]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== Theme ===&lt;br /&gt;
If you have multiple [[#Archive|archives]] you want to apply the same [[#Branding|branding]] you may want to create a theme.  Themes can be found at &#039;&#039;[[lib/themes/]]&#039;&#039; and can be used by an archive by modifying the following setting in [[branding.pl]]:&lt;br /&gt;
 $c-&amp;gt;{theme} = &#039;THEMEID&#039;;&lt;br /&gt;
A theme can contain [[#Template|templates]], [[#Phrase|phrases]], [[#Static page|static pages]], JavaScript, CSS, images and icons.  Also, as the theme has its own  directory structure, it is easy to manage under version control and checkout across multiple [[#Repository|repositories]] or even make into an [[#EPM|EPM]].&lt;br /&gt;
&lt;br /&gt;
=== Third class data object ===&lt;br /&gt;
These are [[#Data object|data objects]] that are sub-objects of [[#Second class data object|second class data objects]] to exist, which in turn are sub-objects of [[#First class data object|first class data objects]].  The main example of such a data object in [[#EPrints repository software|EPrints repository software]] is a [[#File|file]] data object.&lt;br /&gt;
 File --sub-object of--&amp;gt; Document --sub-object of--&amp;gt; EPrint&lt;br /&gt;
&lt;br /&gt;
=== Trigger ===&lt;br /&gt;
[[Triggers]] allow a function to be defined that will be called at a particular execution point.  Such as before or after an eprint record is committed or when rewriting the request for a URL to return the appropriate resource.&lt;br /&gt;
&lt;br /&gt;
== U ==&lt;br /&gt;
=== User ===&lt;br /&gt;
A [[User Object|User]] is a [[#First class data object|first class]] [[#Data object|Data object]] in [[#EPrints repository software|EPrints repository software]].  It represents a user of [[#Repository|Repository]] and provides an account under which that user can login.  Storing [[#Metadata|metadata]] about that user, such as their username, given and family names, email address, department, etc.&lt;br /&gt;
&lt;br /&gt;
=== User history ===&lt;br /&gt;
This is the history of changes the [[#User|user]] has made to an [[#EPrint|eprint]] (or in fact any [[#First order data object|first order data object]] that supports [[#Revision|revisions]]) and can be found in the [[#History tab|user history tab]] on the user&#039;s [[#View page|view page]].  This is compiled by finding all [[#History|history data objects]] for the particular user and then comparing these associated revision files with their previous revision files.&lt;br /&gt;
&lt;br /&gt;
=== User menu ===&lt;br /&gt;
This is the menu available to [[#User|users]] once they are logged in.  (Although it does contain the &amp;quot;Login&amp;quot; and &amp;quot;[[#User registration|Create account]]&amp;quot; links when a user is not logged in).  This is sometimes also referred to as [[#Key tools|key tools]], as that is the ID used in configuration. By default, this contains the following options:&lt;br /&gt;
* &#039;&#039;&#039;Manage deposits&#039;&#039;&#039; - Create and edit [[#EPrint|eprint]] [[#Data object|data objects]].&lt;br /&gt;
* &#039;&#039;&#039;Manage records&#039;&#039;&#039; - Create and edit various types of data object &#039;&#039;([[#Repository admin|repository admins only]])&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Profile&#039;&#039;&#039; - View and edit the current [[#User profile|user&#039;s profile]].&lt;br /&gt;
* &#039;&#039;&#039;Saved searches&#039;&#039;&#039; - View and edit the current user&#039;s [[#Saved search|saved searches]].&lt;br /&gt;
* &#039;&#039;&#039;Review&#039;&#039;&#039; - Review eprints deposited by users into the [[#Review buffer|review buffer]] to see if they can be moved to the [[#Live archive|live archive]] &#039;&#039;([[#Editor|editors]] and repository admins only)&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Admin&#039;&#039;&#039; - Links to the [[#Admin menu|admin menu]] &#039;&#039;(repository admins only)&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Logout&#039;&#039;&#039; - logout of the [[#Archive|archive]] as the current user.&lt;br /&gt;
Additional links (for [[#Screen plugin|screen plugins]]) can be added to the user menu by editing adding a line like the following to a configuration file in the archive&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory:&lt;br /&gt;
 $c-&amp;gt;{plugins}-&amp;gt;{&amp;quot;Screen::MyScreenPlugin&amp;quot;}-&amp;gt;{appears}-&amp;gt;{key_tools} = 1000;&lt;br /&gt;
The number (i.e. 1000) specifies the position the link to this screen plugin will appear relative to others.  The higher the number the later in the menu it will appear.&lt;br /&gt;
&lt;br /&gt;
To add the user menu to a [[#Template|template]], you need to include the following snippet of [[#EPrints XML|EPrints XML]]:&lt;br /&gt;
 &amp;lt;epc:pin ref=&amp;quot;login_status&amp;quot;/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== User privilege ===&lt;br /&gt;
An action a [[#User|user]] is permitted to perform.  See [[User Roles and Privileges]].&lt;br /&gt;
&lt;br /&gt;
=== User profile ===&lt;br /&gt;
A page displaying the [[#Metadata|metadata]] about a [[#User|user]].  This often links to a page where these metadata can be modified.&lt;br /&gt;
&lt;br /&gt;
=== User registration ===&lt;br /&gt;
By default, [[#EPrints repository software|EPrints repository software]] allows [[#User|users]] to register by following the &amp;quot;Create account&amp;quot; link in the [[#User menu|user menu]].  This allows them to create a user account, which most then be activated by clicking the link on an email sent to the email address for the is registered user.  &lt;br /&gt;
&lt;br /&gt;
Often you may not want unrestricted user registration.  If this is the case, you should copy [[registration.pl]] that can be found in [[lib/cfg.d/]] to the [[#Archive level|archive level]] (i.e. the archive&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory) and change the following setting to 0:&lt;br /&gt;
 $c-&amp;gt;{allow_web_signup} = 0;&lt;br /&gt;
&lt;br /&gt;
=== User review scope ===&lt;br /&gt;
[[#Editor|editor]] [[#User|users]] are allowed to review deposited [[#EPrint|eprints]] in the [[#Review buffer|review buffer]] to check whether the can be moved to the [[#Live archive|live archive]] and make any modifications required.  Sometimes you may only want a particular editor to be able to review certain eprints, which are in their area of expertise.  This can be done by setting their [[#Editorial rights restriction|editorial rights restriction]] in their [[#User profile|user profile]].  By default, restrictions can be set on the following three eprint fields:&lt;br /&gt;
* [[#Division|divisions]]&lt;br /&gt;
* [[#Subject|subjects]]&lt;br /&gt;
* [[#EPrint type|type]]&lt;br /&gt;
However, this can be modified by copying [[user_review_scope.pl]] to the [[#Archive level|archive level]] (i.e. the [[#Archive|archive]]&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory) and edit the setting &amp;lt;tt&amp;gt;$c-&amp;gt;{editor_limit_fields}&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== User role ===&lt;br /&gt;
A set of [[#User privileges|privileges]] that a [[#User|user]] has permission to perform.  See [[User Roles and Privileges]].&lt;br /&gt;
&lt;br /&gt;
=== User search ===&lt;br /&gt;
A form for searching across the [[#User|users]] in an [[#Archive|archive]].  See [[Admin/Editorial Tools/Search users|Search users]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== User workarea ===&lt;br /&gt;
This is the status of an [[#EPrint|eprint]] whilst it is being edited by the [[#Depositing user|depositing user]].  This status is often also referred to as [[#Inbox|inbox]].  User workarea can sometimes refer to the &#039;&#039;Manage deposits&#039;&#039; page where the current [[#User|user]] can see a listing of all the EPrints they have created.&lt;br /&gt;
&lt;br /&gt;
== V ==&lt;br /&gt;
=== View page ===&lt;br /&gt;
The view page displays information about a [[#Data object|data object]], typically an [[#EPrint|eprint]].  This is why &amp;quot;view page&amp;quot; is often used as shorthand for [[#EPrint view page|eprint view page]].&lt;br /&gt;
&lt;br /&gt;
=== Virtual dataset ===&lt;br /&gt;
A virtual [[#Dataset|dataset]] is one that is derived from a real dataset.  In particular, [[#EPrints repository software|EPrints repository software]] has virtual datasets for:&lt;br /&gt;
* [[#Live archive|Live archive]] &lt;br /&gt;
* [[#Review buffer|Review buffer]] &lt;br /&gt;
* [[#User workarea|User workarea]] &lt;br /&gt;
* [[#Retired|Retired]] &lt;br /&gt;
All of these are sub-sets of the [[#EPrint|eprint]] dataset where the [[#EPrint status|eprint status]] is a particular value.  &lt;br /&gt;
&lt;br /&gt;
Additional virtual datasets can be configured for a [[#Repository|repository]] or at an [[#Archive level|archive level]]. &lt;br /&gt;
&lt;br /&gt;
=== Virtual metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] whose values are not actually stored in the database but are generated dynamically by a function probably using the values of one or more other metadata fields.  This may be useful when editing the [[#Citation|citation]] style as part of designing your [[#Archive|archive]]&#039;s [[#Abstract page|abstract page]], as being able to reference a field is very straightforward.  A basic example might be that you want to display on the abstract page the number of [[#Document|documents]] for the [[#EPrint|eprint]].  Creating a virtual field for the eprint called &#039;&#039;num_docs&#039;&#039; might look as follows:&lt;br /&gt;
 {&lt;br /&gt;
   name =&amp;gt; &#039;num_docs&#039;,&lt;br /&gt;
   type =&amp;gt; &#039;int&#039;,&lt;br /&gt;
   virtual =&amp;gt; 1,&lt;br /&gt;
   render_value =&amp;gt; &#039;get_num_docs&#039;,&lt;br /&gt;
 },&lt;br /&gt;
Then you would define a function in a configuration file and assign it to &amp;lt;tt&amp;gt;$c-&amp;gt;{get_num_docs}&amp;lt;/tt&amp;gt;.  You could then simply include this in the &#039;&#039;summary_page.xml&#039;&#039; eprint citation file as:&lt;br /&gt;
 &amp;lt;epc:print expr=&amp;quot;num_docs&amp;quot;/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Visitor ===&lt;br /&gt;
A visitor to an [[#Archive|archive]] is distinguished from a [[#User|user]], as they are not logged in and they are accessing the archive anonymously.  They are probably just wanting to view an [[#Abstract page|abstract page]] or download an open access publication [[#Document|document]].&lt;br /&gt;
&lt;br /&gt;
=== Volatile metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] that is liable to change on a regular basis but does not really affect the overall content of the [[#Data object|data object]]&#039;s [[#Metadata|metadata]], so should not prompt a new [[#Revision|revision]] to be generated.  A metadata field can be made volatile by setting the following attribute in the field definition:&lt;br /&gt;
 volatile =&amp;gt; 1,&lt;br /&gt;
Metadata fields that are only intended for administrative purposes are often defined as volatile, such as the [[#EPrint|eprint]] [[#EPrint locking|edit_lock]] metadata field.  If a [[#User|user]] takes an edit lock on an eprint, if the edit_lock metadata field was non-volatile, this would lead to a new revision being create for the eprint when ultimately nothing had yet changed.  In fact, worse still, if the edit lock was released without making any changes, a further revision would be created, which would be basically the same as the revision before the user took the edit lock.&lt;br /&gt;
&lt;br /&gt;
== W ==&lt;br /&gt;
=== Workflow ===&lt;br /&gt;
[[#First class data object|First class]] [[#Data object|data objects]] in [[#EPrints repository software|EPrints repository software]] have a workflow to allow the metadata they store to be edited via a sequence of forms.  The most common of these is the [[#EPrint workflow|eprint workflow]] for the [[EPrint Object|eprint data object]].  By default the configuration for this workflow is written in XML and can be found in &#039;&#039;default.xml&#039;&#039; in either [[lib/workflows/eprint/]] or [[flavours/pub_lib/workflows/eprint/]]. If this needs to be modified it should be copied to the archive&#039;s [[Archives/ARCHIVEID/cfg/workflows/eprint/|cfg/workflows/eprint/]] directory before editing.  Explanation of the various elements and attributes are described in the [[Workflow_Format|workflow format guide]].&lt;br /&gt;
&lt;br /&gt;
=== Workflow component ===&lt;br /&gt;
These provide sections (i.e. boxes) within each [[#Workflow stage|workflow stage]].  A workflow component contain one or more [[#Metadata field|metadata fields]] or some other content to assist the [[#Metadata|metadata]] submission process.  There are various different types of workflow component that serve different purposes:&lt;br /&gt;
* &#039;&#039;&#039;Documents&#039;&#039;&#039; - For managing [[#Document|document]] [[#Sub-object|sub-objects]].&lt;br /&gt;
* &#039;&#039;&#039;Error&#039;&#039;&#039; - Used when there is an issue with the workflow component, (e.g. the metadata field included does not exist).&lt;br /&gt;
* &#039;&#039;&#039;Field&#039;&#039;&#039; - This has various sub-types for including one, several or [[#Subject|subjects]] type metadata fields.&lt;br /&gt;
* &#039;&#039;&#039;Upload&#039;&#039;&#039; - For uploading a file, (e.g. a document to an [[#EPrint|eprint]]).&lt;br /&gt;
* &#039;&#039;&#039;XHTML&#039;&#039;&#039; - Just some HTML markup.&lt;br /&gt;
&lt;br /&gt;
=== Workflow stage ===&lt;br /&gt;
As a [[#Workflow|workflow]] is a sequence (or flow) of forms a workflow stage defines one of these forms.  Stages can be defined within the [[Workflow_Format|workflow format]] to produce the order of forms required.  Each workflow stage contains one or more [[#Workflow component|workflow components]], that in turn include [[#Metadata field|metadata fields]] for the relevant [[#Data object|data object]].  Below, is the [[#EPrints XML|EPrints XML]] markup for the default ordering of workflow stages for an eprint data object:&lt;br /&gt;
 &amp;lt;flow&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;type&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;files&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;core&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;subjects&amp;quot;/&amp;gt;&lt;br /&gt;
 &amp;lt;/flow&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== X ==&lt;br /&gt;
=== Xapian search ===&lt;br /&gt;
Originally [[#EPrints repository software|EPrints repository software]] created its own database index to support search.  However, this was not particularly efficient or quick to return results, so it started to use a [https://xapian.org/ Xapian] search index to speed up [[#Simple search|simple search]].  ([[#Advanced search|Advanced search]] still uses the database index).  Also, it made it possible to provide relevance based ordering, so that more relevant results could be displayed nearer the top of the search results.  Xapian also gives the potential to provide faceted based search, where search results can be refined by limiting the values for a particular facet (i.e. for EPrints, a [[#Metadata field|metadata field]]).&lt;br /&gt;
&lt;br /&gt;
== Y ==&lt;br /&gt;
== Z ==&lt;br /&gt;
=== Zero flavour ===&lt;br /&gt;
This is a minimal [[#Flavour|flavour]] to create very basic [[#Archive|archives]] with simple [[#EPrint|eprint]] [[#Data object|data objects]].  This may be useful if you want to develop a non-publications repository that requires a lot of bespoke configuration.  As it saves having to override exisiting publications-based configuration.&lt;br /&gt;
&lt;br /&gt;
[[Category:FAQ]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17576</id>
		<title>Archive:Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17576"/>
		<updated>2026-10-14T09:01:20Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /*  Dynamic pages */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
[[Category:Branding]]&lt;br /&gt;
There are several different types of page in the eprints WebsiteInterface and they are generated in different ways. See WebsiteInterface for an explanation.&lt;br /&gt;
&lt;br /&gt;
Every page on eprints is wrapped in the site template. This can be found at /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
==Changing the Template==&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
Make your changes. Be careful not to remove the &amp;lt;pin&amp;gt; elements as this is how eprints knows where to insert information. &lt;br /&gt;
&lt;br /&gt;
Note that this file is XML so all tags must be closed correctly.&lt;br /&gt;
&lt;br /&gt;
==Cause the new template to be applied==&lt;br /&gt;
&lt;br /&gt;
TIP: If you want to see the new template in situ without waiting to update all the webpages then run &amp;quot;generate_abstracts myid 66&amp;quot; (or some other existing abstract page) and see the change on that one page.&lt;br /&gt;
&lt;br /&gt;
This is slightly different for each part of the site...&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Static page | Static pages]] ===&lt;br /&gt;
run generate_static&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Abstract page | Abstract pages]]===&lt;br /&gt;
&lt;br /&gt;
run generate_abstracts&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#EPrint view page | View pages]] ===&lt;br /&gt;
&lt;br /&gt;
run generate_views&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Dynamic Pages | Dynamic pages]] ===&lt;br /&gt;
&lt;br /&gt;
run force_config_reload or resart the webserver&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=EPrints_Glossary&amp;diff=17575</id>
		<title>EPrints Glossary</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=EPrints_Glossary&amp;diff=17575"/>
		<updated>2026-10-14T09:00:52Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* D */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{glossary}}&lt;br /&gt;
__NOTOC__&lt;br /&gt;
EPrints repository software uses a long list of terminology.  Sometimes this terminology overloads existing terminology in similar realms.  Other times different terms are used interchangeably to mean the same of similar things.  This glossary is intended to help clarify the various terminology you may come across whilst installing, configuring or using EPrints repository software.&lt;br /&gt;
&lt;br /&gt;
== A ==&lt;br /&gt;
=== Abstract page ===&lt;br /&gt;
An abstract page (sometimes referred to as a [[#Summary page|summary page]]) is a web page for an [[#Archive|archive]] providing [[#Metadata|metadata]] about a particular [[#EPrint|eprint]] (a.k.a [[#Publication record|publication record]]).  Most prominently it displays the abstract for the publication but also its title, [[#Citation|citation]] links to download associated [[#Document|documents]] and further metadata in a [[#Summary table|summary table]].&lt;br /&gt;
&lt;br /&gt;
Abstract pages are cached.  This cache is cleared when an eprint is modified.  Otherwise, these caches can be cleared, (so new cached version will be generated on next request), by running the following command or by clicking on the &amp;quot;[[Admin/System Tools/Regenerate Abstracts|Regenerate Abstracts]]&amp;quot; button in the [[#Admin menu|admin menu]]:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin refresh_abstracts ARCHIVEID&lt;br /&gt;
One or all abstracts pages can be regenerated by using the [[API:bin/generate_abstracts|bin/generate_abstracts]] command.&lt;br /&gt;
&lt;br /&gt;
=== Access ===&lt;br /&gt;
An [[Access Object|access]] is a [[#Data object|data object]] that represent a HTTP request accessing either an [[#Abstract page|abstract page]] or [[#Document|document]].&lt;br /&gt;
=== Actions tab ===&lt;br /&gt;
The actions tab appears on the [[#View page|view page]] for a [[#Data object|data object]].  However, typically the terms are used in the context of an [[#EPrint|eprint]].  This tab includes buttons to carry out various action against the data object.  For an eprint this may include:&lt;br /&gt;
* Depositing an item.&lt;br /&gt;
* Creating a new version (i.e. one that succeeds the current item).&lt;br /&gt;
* Using as a template to create a completely new item based on the current item.&lt;br /&gt;
* Editing an item.&lt;br /&gt;
* Removing an item (i.e. full deleting it from the [[#Archive|archive]]).  With or without a notification.&lt;br /&gt;
* Moving to the [[#Live archive|live archive]].&lt;br /&gt;
* Moving to the [[#Review buffer|review buffer]].&lt;br /&gt;
* Reindexing the item.&lt;br /&gt;
* Changing the [[#Depositing user|depositing user]] of the item.&lt;br /&gt;
* Exporting the item in one of various formats.&lt;br /&gt;
&lt;br /&gt;
=== Admin menu ===&lt;br /&gt;
The [[Admin|admin menu]] is only accessible to [[#Repository admin|repository admins]] that provides access to various administrative tools to manage their [[#Repository|repository]].&lt;br /&gt;
&lt;br /&gt;
=== Advanced search ===&lt;br /&gt;
An advanced search over [[#EPrint|eprints]] in the [[#Live archive|live archive]].  Unlike [[#Simple search|simple search]] this provides multiple input fields to individually search against particular [[#Metadata field|metadata fields]].  Advanced search configuration can be found in [[eprint_search_advanced.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Archive ===&lt;br /&gt;
Often conflated with [[#Repository| repository]].  [[#EPrints repository software|EPrints repository software]] provides a repository that can host multiple archives.  Commonly a repository will only host a single archive, so the terms are often used interchangeably.&lt;br /&gt;
&lt;br /&gt;
New archives can be created using the [[API:bin/epadmin|epadmin command]], as follows:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin create &amp;lt;zero|pub&amp;gt;&lt;br /&gt;
Where &amp;lt;tt&amp;gt;zero&amp;lt;/tt&amp;gt; is to create an archive with no [[#Flavour|flavour]] and &amp;lt;tt&amp;gt;pub&amp;lt;/tt&amp;gt; is to create an archive using the [[#Publication flavour|publication flavour]].  See [[Getting Started]] for more information.&lt;br /&gt;
&lt;br /&gt;
Content, configuration and sometimes code for an archive will be found at its [[#Archive level|archive level]], i.e.&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/&lt;br /&gt;
E.g. &amp;lt;tt&amp;gt;/opt/eprints3/archives/example/&amp;lt;/tt&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Archive ID ===&lt;br /&gt;
The ID of an [[#Archive|archive]].  This is set by the first input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  This will also be the directory name for the archive under [[#EPrints repository software|EPrints&#039;]] &#039;&#039;archives/&#039;&#039; sub-directory.   Guides on this wiki often use the placeholder &amp;lt;tt&amp;gt;ARCHIVEID&amp;lt;/tt&amp;gt;.&lt;br /&gt;
=== Archive level ===&lt;br /&gt;
This is a shorthand term to describe a configuration file that appears under the [[#Archive|archive]]&#039;s directory structure or to an effect that will only apply to a specific archive rather than the [[#Repository|repository]] as a whole, (which may have multiple archives). &lt;br /&gt;
=== Archive name ===&lt;br /&gt;
The name of an [[#Archive|archive]].  This is set by an early input when the archive is created using the [[API:bin/epadmin|bin/epadmin]] command line tool.  Where the value set will be copied as a [[#Phrase|phrase]] to the archive&#039;s &#039;&#039;archive_name.xml&#039;&#039; under [[archives/ARCHIVEID/cfg/lang/en/phrases/]].&lt;br /&gt;
&lt;br /&gt;
== B ==&lt;br /&gt;
=== Back end pages ===&lt;br /&gt;
Same as [[#Management pages|management pages]].&lt;br /&gt;
&lt;br /&gt;
=== Bazaar ===&lt;br /&gt;
The [https://bazaar.eprints.org/ Bazaar] hosts EPrints packages of functionality ([[#EPM|EPMs]]), which can be installed on a [[#Repository|repository]] via the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] tool in the [[Admin]] web interface.&lt;br /&gt;
&lt;br /&gt;
=== Bazaar plugin ===&lt;br /&gt;
See [[#EPM|EPM]].&lt;br /&gt;
=== Box plugin ===&lt;br /&gt;
This is a type of [[#Plugin|plugin]] that generates a box containing some content or functionality, typically to be display at the top, bottom, left or right of an [[#EPrint|eprint]]&#039;s [[#Abstract page|abstract page]].  A common box plugin is the &#039;&#039;Tools&#039;&#039; plugin that typically appears at the top of abstract page provides the user with various export formats for the eprint.  [[#EPM|Bazaar plugins]] often include box plugins such as for [http://bazaar.eprints.org/555/ Altmetric] and the [http://bazaar.eprints.org/466/ CORE Recommender].&lt;br /&gt;
&lt;br /&gt;
=== Branding ===&lt;br /&gt;
Branding refers to the changing of the appearance of the web pages for your [[#Repository|repository]] or just a single [[#Archive|archive]].  Typically to line up with your institutional branding used on its other websites.  Advice is available on [[Branding with confidence]].  Branding is typically done by editing [[#Template|template]] configuration files and adding your own bespoke CSS, JavaScript and images/icons.  This can be done at an [[#Archive level|archive level]] of by creating a [[#Theme|theme]] so it can be applied to multiple archives hosted on the same repository.&lt;br /&gt;
&lt;br /&gt;
=== Browse view ===&lt;br /&gt;
A browse view is a collection of pages that display menus and listings of for all [[#Live archive|live archive]] [[#EPrint|eprints]] in an [[#Archive|archive]], organised by a particular [[#Metadata field|metadata field]]. By default these fields are: &#039;&#039;year&#039;&#039;, &#039;&#039;subjects&#039;&#039;, &#039;&#039;divisions&#039;&#039; and &#039;&#039;creators&#039;&#039;.&lt;br /&gt;
All the browse views can be found under the equivalent URL for archive to the following:&lt;br /&gt;
 https://example.eprints.org/view/&lt;br /&gt;
The configuration for browse views can be found in [[views.pl]], which by default is found under [[flavours/pub_lib/cfg.d/]] but should be copied to the archive&#039;s &#039;&#039;cfg/cfg.d/&#039;&#039; for editing.  See [[:Category:Browse_Views|browse views category]] for more information.&lt;br /&gt;
&lt;br /&gt;
Browse view pages are cached for a set period of time, by default 24 hours. However, these caches can be cleared earlier, (so new cached version will be generated on next request), by running the following command or by clicking on the &amp;quot;[[Admin/System Tools/Regenerate Views|Regenerate Views]]&amp;quot; button in the [[#Admin menu|admin menu]]:&lt;br /&gt;
 EPRINTS_PATH/bin/epadmin refresh_views ARCHIVEID&lt;br /&gt;
One, some or all browse views can be regenerated by using the [[API:bin/generate_views|bin/generate_views]] command.  Often these used as a cron job (i.e. scheduled task) so browse views caches can be updated overnight, when the server hosting the archive is less busy.&lt;br /&gt;
&lt;br /&gt;
=== Buffer ===&lt;br /&gt;
Shorthand for [[#Review buffer|Review buffer]].&lt;br /&gt;
&lt;br /&gt;
== C ==&lt;br /&gt;
=== Citation ===&lt;br /&gt;
In [[#EPrints repository software|EPrints repository software]] a citation means something slightly different from what it means in research publication.  For the former it refers to a text string describing a publication, which may more commonly described in research publications as a &#039;&#039;reference&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
EPrints repository software has citation style files, which describe how to generate the text string, not just for [[#EPrint|eprints]] but also other [[#Data object|data objects]], each of which can have different citation style files for different purposes.  These files can be found under [[lib/citations/]], [[flavours/pub_lib/citations/]] and the [[#Archive|archive]]&#039;s &#039;&#039;cfg/citations/&#039;&#039; directory.  &lt;br /&gt;
&lt;br /&gt;
See here for more information about the [[Citation Format|citation formats]] and a training video about [[Training_Video:Citation_Styles|citation styles]].&lt;br /&gt;
&lt;br /&gt;
=== Compound metadata field ===&lt;br /&gt;
A [[Compound field|Compound metadata field]] is a type of [[#Metadata field|metadata field]] that is made up of several sub-fields.  A good example of this is the &#039;&#039;Relationships&#039;&#039; field for an [[#EPrint|eprint]] [[#Data object|data object]].  This has two sub-fields one for the type or relation and the second for the actual thing (represented by a URI), that the eprint is related.&lt;br /&gt;
&lt;br /&gt;
=== Core codebase ===&lt;br /&gt;
The core codebase refers to the main code directories of the [[#EPrints repository software|EPrints repository software]].  In some contexts this refers to all directories except the archives directory which contains the configuration for individual [[#Archive|archives]].  In other contexts this refers to just the following directories (i.e. excludes [[#Flavour|flavours]], [[#Ingredient|ingredients]] and [[#Site lib|site_lib]], as well as non-code directories).&lt;br /&gt;
* [[bin/]]&lt;br /&gt;
* [[cgi/]]&lt;br /&gt;
* [[lib/]]&lt;br /&gt;
* [[perl_lib/]]&lt;br /&gt;
* [[tools/]]&lt;br /&gt;
&lt;br /&gt;
=== Core field ===&lt;br /&gt;
Same as a [[#System field|system field]].&lt;br /&gt;
&lt;br /&gt;
=== Contact page ===&lt;br /&gt;
This is a [[#Static page|static page]] that is accessible on an [[#Archive|archive]] at the equivalent URL to the following:&lt;br /&gt;
 https://example.eprints.org/contact.html&lt;br /&gt;
This page is intended to provided contact information, so to those accessing the archive can contact those responsible for it to report problems or ask questions.&lt;br /&gt;
&lt;br /&gt;
This page can be found at &#039;&#039;EPRINTS_PATH/lib/lang/en/static/contact.xpage&#039;&#039; but should be copied to the archive&#039;s &#039;&#039;cfg/lang/en/static/&#039;&#039; directory for [[How_to_modify_static_pages|editing]].  The email address displayed on this page comes from the &amp;lt;tt&amp;gt;$c-&amp;gt;{adminemail}&amp;lt;/tt&amp;gt; in [[adminemail.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Contributor ===&lt;br /&gt;
Sometimes an [[#EPrint|eprint]] has a contributor who could not usefully be described as a [[#Creator|creator]] or [[#Editor|editor]].  The contributor [[#Metadata field|metadata field]] is intended to allow these people to be associated with the eprint.  As well as being able to add the contributor&#039;s family and given name, the type of contributor can be specified.  This list of types is defined in &#039;&#039;EPRINTS_PATH/lib/namedsets/contributor_type&#039;&#039;.  If additional types are needed, then this file should be copied to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/namedsets/&#039;&#039; directory for editing.&lt;br /&gt;
&lt;br /&gt;
=== Creator ===&lt;br /&gt;
Creator (or creators) is a [[#Metadata field|metadata field]] for an [[#EPrint|eprint]].  Sometimes this is alternatively referred to as author but creator is a more generic term better suited to audio-visual/artistic as well as more traditional research publication items.&lt;br /&gt;
&lt;br /&gt;
A creator typically has several separate sub-fields:&lt;br /&gt;
* Given name (a.k.a. first name)&lt;br /&gt;
* Family name (a.k.a. surname)&lt;br /&gt;
* ID (typically email address)&lt;br /&gt;
&lt;br /&gt;
=== CRUD API ===&lt;br /&gt;
CRUD API (Create, Read, Update Delete Application Programming Interface) refers to a programmatic interface used for the management of [[#Data object|data objects]].  It is often also referred to as the [[#REST API|REST API]] as when it is called over HTTP it meets the requirements of a REST API.&lt;br /&gt;
&lt;br /&gt;
== D ==&lt;br /&gt;
=== Data flavour ===&lt;br /&gt;
As of [[#EPrints repository software|EPrints]] [https://www.eprints.org/uk/index.php/eprints-3.4/ 3.4] there are different flavours to service different purposes for a [[#Repository|repository]].  The data flavour is intended for repository hosted research data items, as opposed to research publications.&lt;br /&gt;
&lt;br /&gt;
=== Data object ===&lt;br /&gt;
A [[:Category:Data Objects|data object]] is a single record made up of [[#Metadata field|metadata fields]]. [[#EPrints repository software|EPrints repository software]] has various types of data object.  The most prominent are:&lt;br /&gt;
* [[EPrint Object]]&lt;br /&gt;
* [[User Object]]&lt;br /&gt;
* [[Document Object]]&lt;br /&gt;
* [[File Object]]&lt;br /&gt;
All the data objects of the same type make a [[#Dataset|dataset]].&lt;br /&gt;
&lt;br /&gt;
=== Dataset ===&lt;br /&gt;
A [[API:EPrints/DataSet|dataset]] is all the [[#Data object|data objects]] of a particular type within a single repository. (E.g. [[#EPrint|eprint]], [[#User|user]], [[#Document|document]], etc.).  [[#Virtual dataset|Virtual datasets]] exist for subsets of datasets such as [[#Live archive|live archive]], [[#Review buffer|review buffer]], etc.&lt;br /&gt;
&lt;br /&gt;
=== Depositing user ===&lt;br /&gt;
This is the user who created the [[#EPrint|eprint]] and has deposited it to the [[#Review buffer|review buffer]].&lt;br /&gt;
&lt;br /&gt;
=== Details tab ===&lt;br /&gt;
This is a tab in a [[#Data object|data object]]&#039;s [[#View page|view page]] that lists all its [[#Metadata field|metadata fields]] and their values.  Where a [[#Workflow|workflow]] exists for the data objects these metadata fields are separated into separate sections, depending on the [[#Workflow stage|workflow stage]] in which they appear.&lt;br /&gt;
&lt;br /&gt;
=== Division ===&lt;br /&gt;
This is a generic term to refer to a part of an organisation or institution, at any level of its hierarchy.  A division may be a faculty, school, department, academic unit or even research group.  If [[#EPrints repository software|EPrints repository software]] is used outside an academic context other names for sub-divisions may be applicable.&lt;br /&gt;
&lt;br /&gt;
Divisions is a default [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]].  It allows one or more divisions to be selected from a hierarchical list provided by the [[#Archive|archive]]&#039;s [[#Subject tree|subject tree]].  This can in turn be used to generate a [[#Browse view|browse view]] for divisions.&lt;br /&gt;
&lt;br /&gt;
=== Document ===&lt;br /&gt;
A [[Document Object|document]] is a [[#Second class data object|second class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]].  Documents must be part of an [[#EPrint|eprint]] object.  Sometimes the term is used interchangeably with the actual document file (e.g. a PDF, Word document, etc.).  To avoid confusion, it is best to refer to a document within EPrints as a &amp;quot;document object&amp;quot;.  A document object can be associated with multiple [[#File|file objects]].  Typically because derived files are generated to provide [[#Preview image|preview and thumbnail images]] but also because multiple files can be uploaded for a single document object.&lt;br /&gt;
&lt;br /&gt;
=== Document content ===&lt;br /&gt;
Document content is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It allows selections of a single value from a pre-defined list (i.e. a [[#Named set|named set]]) metadata field.  The options provided are intended to help describe the version of the document (e.g. draft, submitted version, accepted, updated) within the publication lifecycle or other types of content that may be uploaded (e.g. supplemental, presentation, cover image, metadata, bibliography, other).  These are based on the [http://eprints.lse.ac.uk/64948/1/LSE%20Library_Versions%20toolkit_Author_2008.pdf Versions toolkit for authors] but are analogous to other definitions, such as:&lt;br /&gt;
* Author&#039;s Original Manuscript (AOM) is equivalent to submitted.&lt;br /&gt;
* Accepted Manuscript (AM) is equivalent to accepted.&lt;br /&gt;
* Version of Record (VoR) is equivalent to published.&lt;br /&gt;
&lt;br /&gt;
=== Document security ===&lt;br /&gt;
Document security is a [[#Metadata field|metadata field]] for the [[#Document|document object]].  It defines who can access document file and any files in derived document objects (e.g. [[#Preview image|preview images]]).  By default this is one of three values:&lt;br /&gt;
* public - anyone&lt;br /&gt;
* validuser - registered [[#User|users]] (for the [[#Archive|archive]]) only.&lt;br /&gt;
* staffonly - repository staff (i.e. [[#Editor|editor]] and [[#Repository admin|repository administrator]] users) only.&lt;br /&gt;
If one of the last two option is applied with an [[#Embargo|embargo]] that expires on a certain date, then the security value for that document will be updated to &#039;&#039;public&#039;&#039; on that date.&lt;br /&gt;
&lt;br /&gt;
=== Documents directory ===&lt;br /&gt;
This is a directory found under the [[#Archive|archive&#039;s]] directory structure, (i.e. &#039;&#039;EPRINTS_PATH/archives/ARCHIVEID/documents/&#039;&#039;).  This is where the uploaded [[#Document|documents]] for an [[#EPrint|eprint]] are stored under the latter&#039;s own sub-directory (e.g. eprint 1234 has documents sub-directory &#039;&#039;documents/00/00/12/34/&#039;&#039;). Each document is stored in its own two-digit sub-directory based on its &#039;&#039;pos&#039;&#039; [[#Metadata field|metadata field]], which is zero-padded if the number is less than 10. The sub-directory also stores derived &amp;quot;documents&amp;quot; for those uploaded (e.g. preview and thumbnail images).  It also stores [[#Revision file|revision files]] in the eprint&#039;s own &#039;&#039;revisions&#039;&#039; sub-directory.&lt;br /&gt;
&lt;br /&gt;
=== Dynamic Pages ===&lt;br /&gt;
Dynamic pages are pages that are generated each time the page is loaded. The most common example of this is the search pages. Plugins may add additional pages, eg: irstats2 adds dynamic stats page.&lt;br /&gt;
&lt;br /&gt;
== E ==&lt;br /&gt;
=== Editor ===&lt;br /&gt;
On [[#EPrints repository software|EPrints repository software]] &#039;&#039;&#039;editor&#039;&#039;&#039; could refer to one of two different things:&lt;br /&gt;
# A type of EPrints [[#User|user]] that has permissions to access some or all [[#Publication record|publication records]] in the [[#Review buffer|review buffer]] to make amendments and either push the item to the [[#Live archive|live archive]] or return it to the [[#User workarea|user&#039;s workarea]].&lt;br /&gt;
# A [[#Metadata field|metadata field]] in the [[#EPrint|eprint]] [[#Data object|data object]] to record editors of the publication, e.g. the editors for a book.  Like [[#Creator|creator]], by default this field has family name, given name and ID (i.e. email address) sub-fields.&lt;br /&gt;
&lt;br /&gt;
=== Editorial rights restriction ===&lt;br /&gt;
Same as [[#User review scope|user review scope]].&lt;br /&gt;
&lt;br /&gt;
=== Education flavour ===&lt;br /&gt;
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+. It is intended to produce repositories for open education.  I.e. for hosting files such as presentation slides, videos of lectures/seminars, instructions for learning tasks, in-class quizzes, etc.&lt;br /&gt;
&lt;br /&gt;
=== Embargo ===&lt;br /&gt;
[[#Document|Documents]] added to an [[#EPrint|eprint]] can have their access restricted.  Sometimes, this access need only be restricted for a set amount of time.  These documents can be embargoed until a set embargo date.  These can then be lifted of this date using the [[API:bin/lift_embargos|bin/lift_embargos]] script.  More recently embargoes allow a reason to be chosen from a predetermined set of options provided by the &#039;&#039;embargo_reason&#039;&#039; [[#Named set|named set]].&lt;br /&gt;
&lt;br /&gt;
=== EPM ===&lt;br /&gt;
EPM (EPrints Package Manager) is a package of functionality, sometimes referred to as a &#039;&#039;Bazaar plugin&#039;&#039;, which can be installed in an automated fashion, typically from the [[#Bazaar|Bazaar]].  It can sometimes refer to the pages for managing the installing of these packages, (e.g. the [[Admin/System Tools/EPrints Bazaar|EPrints Bazaar]] page available through the [[Admin]] web interface).&lt;br /&gt;
&lt;br /&gt;
=== EPrint ===&lt;br /&gt;
An [[EPrint Object|eprint]] is a [[#First class data object|first class]] [[#Data object|data object]] in [[#EPrints repository software|EPrints repository software]]. These are often referred to as &#039;&#039;[[#Item|items]]&#039;&#039; or &#039;&#039;[[#Publication record|publication records]]&#039;&#039; as they are generally intended hold [[#Metadata|metadata]] about a publication of some kind.&lt;br /&gt;
&lt;br /&gt;
=== EPrint control page ===&lt;br /&gt;
Same as an [[#EPrint view page|eprint view page]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint history ===&lt;br /&gt;
This is the history of an [[#EPrint|eprint]] shown in the [[#History tab|history tab]] of the eprint&#039;s [[#View page|view page]].  It is generated from the [[#EPrint revision|eprint revision]] [[#Revision file|files]] generated each time an eprint is modified.  These are compared to display differences between revisions to track the eprint&#039;s history for administration purposes.&lt;br /&gt;
&lt;br /&gt;
=== EPrint locking ===&lt;br /&gt;
Whilst a [[#User|user]] is editing an [[#EPrint|eprint]] it is best that another user does not try to edit it as well.  When an eprint is locked, even permitted users will not be able to edit that record, unless they remove the edit lock.  Locks are automatically released when a user saves or cancels editing an eprint or (by default) 1 hour after the user started editing the eprint.&lt;br /&gt;
&lt;br /&gt;
=== EPrint revision ===&lt;br /&gt;
An EPrint revision is a numbered version of the [[#EPrint|eprint&#039;s]] [[#Metadata|metadata]] stored in the &#039;&#039;rev_number&#039;&#039; [[#Metadata field|metadata field]].  Revisions of eprints metadata are exported as XML [[#Revision file|revision files]] and stored under the [[#Documents directory|documents directory]] of the [[#Archive|archive]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint status ===&lt;br /&gt;
The status of an [[#EPrint|eprint]] represent the stage it is in the depositing lifecycle.  By default in [[#EPrints repository software|EPrints repository software]] this can be one of four states:&lt;br /&gt;
# [[#User workarea|User workarea]] - The eprint is still being edited by the [[#Depositing user|depositing user]] as there is still metadata they need to add or change.&lt;br /&gt;
# [[#Review buffer|Review buffer]] - The eprint has been submitted for review by an [[#Editor|editor]] for the [[#Archive|archive]].&lt;br /&gt;
# [[#Live archive|Live archive]] - The eprint has been reviewed by the editor and they have deposited it into the live archive for public access.&lt;br /&gt;
# [[#Retired|Retired]] - The eprint has been removed from the live archive as it is no longer appropriate for it to have public access.&lt;br /&gt;
&lt;br /&gt;
=== EPrint type ===&lt;br /&gt;
This is the type of publication the [[#EPrint|eprint]] represents.  The available types for a [[#Repository|repository]] are specified in a [[#Named set|named sets]] file. ( &#039;&#039;lib/namedsets/eprint&#039;&#039; or &#039;&#039;flavours/pub_lib/namedsets/eprint&#039;&#039;) or can be copied to the [[#Archive|archive]]&#039;s [[archives/ARCHIVEID/cfg/namedsets/]] directory to add extra types for a specific archive.  By default [[#EPrints repository software|EPrints]]&#039; [[#Publication flavour|publication flavour]] has the following type options:&lt;br /&gt;
 article&lt;br /&gt;
 book_section&lt;br /&gt;
 monograph&lt;br /&gt;
 conference_item&lt;br /&gt;
 book&lt;br /&gt;
 thesis&lt;br /&gt;
 patent&lt;br /&gt;
 artefact&lt;br /&gt;
 exhibition&lt;br /&gt;
 composition&lt;br /&gt;
 performance&lt;br /&gt;
 image&lt;br /&gt;
 video&lt;br /&gt;
 audio&lt;br /&gt;
 dataset&lt;br /&gt;
 experiment&lt;br /&gt;
 teaching_resource&lt;br /&gt;
 other&lt;br /&gt;
Type is by default presented on the first [[#Workflow stage|stage]] of the [[#EPrint workflow|EPrint workflow]], as the option chosen will affect the fields that can/need to be completed in later stages.&lt;br /&gt;
&lt;br /&gt;
=== EPrint URI ===&lt;br /&gt;
The URI for an [[#EPrint|eprint]] is its globally unique identifier.  In a form like:&lt;br /&gt;
 http://example.eprints.org/id/eprint/1234&lt;br /&gt;
Technically, a URI only need be an identifier and therefore not return the resource itself.  However, in the case of [[#EPrints repository software|EPrints repository software]], this will return the resource.  Prior to EPrints 3.4, this would be by redirecting to the [[#EPrint URL|eprint URL]] but since then the [[#Publication flavour|publication flavour]] uses the same string for the eprints URL and URI with the old style URL redirecting the longer URI format URL.&lt;br /&gt;
&lt;br /&gt;
=== EPrint URL ===&lt;br /&gt;
The URL of an [[#EPrint|eprint]] is the location it can be found at on the World Wide Web.  Historically with [[#EPrints repository software|EPrints repository software] it has taken a form like:&lt;br /&gt;
 http://example.eprints.org/1234/&lt;br /&gt;
However, since EPrints 3.4, it has been possible to configure the URL to take a long format like that of the [[#EPrint URI|eprint URI]]:&lt;br /&gt;
 http://example.eprints.org/id/eprint/1234&lt;br /&gt;
By using the following setting (typically in the [[#Archive|archive]]&#039;s &#039;&#039;cfg/cfg.d/[[20_baseurls.pl]]&#039;&#039;): &lt;br /&gt;
 $c-&amp;gt;{use_long_url_format] = 1;&lt;br /&gt;
By making this change the old style URL will still work but will redirect to the new format.  The reason for the change was to make it more apparent that the URL represented a publication within EPrints repository.  Web crawlers and bots often record links (i.e. URLs) they find on web pages but they don&#039;t actually access them.  In particular [https://scholar.google.com Google Scholar] would disregard these URLs without checking them, as there was nothing from the URL to indicate they represented a publication.  By adding &#039;&#039;/id/eprint/&#039;&#039; into the URL it makes it the URL distinct from other common URLs of the form &#039;&#039;&amp;lt;nowiki&amp;gt;http://HOSTNAME/ID&amp;lt;/nowiki&amp;gt;&#039;&#039;, which are mostly not URLs for EPrints [[#Abstract page|abstract pages]].&lt;br /&gt;
&lt;br /&gt;
=== EPrint view page ===&lt;br /&gt;
The view page for an [[#EPrint|eprint]] is a multi-tabbed management page for that particular item.  It can typically be reached by clicking on the &#039;&#039;View Item&#039;&#039; link towards the bottom of an eprint&#039;s [[#Abstract page|abstract page]].  This page will tend to have the following tabs:&lt;br /&gt;
# [[#Preview tab|Preview]] - What will the abstract page look like when the eprint is moved to the [[#Live archive|live archive]].&lt;br /&gt;
# [[#Details tab|Details]] - The values for all the [[#Metadata field|metadata fields]] for the eprint.&lt;br /&gt;
# [[#Actions tab|Actions]] - All the actions that can be carried out against the eprint.&lt;br /&gt;
# [[#History tab|History]] - The [[#EPrint revision|revision]] history of the eprint.&lt;br /&gt;
# [[#Issues tab|Issues]] - The [[#Issue|issues]] detected for this eprint, if any.&lt;br /&gt;
&lt;br /&gt;
=== EPrint workflow ===&lt;br /&gt;
This is the [[#Workflow|workflow]] that pertains specifically to the [[EPrint Object|eprint data object]].&lt;br /&gt;
&lt;br /&gt;
=== EPrints repository software ===&lt;br /&gt;
Often shortened to just &#039;&#039;&#039;EPrints&#039;&#039;&#039; but not to be confused with multiple eprint data objects, (i.e. eprints). The actual software that can be used to create Open Access repositories and available as Open Source from [https://github.com/eprints/eprints3.4 GitHub].&lt;br /&gt;
&lt;br /&gt;
=== EPrints path ===&lt;br /&gt;
The path on your operating system under which EPrints repository software is installed.  Guides on this wiki often use the placeholder &amp;lt;tt&amp;gt;EPRINTS_PATH&amp;lt;/tt&amp;gt; to represent this.  Typically EPrints path will either be &#039;&#039;&#039;/opt/eprints3/&#039;&#039;&#039; or &#039;&#039;&#039;/usr/share/eprints/&#039;&#039;&#039; depending on how EPrints repository software was installed.&lt;br /&gt;
&lt;br /&gt;
=== EPrints release ===&lt;br /&gt;
A release of the [[#EPrints repository software|EPrints repository software]].&lt;br /&gt;
&lt;br /&gt;
=== EPrints version ===&lt;br /&gt;
Same as [[#EPrints release|EPrints release]] but with specific reference to a version number.&lt;br /&gt;
&lt;br /&gt;
=== EPrints XML ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] has its own XML schema for defining how [[#Data object|data objects]] should be described.  This schema can be found at the equivalent URL to:&lt;br /&gt;
 http://example.eprints.org/cgi/schema&lt;br /&gt;
&lt;br /&gt;
=== Event plugin ===&lt;br /&gt;
A type of [[#Plugin|plugin]] that generates [[#Indexer task|Indexer tasks]] to get the [[#Indexer|indexer]] to perform some asynchronous and potential long-running task.&lt;br /&gt;
&lt;br /&gt;
=== Event queue ===&lt;br /&gt;
The event queue contains all generated and yet to be successfully completed [[#Indexer task|indexer tasks]].  It can be accessed through the [[#Admin menu|admin menu]]&#039;s [[Admin/System Tools|System tools]] tab using the [[Admin/System Tools/Status|Status]] button and then clicking on the number next to the &#039;&#039;&#039;Background Task Queue&#039;&#039;&#039;.  There is also the [[Event Queue Object]], which is a [[#Data object|data object]] to represent an individual indexer task.&lt;br /&gt;
&lt;br /&gt;
=== Export plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a formatted export of a [[#Data object|data object]]&#039;s [[#Metadata|metadata]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository software]] has export plugins for many different formats, which can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Export/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/Export/]]&#039;&#039; directories.  Bespoke export plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Export/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Export/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
== F ==&lt;br /&gt;
=== File ===&lt;br /&gt;
A file is a [[#Third class data object|third class]] [[#Data object|data object]].  This is because it is a [[#Sub-object|sub-object]] of a [[#Document|document]] data object, which in turn is a sub-object of an [[#EPrint|eprint]] data object.  A file data object store metadata relevant to the file such as its filename, size, MIME type and modified time and a hash (by default MD5) to maintain the integrity of the file.  Typically uploading a document to an eprint will only create a single data object but it is possible to add additional files to a document after it is uploaded.&lt;br /&gt;
&lt;br /&gt;
File data objects are also used to capture XML [[#Revision file|revision files]] created for recording [[#EPrint revision|eprint revisions]].&lt;br /&gt;
&lt;br /&gt;
=== First class data object ===&lt;br /&gt;
[[#Data object|Data objects]] in [[#EPrints repository software|EPrints repository software]] take a particular order.  First class data objects are those that are not a sub-objects of other data objects, such as:&lt;br /&gt;
* [[#EPrint|eprint]]&lt;br /&gt;
* [[#User|user]]&lt;br /&gt;
Other data object may be described as either [[#Second class data object|second class]] or [[#Third class data object|third class]].  Usually a data object is only described as &amp;quot;first class&amp;quot; if it contains sub-objects.  Technically, [[#Subject|subject]] is a first class data object but as it contains no sub-objects, it in unnecessary to make the distinction.&lt;br /&gt;
&lt;br /&gt;
=== Flavour ===&lt;br /&gt;
From version 3.4 of [[#EPrints repository software|EPrints repository software]] different flavours have been introduced.  EPrints was originally designed as a [[#Repository|repository]] for research publications but over the years it has been repurposed for different tasks, which has led to the codebase getting a little messy.  So in [https://www.eprints.org/uk/index.php/eprints-3.4/ EPrints 3.4] a separate sub-directory structure was created to store code and configuration that makes EPrints suitable for a particular task, (i.e. a flavour).  There are three main flavours but most development has continued to focus on research publication:&lt;br /&gt;
# [[#Publication flavour|Publication flavour]] - For research publications.  Provided in &#039;&#039;[[flavours/pub_lib/]]&#039;&#039;.&lt;br /&gt;
# [[#Data flavour|Data flavour]] - For research data.  Provided in &#039;&#039;flavours/data_lib/&#039;&#039;.&lt;br /&gt;
# [[#Education flavour|Education flavour]] - For Open Education, i.e. teaching materials.  Provided in &#039;&#039;flavours/edu_lib/&#039;&#039;.&lt;br /&gt;
As well as flavours in EPrints 3.4, there are also &#039;&#039;[[#Ingredient|ingredients]]&#039;&#039;, which provide additional functionality, similar to a [[#Bazaar plugin|Bazaar plugin]] / [[#EPM|EPM]].  Any EPrints flavour has an &#039;&#039;inc&#039;&#039; file found in its top-level directory (e.g. &#039;&#039;flavours/pub_lib/inc&#039;&#039;).  This tells the flavour which paths to include.  By default, this would include the flavour itself.  It may also contain various ingredients and potentially [[#Site lib|site_lib]] if the repository has multiple [[#Archive|archives]], which require the same bespoke functionality.  However, it is better if this bespoke functionality can be converted into ingredients to separate out discrete parts of functionality.&lt;br /&gt;
&lt;br /&gt;
=== Front end pages ===&lt;br /&gt;
Same as [[#Public facing pages|public facing pages]].&lt;br /&gt;
&lt;br /&gt;
== G ==&lt;br /&gt;
== H ==&lt;br /&gt;
=== Help text ===&lt;br /&gt;
A help text is associated with a [[#Metadata field|metadata field]], providing advice on how this should be filled in as part of the [[#Workflow|workflow]].  This text is defined using a [[#Phrase|phrase]].  E.g. the phrase ID for the &#039;&#039;title&#039;&#039; metadata field of the [[#EPrint|eprint]] [[#Data object|data object]] is &#039;&#039;eprint_fieldhelp_title&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== History ===&lt;br /&gt;
A [[History Object]] is a [[#Second class data object|second class]] [[#Data object|data object]].  It is a [[#Sub-object|sub-object]] of any [[#First class data object|first class data object]] that supports [[#Revision|revisions]].  By default, this is only the [[#EPrint|eprint]] data object.  A history data object contains a revision number, a timestamp, a reference to a [[#User|user]] or an &amp;quot;actor&amp;quot; if the new revision is generated by a script and the &amp;quot;action&amp;quot; that is being carried out, (e.g. &#039;&#039;create&#039;&#039;, &#039;&#039;modify&#039;&#039;, &#039;&#039;move_buffer_to_archive&#039;&#039;, &#039;&#039;destroy&#039;&#039;, etc.)&lt;br /&gt;
&lt;br /&gt;
=== History tab ===&lt;br /&gt;
This tab refers to [[#EPrint history|eprint history]] or [[#User history|user history]] both make reference to changes between [[#Revision file|revision files]].  This tab can be found in the [[#View page|view page]] of the particular [[#EPrint|eprint]] or [[#User|user]]. (In the case of users this tab is labelled &amp;quot;User History&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Homepage ===&lt;br /&gt;
The homepage for an [[#Archive|archive]] is found at the top-level URL for a repository.  Usually, that is something like:&lt;br /&gt;
 https://example.eprints.org/&lt;br /&gt;
The homepage is a [[#Static page|static page]] although often contains dynamic elements, like the list of latest publications.  By default, the file is located at either &#039;&#039;[[lib/lang/en/static/|lib/lang/en/static]]/index.xpage&#039;&#039; or &#039;&#039;[[flavours/pub_lib/lang/en/static/|flavours/pub_lib/lang/en/static]]/index.xpage&#039;&#039; with the latter taking precedence if it exists.  Configuration for the archive ensure this page display bespoke information for your archive such as the [[#Archive name|archive name]].  However, you will most likely want to [[How_to_modify_static_pages|make changes to your homepage]], so you should copy the appropriate &#039;&#039;index.xpage&#039;&#039; to your archive&#039;s &#039;&#039;cfg/lang/en/static/&#039;&#039; directory, creating the directory if it does not already exist.&lt;br /&gt;
&lt;br /&gt;
== I ==&lt;br /&gt;
=== Import plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a formatted import of [[#Metadata|metadata]] for a [[#Data object|data object]], typically for an [[#EPrint|eprint]].  By default, [[#EPrints repository software|EPrints repository software]] has import plugins for numerous different formats, which can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Import/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/Import/]]&#039;&#039; directories.  Bespoke import plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Import/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Import/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Inbox ===&lt;br /&gt;
Same as [[#User workarea|User workarea]].&lt;br /&gt;
&lt;br /&gt;
=== Inc file ===&lt;br /&gt;
The &#039;&#039;inc&#039;&#039; file is the critical part of a [[#Flavour|flavour]], which defines the paths that should be included for code and configuration.  It is found in the top-level directory of the flavour (e.g. &#039;&#039;/flavours/pub_lib/inc&#039;&#039;). Initially from the first sub-version of [[#EPrints repository software|EPrints]] 3.4 this will be just the path for the flavour (e.g. &#039;&#039;flavours/pub_lib&#039;&#039;) but increasingly core [[#Ingredient|ingredients]] will be added to this (e.g. for providing integration with the [[#Bazaar|Bazaar]] or for enabling different JavaScript libraries.  This is the only file outside the [[Archives/ARCHIVEID/|archive&#039;s directory structure]] that should need to be modified, unless you have a [[#Site lib|site_lib]].  However, the default inc file will probably not need changing in the case of most [[#Repository|repositories]].&lt;br /&gt;
&lt;br /&gt;
The ordering of paths within the inc file is important, as it determines, which configuration files get loaded and which takes precedence.  If you have a configuration file with the same filename in the &#039;&#039;cfg.d/&#039;&#039; directories for all three paths in the example inc file below, the file in &#039;&#039;site_lib&#039;&#039; will be used in precedence to the other two:&lt;br /&gt;
 flavours/pub_lib&lt;br /&gt;
 ingredients/bazaar&lt;br /&gt;
 site_lib&lt;br /&gt;
However, if you also have the same filename is the [[#Archive|archive]]&#039;s &#039;&#039;cfg/cfg.d/&#039;&#039; directory this will take precedence, although only for that archive, if you have a multi-archive repository.&lt;br /&gt;
&lt;br /&gt;
=== Indexer ===&lt;br /&gt;
The indexer is used by [[#EPrints repository software|EPrints repository software]] to carry out asynchronously tasks that may take a long time.  Typically, this would be indexing tasks, which include indexing of both the [[#Metadata|metadata]] for an [[#EPrint|eprint]] [[#Data object|data object]] and the full text (i.e. all the words in the PDF, Word, etc. document) for [[#Document|documents]] uploaded for those eprints.&lt;br /&gt;
&lt;br /&gt;
The Indexer can be managed through the [[#Admin menu|admin menu]] specifically, its [[Admin/System Tools|System Tools]] tab, which provides options to stop, start and force start the indexer.  Also, the [[Admin/System Tools/Status|Status]] option takes you to a page that lists the number of [[#Indexer task|tasks]] yet to be successfully completed by the indexer.  Commonly referred to as the &#039;&#039;[[#Event queue|event queue]]&#039;&#039; or &#039;&#039;background task queue&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== Indexer task ===&lt;br /&gt;
An indexer task is a scheduled operation to be carried out by the [[#Indexer|indexer]].  It is also a [[#Data object|data object]] in its own right but in this context is referred to as an [[Event Queue Object|event queue object]].  As until it is successfully completed it will appear in the [[#Event queue|event queue]].  An indexer task has several significant attributes:&lt;br /&gt;
* Status - Whether the task is &#039;&#039;Waiting&#039;&#039;, &#039;&#039;In Progress&#039;&#039; or &#039;&#039;Failed&#039;&#039;.&lt;br /&gt;
* Start time - The earliest time the indexer task can start.&lt;br /&gt;
* Plugin - The [[#Event plugin|event plugin]] that can perform this indexer task.&lt;br /&gt;
* Action - The specific action of the Event plugin for this indexer task.&lt;br /&gt;
* Parameters - The parameters needed to run the indexer task (e.g. the data object and potentially [[#Metadata field|metadata fields]] to be used by the indexer task.&lt;br /&gt;
&lt;br /&gt;
=== Ingredient ===&lt;br /&gt;
Since [[#EPrints repository software|EPrints]] version 3.4, the concept of [[EPrints Ingredients|ingredients]] has been introduced along with [[#Flavour|flavours]].  The main purpose of ingredients is to allow complex functionality to be developed but deployed in a way that does not make a mess of the existing [[#Core codebase|core codebase]] by spewing files in different places, like some [[#Bazaar plugin|Bazaar plugins]] can do.  Also, as Bazaar plugins are designed to be one-click install, they should require limited configuration, as this takes away from ease of deployment that one-click install implies.  Instead, ingredients can be much more complex.  Although effort should be taken to avoid mixing distinctly separate pieces of functionality when they could be kept apart.  &lt;br /&gt;
&lt;br /&gt;
Typically, an ingredient would be deployed by checking out a tagged version of the Git repository for that ingredient on [https://github.com/ GitHub].  Although that requires more technical knowledge than a one-click install, this is also inherently a safety feature, to avoid accidental installation of new functionality that could damage the data stored by the [[#Repository|repository]], which could happen when installing some of the more complex Bazaar plugins, without understanding of how they behave.&lt;br /&gt;
&lt;br /&gt;
=== Issue ===&lt;br /&gt;
An issue is a single row in a [[#Compound metadata field|compound]] [[#Multiple metadata field|multiple]] [[#Metadata field|metadata field]] that is part of an [[#EPrint|eprint]] [[#Data object|data object]]. It describes a potential problem discovered about a particular eprint. Unlike validation errors for specific metadata fields displayed whilst navigating the [[#EPrint workflow|eprint workflow]] issues are determined by comparing eprints across the [[#Dataset|dataset]] or checking for more subjective problems.  By default this includes:&lt;br /&gt;
* Duplicate titles - Two or more eprints have the exact same title.&lt;br /&gt;
* Similar titles - Two or more eprints share very similar titles.&lt;br /&gt;
* Old but unpublished - Date set for eprint is more than two years in the past but its publication status is still not published.&lt;br /&gt;
* Short family name - Family name for a creator is less than two characters or not set.  (Single name creators should always put this under family name).&lt;br /&gt;
Issues are checked for across all eprints in the [[#Live archive|live archive]] and [[#Review buffer|review buffer]] through a scheduled task running the &#039;&#039;bin/issues_audit&#039;&#039; script.  This can be deployed with a cron job similar to the following in the &#039;&#039;eprints&#039;&#039; user&#039;s crontab (substituting &#039;&#039;EPRINTS_PATH&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate&#039;&#039;):&lt;br /&gt;
 38 23 * * * EPRINTS_PATH/bin/issues_audit ARCHIVEID --quiet&lt;br /&gt;
Additional types of issue can be added in one of two ways:&lt;br /&gt;
# Creating a new Issues [[#Plugin|plugin]].&lt;br /&gt;
# Adding XML markup to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/issues.xml&#039;&#039;.&lt;br /&gt;
Issues for a particular eprint can be found under its [[#Issues tab|Issues tab]] of its [[#EPrint view page|view page]] or searched for through the [[#Admin menu|admin menu]]&#039;s [[Admin/Editorial Tools/Search issues|Search issues]] tool (under the [[Admin/Editorial Tools|Editorial Tools]] tab).&lt;br /&gt;
&lt;br /&gt;
=== Issues tab ===&lt;br /&gt;
This is a tab that appear on the [[#EPrint view page|eprint view page]] and lists the [[#Issue|issues]] associated with that [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
=== Item ===&lt;br /&gt;
Same as [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
== J ==&lt;br /&gt;
== K ==&lt;br /&gt;
&lt;br /&gt;
=== Key tools ===&lt;br /&gt;
Same as [[#User menu|user menu]].&lt;br /&gt;
&lt;br /&gt;
== L ==&lt;br /&gt;
=== Latest tool ===&lt;br /&gt;
The latest tool is a piece of functionally that allows JavaScript to be used to include a dynamically updating list of the latest [[#EPrint|eprints]] to be put into the [[#Live archive|live archive]] on to a [[#Static page|static page]] like the [[#Homepage|homepage]].  This is provided through a script that can be requested at the equivalent following URL:&lt;br /&gt;
 http://example.eprints.org/cgi/latest_tool&lt;br /&gt;
It can be configured in the archive&#039;s &#039;&#039;cfg/cfg.d/[[latest_tool.pl]]&#039;&#039; to set the number of eprints shown and the [[#Citation|citation]] style used.&lt;br /&gt;
&lt;br /&gt;
=== License ===&lt;br /&gt;
Sometimes spelt &#039;&#039;licence&#039;&#039;, is the licence under which a [[#Document|document]] is made available in an [[#Archive|archive]].  By default, [[#EPrints repository software|EPrints repository software]] provides the [https://creativecommons.org/licenses/ Creative Commons (v4) licenses] as options in the [[#Named set|named set]] file &#039;&#039;licenses&#039;&#039; in [[lib/namedsets/]]. These include:&lt;br /&gt;
* [https://creativecommons.org/licenses/by/4.0/ Creative Commons Attribution 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons: Attribution-ShareAlike 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc/4.0/ Creative Commons: Attribution-NonCommercial 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nd/4.0/ Creative Commons: Attribution-NoDerivatives 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc-sa/4.0/ Creative Commons: Attribution-NonCommercial-ShareAlike 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/by-nc-nd/4.0/ Creative Commons: Attribution-NonCommercial-NoDerivatives 4.0 International]&lt;br /&gt;
* [https://creativecommons.org/licenses/publicdomain/ Creative Commons: Public Domain Dedication]&lt;br /&gt;
* [https://creativecommons.org/licenses/GPL/2.0/ Software: Creative Commons: GNU GPL 2.0]&lt;br /&gt;
* [https://creativecommons.org/licenses/LGPL/2.1/ Software: Creative Commons: GNU LGPL 2.1]&lt;br /&gt;
&lt;br /&gt;
=== Live archive ===&lt;br /&gt;
Live archive refers to both the [[#EPrint status|status]] or an [[#EPrint|eprint]] as well as a [[#Virtual dataset|virtual dataset]] of all eprints that have their status set to &#039;&#039;live archive&#039;&#039;.  When an editor reviews and is happy with an eprint, they will change its status to live archive, so it becomes publicly accessible.&lt;br /&gt;
&lt;br /&gt;
== M == &lt;br /&gt;
=== Main menu ===&lt;br /&gt;
The [[#EPrints repository software|EPrints]] main menu by default contains links to the main pages of interest for a [[#Visitor|visitor]] to an [[#Archive|archive]], this includes:&lt;br /&gt;
* Home - A link back to the archive&#039;s [[#Homepage|homepage]].&lt;br /&gt;
* About - A [[#Static page|static page]] providing information about the archive.&lt;br /&gt;
* Browse - A listing of [[#Browse view|browse views]] available for the archive.&lt;br /&gt;
** Browse by Year&lt;br /&gt;
** Browse by Subject&lt;br /&gt;
** Browse by Division&lt;br /&gt;
** Browse by Author&lt;br /&gt;
&lt;br /&gt;
=== Management pages ===&lt;br /&gt;
These are the pages in an [[#Archive|archive]] that can only be accessed by [[#User|users]] after they have logged in.  They include those pages accessible to [[#Regular user|regular users]] to add/edit their own [[#EPrint|eprints]] or manage their [[#User profile|user profile]].  But also more restricted administration pages such as those accessible through the [[#Admin menu|admin menu]].  &lt;br /&gt;
&lt;br /&gt;
These pages are sometimes alternatively referred to as [[#Back end pages|back end pages]].&lt;br /&gt;
&lt;br /&gt;
=== Metadata ===&lt;br /&gt;
[[Metadata]] is all the values for the [[#Metadata field|metadata fields]] for a particular [[#Data object|data object]].&lt;br /&gt;
&lt;br /&gt;
=== Metadata field ===&lt;br /&gt;
A [[:Category:EPrints_Metadata_Fields|metadata field]], sometimes shortened to &#039;&#039;&#039;metafield&#039;&#039;&#039; (or even just &#039;&#039;field&#039;&#039;) is part of a [[#Data object|data object]] and store a particular piece of pieces of information for that data object.  Metadata fields have different [[:Category:EPrints_Metadata_Fields#Metadata Field Types|types]] and have different types of properties roughly broken down into the following categories:&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Core Properties|Core]]&#039;&#039;&#039; - This includes the &#039;&#039;name&#039;&#039;, aforementioned &#039;&#039;type&#039;&#039;, whether it should have &#039;&#039;multiple&#039;&#039; values and whether to add an SQL index for it.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Rendering Properties|Rendering]]&#039;&#039;&#039; - This includes how the render the metadata field within [[#Abstract page|abstract pages]], [[#Browse view|browse views]] and search results, where applicable.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Input and Validation Properties|Input and validation]]&#039;&#039;&#039; -  This includes how to display the input for the metadata field within a [[#Workflow|workflow]] and any additional functionality to how this field is used of subsequently validated.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Ordering, Indexing and Searching|Ordering, indexing and searching]]&#039;&#039;&#039; - Whether the metadata field should be included in [[#EPrints repository software|EPrints repository software]]&#039;s full-text indexing and how the data object can be ordered or search over using this field.&lt;br /&gt;
* &#039;&#039;&#039;[[:Category:EPrints_Metadata_Fields#Other Properties|Other]]&#039;&#039;&#039; - Miscellaneous properties, such as whether the metadata field&#039;s value(s) should be copied across to a cloned version of the data object or be able to be set through an import.  Also, whether the field its value should appear in various management pages within the [[#Repository|repository]] or in exports.&lt;br /&gt;
&lt;br /&gt;
=== Minimal user ===&lt;br /&gt;
Sometimes also referred to as &amp;quot;min user&amp;quot;.  This is a type of user account that only has minimal access to an [[#Archive|archive]].  Typically, these accounts are intended for those users that may need to access restricted [[#Document|documents]] but do not need to submit their own [[#EPrint|eprints]].  Also, if you have open [[#User registration|user registration]] enabled, you may want to prevent newly registered users from submitting eprints until you can confirm you are happy with their registration.&lt;br /&gt;
&lt;br /&gt;
=== Multiple metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] that allows for more than one value to be stored for it against a particular [[#Data object|data object]].  This can be configured by setting the field definition&#039;s &amp;lt;tt&amp;gt;multiple&amp;lt;/tt&amp;gt; attribute to 1.  A good example of a multiple metadata field is the &#039;&#039;Roles&#039;&#039; field for the [[#User|user]] data object.  This allow multiple roles to be assigned to a user, to enable bespoke permissions for that user.&lt;br /&gt;
&lt;br /&gt;
== N == &lt;br /&gt;
=== Named set ===&lt;br /&gt;
A [[Namedset_field|named set]] refers to both a type of [[#Metadata field|metadata field]] with the type name &#039;&#039;namedset&#039;&#039; and the file that defines the options for this type of metadata field.  A named set metadata field is much like a &#039;&#039;set&#039;&#039; field.  However, rather than defining the options within [[#EPrints repository software|EPrints repository software]]&#039;s Perl-based configuration, they can be added to a simple text file where each new option is separated by a new line.  Such as for [[#EPrint type|eprint types]].  &lt;br /&gt;
&lt;br /&gt;
Named set files by default can be found in either the [[lib/namedsets/]] or [[flavours/pub_lib/namedsets/]] directories.  If you need to edit them to add or remove options, then the file should be copied to the [[#Archive|archive]]&#039;s &#039;&#039;cfg/namedsets/&#039;&#039; directory before editing.  It is generally advised not to modify an option in this file once your archive is in use.  It is better to change the [[#Phrase|phrase]] that relates to that option.  E.g.  the &#039;&#039;type&#039;&#039; field for an &#039;&#039;[[#EPrint|eprint]]&#039;&#039; would have the phrase &amp;lt;tt&amp;gt;eprint_typename_article&amp;lt;/tt&amp;gt; for the value &#039;&#039;article&#039;&#039; in &#039;&#039;flavours/pub_lib/namedsets/eprint&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
== O ==&lt;br /&gt;
=== OAI-PMH ===&lt;br /&gt;
[https://www.openarchives.org/pmh/ Open Archives Initiative - Protocol for Metadata Harvesting (OAI-PMH)] is a standard for harvesting metadata from Open Access [[#Archive|repository archives]] like those provided by [[#EPrints repository software|EPrints repository software]].  For this EPrints has a [[OAI_FAQ|separate interface for accessing OAI-PMH]], which is available at the equivalent following URL:&lt;br /&gt;
 http://example.eprints.org/cgi/oai2&lt;br /&gt;
&lt;br /&gt;
=== Order key ===&lt;br /&gt;
An &#039;&#039;&#039;order key&#039;&#039;&#039; or &#039;&#039;&#039;orderkey&#039;&#039;&#039; is the (potentially language-specific) string used to order by a particular [[#Metadata field|metadata field]]. [[#EPrints repository software|EPrints repository software]]&#039;s default orderkey generation can be overridden by defining your own orderkey method and assigning it to the &#039;&#039;make_value_orderkey&#039;&#039; or &#039;&#039;make_single_value_orderkey&#039;&#039; property of the metadata field. This property is passed value(s) and returns (an) &#039;&#039;ordervalue&#039;&#039; string(s) after processing the value(s) for that metadata field.  Typically, you may want to define your own order keys to manage special characters, maybe to avoid accented characters appearing separately in a browse view.  Some examples of bespoke order keys can be found in [[make_orderkey.pl]].&lt;br /&gt;
&lt;br /&gt;
== P ==&lt;br /&gt;
=== Plugin ===&lt;br /&gt;
These are Perl modules that &amp;quot;Plug in&amp;quot; to the EPrints software to provide a particular piece of functionality.  Default plugins for [[#EPrints repository software|EPrints repository software]] can be found under the &#039;&#039;[[perl_lib/EPrints/Plugin/]]&#039;&#039; and &#039;&#039;[[flavours/pub_lib/plugins/EPrints/Plugin/]]&#039;&#039; directories  They break down into several categories.  The most prominent being:&lt;br /&gt;
* [[EPrints Glossary#Export plugin|Export plugins]]&lt;br /&gt;
* [[EPrints Glossary#Import plugin|Import plugins]]&lt;br /&gt;
* [[EPrints Glossary#Screen plugin|Screen plugins]]&lt;br /&gt;
Other plugin categories include [[#Box plugin|Box]], Convert, [[#Event plugin|Event]], InputForm, [[#Issue|Issues]], Search and Storage.  &lt;br /&gt;
&lt;br /&gt;
[[How_to_contribute#Write_a_Plugin|Bespoke plugins]] can be written for an [[#Archive|archive]] and located in the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
Often the term &amp;quot;[[#Bazaar plugin|Bazaar plugin]]&amp;quot; is used to refer to a package of functionality (a.k.a. [[#EPM|EPM]]) that can be installed from the [[#Bazaar|Bazaar]].  Although an EPM can often contain individual plugins, it is a complex set of files rather than a single plugin file.  If an EPM does contain individual plugins, they will be installed to the &#039;&#039;lib/plugins/EPrints/Plugin/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Phrase ===&lt;br /&gt;
A phrase in [[#EPrints repository software|EPrints repository software]] is some text or HTML markup associated with an associated placeholder ID defined using [[Phrase_Format|EPrints&#039; bespoke XML markup]].  Phrases have various purposes.  One is to ensure consistent use of terminology throughout the [[#Archive|archive]].  It also essential for supporting multi-language archives.  They are used for defining all [[#Metadata field|metadata field]] names and their [[#Help text|help texts]].  They are also used extensively in [[#Screen plugin|screen plugins]] to allow them to be customised with informative messages.&lt;br /&gt;
&lt;br /&gt;
A prominent example of a phrase is an archive&#039;s name which is appears in the archive&#039;s &#039;&#039;[[archives/ARCHIVEID/cfg/lang/en/phrases/|cfg/lang/en/phrases]]/archive_name.xml&#039;&#039;, as follows:&lt;br /&gt;
 &amp;lt;epp:phrase id=&amp;quot;archive_name&amp;quot;&amp;gt;Example Archive&amp;lt;/epp:phrase&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Policies page ===&lt;br /&gt;
The policies page is a [[#Static page|static page]] available at the equivalent URL to:&lt;br /&gt;
 http://example.eprints.org/policies.html&lt;br /&gt;
The page contains policies for use of the [[#Archive|archive]] typically based on [https://scholarlycommunications.jiscinvolve.org/wp/2020/04/03/an-update-from-opendoar-policy-support-and-repositories-galore/ OpenDOAR].  This contains sections for:&lt;br /&gt;
* &#039;&#039;&#039;Metadata Policy&#039;&#039;&#039; stating the access rights and permissions for information describing items in the repository, and the minimum metadata requirements.&lt;br /&gt;
* &#039;&#039;&#039;Data Policy&#039;&#039;&#039; stating the access rights and (re-)use permissions for full-text and other full data items.&lt;br /&gt;
* &#039;&#039;&#039;Content Policy&#039;&#039;&#039; stating the types and versions of documents and datasets held.&lt;br /&gt;
* &#039;&#039;&#039;Submission Policy&#039;&#039;&#039; concerning eligible depositors, quality control and copyright statements.&lt;br /&gt;
* &#039;&#039;&#039;Preservation Policy&#039;&#039;&#039; concerning the long-term retention, migration, and withdrawal protocols.&lt;br /&gt;
&lt;br /&gt;
=== Preview image ===&lt;br /&gt;
This is a thumbnails or larger image that is a snapshot of the uploaded [[#Document|document]].  This is typically displayed on the [[#Abstract page|abstract page]], where hovering over it will display a larger version, which may be useful in determining if the document in the one the [[#Visitor|visitor]] expected.  Preview images for a document can be generate from the command line using the [[API:bin/epadmin|epadmin]] command&#039;s &#039;&#039;redo_thumbnails&#039;&#039; option.&lt;br /&gt;
&lt;br /&gt;
=== Preview tab ===&lt;br /&gt;
The preview tab is part of the [[#EPrint view page|eprint view page]] which displays a preview of the [[#Abstract page|abstract page]] for the [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
=== Public facing pages ===&lt;br /&gt;
This is used to refer to web pages in an [[#Archive|archive]] that are accessible to [[#Visitors|visitors]] without need to login.  This are also sometimes referred to as [[#Front end pages|front end pages]].&lt;br /&gt;
&lt;br /&gt;
=== Publication flavour ===&lt;br /&gt;
This is a [[#Flavour|flavour]] of [[#EPrints repository software|EPrints repository software]] version 3.4+.  It is intended to produce [[#Repository|repositories]] for research publications.  This code for this flavour was separated from the [[#Core codebase|core codebase]] for EPrints 3.4, so that EPrints as a whole could be more easily customisable for other purpose such as [[#Data flavour|research data]] and [[#Education flavour|open education]].  The separated code and configuration can be found under [[flavours/pub_lib/]], where configuration files override those under [[lib/]] but are overridden by those at an [[#Archive level|archive level]].&lt;br /&gt;
&lt;br /&gt;
=== Publication record ===&lt;br /&gt;
Same as [[#EPrint|eprint]].&lt;br /&gt;
&lt;br /&gt;
== Q ==&lt;br /&gt;
== R ==&lt;br /&gt;
=== Regular user ===&lt;br /&gt;
This is a [[#User|user]] whose account provides them with standard access to an [[#Archive|archive]] allowing then to deposit [[#EPrint|eprints]] for [[#Review buffer|review]] and manage their [[#User profile|user profile]].  With [[#EPrints repository software|EPrints repository software]] this type of user account just referred to as &amp;quot;user&amp;quot;.  When describing this user, the adjective &amp;quot;regular&amp;quot; is used to distinguish this specific type of user from users more generally.&lt;br /&gt;
&lt;br /&gt;
=== Repository ===&lt;br /&gt;
This is an individual installation of the [[#EPrints repository software|EPrints repository software]] onto a server.  A repository may host many [[#Archive|archives]] but they all use the same [[#Core codebase|core codebase]].  Sometimes a repository will host only a single archive and therefore, the terms repository and archive are often used interchangeably and often the latter is referred to as a &amp;quot;repository archive&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Repository admin ===&lt;br /&gt;
Short for repository administrator, this is a level of [[#User|user]] account that give maximum access to an [[#Archive|archive]].  Allowing the user to carry out [[#Regular user|regular user]] actions such as depositing an [[#EPrint|eprint]], [[#Editor|editorial]] actions like reviewing eprints submitted by a regular user and administrative actions, in particular those available through the [[#Admin menu|admin menu]].&lt;br /&gt;
&lt;br /&gt;
=== Request ===&lt;br /&gt;
This is a [[#Data object|data object]] that relates to a request made by a [[#User|user]] or [[#Visitor|visitor]] about a specific [[#EPrint|eprint]] or [[#Document|document]].  The most common request is [[#Request copy|request copy]] by a visitor for access to a document that is [[#Document security|restricted]].  In some [[#Archive|archives]] it may also be enabled to allow users to submit change requests to eprints in the [[#Live archive|live archive]], if they notice an error in their [[#Metadata|metadata]].&lt;br /&gt;
&lt;br /&gt;
=== Request copy ===&lt;br /&gt;
Sometimes also referred to as &amp;quot;request a copy&amp;quot; this is a button or link on an [[#Abstract page|abstract page]], allowing a [[#Visitor|visitor]] to request a copy of a [[#Document|document]] that is [[#Embargo|currently]] [[#Document security|restricted]].  If the [[#EPrint|eprint]] has its &#039;&#039;contact email&#039;&#039; [[#Metadata field|metadata field]] this will email that address with the request sent by the visitor.  If that email addresses matches that of a [[#User|user]] the email sent will contain accept and reject links.  Where the former will provide a link in the email response to the visitor, giving them temporary access to the restricted document.&lt;br /&gt;
&lt;br /&gt;
=== REST API ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] provides a standard [https://www.redhat.com/en/topics/api/what-is-a-rest-api REST API] that allows third-party applications to create, read, update and destroy various [[#Data object|data objects]] within an [[#Archive|archive]].  In EPrints, the REST API provides similar functionality to the [[#CRUD API|CRUD API]], albeit under a URL path like:&lt;br /&gt;
 https://example.eprints.org/rest/&lt;br /&gt;
&lt;br /&gt;
=== Retired ===&lt;br /&gt;
This is an [[#EPrint status|eprint status]] for [[#EPrint|eprints]] that have been in the [[#Live archive|live archive]] but have been removed for some reason.  The advantage of retiring an eprint rather than deleting it, is that it can be restored, if it was removed erroneously from the live archive.  Also, the [[#Abstract page|abstract page]] will display a message saying the eprint has been removed rather than a &amp;quot;404 Not Found&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
=== Review buffer ===&lt;br /&gt;
This is an [[#EPrint status|eprint status]] of [[#EPrint|eprints]] that have be deposited by a [[#User|user]] but need to be reviewed by an [[#Editor|editor]] before being added to the [[#Live archive|live archive]].  Review buffer also refers to all eprints that currently have this status and can be accessed view the &#039;&#039;Review&#039;&#039; link in the [[#User menu|user menu]].&lt;br /&gt;
&lt;br /&gt;
=== Revision ===&lt;br /&gt;
Some [[#First class data object|first class data objects]] support [[#Revision file|revision files]] and [[#History|history data objects]] to track their changes over time.  By default there are only [[#EPrint revision|eprint revisions]].&lt;br /&gt;
&lt;br /&gt;
=== Revision file ===&lt;br /&gt;
This is a file on disk that stores [[#EPrints XML|EPrints XML]] markup for the [[#Metadata|metadata]] for a [[#Data object|data object]].  By default, revision files are only generated for [[#EPrint|eprints]] and can be found within the &#039;&#039;revisions&#039;&#039; directory for that eprint&#039;s sub-directory under the [[#Documents directory|documents directory]].  E.g.&lt;br /&gt;
 EPRINTS_PATH/archives/ARCHIVEID/documents/disk0/00/00/00/01/revisions/1.xml&lt;br /&gt;
The revisions are used in an eprint&#039;s [[#History tab|history tab]] to generate a listing of changes between one [[#EPrint revision|revision]] and the next.&lt;br /&gt;
&lt;br /&gt;
== S ==&lt;br /&gt;
=== Saved search ===&lt;br /&gt;
This is a [[#Second class data object|second class]] [[#Data object|data object]] that records the criteria of a particular search made by a [[#User|user]].  Its purpose is to allow the user (or even some [[Additional_Recipients_on_Saved_Searches|additional recipients]]) to receive regular email updates about results that meet these criteria.&lt;br /&gt;
&lt;br /&gt;
=== Screen plugin ===&lt;br /&gt;
This is a [[#Plugin|plugin]] designed to provide a &amp;quot;screen&amp;quot;, which is effectively a dynamic page to allow the [[#User|user]] to carry out some action on the [[#Archive|archive]].  Some of the most significant screen plugins are for:&lt;br /&gt;
# Logging in and out of the archive.&lt;br /&gt;
# Managing a [[#Data object|data object]]&#039;s [[#Workflow|workflow]].&lt;br /&gt;
# Providing the [[#Admin menu|admin menu]].&lt;br /&gt;
# Reviewing [[#EPrint|eprints]].&lt;br /&gt;
# Editing [[#Subject|subjects]].&lt;br /&gt;
# Searching for users or eprints.&lt;br /&gt;
By default, screen plugins can be found in the &#039;&#039;[[perl_lib/EPrints/Plugin/Screen/]]&#039;&#039; directory.  Bespoke screen plugins can also be added to the archive&#039;s &#039;&#039;cfg/plugins/EPrints/Plugin/Screen/&#039;&#039; directory or may be installed from the [[#Bazaar|Bazaar]] into the &#039;&#039;lib/plugins/EPrints/Plugin/Screen/&#039;&#039; directory.&lt;br /&gt;
&lt;br /&gt;
=== Second class data object ===&lt;br /&gt;
These are [[#Data object|data objects]] that are [[#Sub-object|sub-objects]] of a [[#First class data object|first class data object]].  These include:&lt;br /&gt;
* [[Document Object]] (sub-object of [[#EPrint|eprint]]).&lt;br /&gt;
* [[History Object]] (sub-object of eprint or potentially any data object that has its history recorded).&lt;br /&gt;
* [[Saved Search Object]] (sub-object of [[#User|user]]).&lt;br /&gt;
&lt;br /&gt;
=== Simple search ===&lt;br /&gt;
A simple search over [[#EPrint|eprints]] in the [[#Live archive|live archive]].  Unlike [[#Advanced search|advanced search]] this provides a single input field to search against multiple [[#Metadata field|metadata fields]].  Simple search configuration can be found in [[eprint_search_simple.pl]].&lt;br /&gt;
&lt;br /&gt;
=== Site lib ===&lt;br /&gt;
Creating a directory in the [[#EPrints path|EPrints path]] with the name &#039;&#039;site_lib&#039;&#039;, will allow you modify [[#Core codebase|core code and configuration]], which will apply to all of the [[#Archive|archives]] in your [[#Repository|repository]].  If you are running EPrints version 3.4+, be sure to also add &#039;&#039;site_lib&#039;&#039; to your [[#Flavour|flavour&#039;s]] [[#Inc file|inc file]].&lt;br /&gt;
&lt;br /&gt;
Sometimes you may need modify the functionality of files in the core codebase but you don&#039;t want to change them, as this will involve having to merge any future changes when you upgrade [[#EPrints repository software|EPrints repository software]].  This is particularly useful if you need to modify a non-plugin code file, ([[#Plugin|plugin]] files can be [[Instructions_for_local_plugins|overridden]] by [[#Archive level|archive level]] versions), E.g. &#039;&#039;[[API:EPrints/Repository|perl_lib/EPrints/Repository.pm]]&#039;&#039;, which can simply be copied to &#039;&#039;site_lib/EPrints/plugins/Repository.pm&#039;&#039; rather than modifying it in place.  However, when you do upgrade EPrints, you will still need to reconcile any updates to the &#039;&#039;perl_lib/&#039;&#039; version of this file with your version in &#039;&#039;site_lib/plugins/&#039;&#039;.  This will be a much more straightforward task, (than if you had just modified the version in &#039;&#039;perl_lib/&#039;&#039;), as both files will still be in place to compare.  One particular use of &#039;&#039;site_lib&#039;&#039; is for inter-version patches from [https://github.com/eprints/eprints3.4|EPrints&#039; GitHub].  As when it comes to an upgrade, the versions of the files in &#039;&#039;site_lib/plugins/&#039;&#039; can just be removed, as their modifications will be present in their &#039;&#039;perl_lib/&#039;&#039; equivalents.&lt;br /&gt;
&lt;br /&gt;
=== Staff search ===&lt;br /&gt;
Search across all [[#EPrint|eprints]] whatever their [[#EPrint status|eprint status]].  See [[Admin/Editorial Tools/Search items]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== Static page ===&lt;br /&gt;
This is a page for an [[#Archive|archive]] that contains static content that can be cached.  Although it may also contain dynamic elements through the use of JavaScript and [https://en.wikipedia.org/wiki/Ajax_(programming) Ajax].  Examples of static pages are:&lt;br /&gt;
* The [[#Homepage|homepage]]&lt;br /&gt;
* The about/information page (e.g. &amp;lt;tt&amp;gt;http://example.eprints.org/information.html&amp;lt;/tt&amp;gt;)&lt;br /&gt;
* The [[#Contact page|contact page]] &lt;br /&gt;
* The [[#Policies page|policies page]]&lt;br /&gt;
To clear the caches of old static pages and other static content (like JavaScript and CSS) and generate new cached versions, the [[API:bin/generate_static|bin/generate_static]] command can be used.&lt;br /&gt;
&lt;br /&gt;
Other pages like [[#Browse view|browse view]] menus and listings and [[#Abstract page|abstract pages]] are also cached as they contain static content, which only need be updated periodically or when the underlying [[#EPrint|eprint]] changes.  These are sometimes also referred to as static pages but can be refreshed using [[API:bin/epadmin#|bin/epadmin]] command (or through the [[Admin/System Tools|Admin menu]]) or regenerated using the [[API:bin/generate_views|bin/generate_views]] and [[API:bin/generate_abstracts|bin/generate_abstracts]] commands.&lt;br /&gt;
&lt;br /&gt;
=== Sub-object ===&lt;br /&gt;
This is a concept where a [[#Data object|data object]] is part of another data object, such as a [[#Document|document]] being part of an [[#EPrint|eprint]].  Where the former is known as a [[#Second class data object|second class data object]] and the latter is known as a [[#First class data object|first class data object]].  &lt;br /&gt;
&lt;br /&gt;
[[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]] is an abstract class within [[#EPrints repository software|EPrints repository software]], which second class (and [[#Third class data object|third class]]) data object classes extend.&lt;br /&gt;
&lt;br /&gt;
=== Subject ===&lt;br /&gt;
A [[Subject Object|subject]] is a [[#Data object|data object]] that stores a node for the [[#Subject tree|subject tree]] of an [[#Archive|archive]].  &lt;br /&gt;
&lt;br /&gt;
A subject has three separate [[#Metadata field|metadata fields]] to describe the value it represents:&lt;br /&gt;
* &#039;&#039;&#039;ID&#039;&#039;&#039; - A short text string providing the unique ID for that subject.&lt;br /&gt;
* &#039;&#039;&#039;Name&#039;&#039;&#039; - The human-readable name for that subject.&lt;br /&gt;
* &#039;&#039;&#039;Sort value&#039;&#039;&#039; - The value used to determine the ordering of the subject amongst its siblings in the subject tree (e.g. in a [[#Browse view|browse view]]).&lt;br /&gt;
&lt;br /&gt;
A subject also contains a &#039;&#039;&#039;parent&#039;&#039;&#039; metadata field that links it into the rest of the subject tree and a &#039;&#039;&#039;depositable&#039;&#039;&#039; metadata field that indicate whether it is an option that can be selected when the subject tree or part thereof is used to provide a metadata field for another data object (e.g. [[#EPrint|eprint]]).&lt;br /&gt;
&lt;br /&gt;
=== Subject tree ===&lt;br /&gt;
This is made up of [[#Subject|subject]] [[#Data object|data objects]] and is used to provide hierarchical sets of options for various [[#Metadata field|metadata fields]] or other data objects, such as [[#EPrint|eprints]], as a [[Subject_field|subject metadata field]].  In particular:&lt;br /&gt;
* &#039;&#039;&#039;eprint subjects&#039;&#039;&#039; - Records one or more subjects (e.g. from the Library of Congress or Dewey decimal classifications) under which the publication represented by this eprint covers.&lt;br /&gt;
* &#039;&#039;&#039;eprint [[#Division|divisions]]&#039;&#039;&#039; - Records one or more divisions within an organisation/institution (e.g. faculty, school, department, etc.) for which authors of the publication represented by the eprint are members.&lt;br /&gt;
The subject tree can be edited by the [[#Admin menu|admin menu]] using the &amp;quot;[[Admin/Config. Tools/Edit subject|Edit subject]]&amp;quot; page.&lt;br /&gt;
&lt;br /&gt;
=== Succeeds ===&lt;br /&gt;
An [[#EPrint|eprint]] [[#Data object|data object]] contains a [[#Metadata field|metadata field]] called &#039;&#039;succeeds&#039;&#039;.  This metadata field can store the ID of an eprint for which the current eprint supersedes.  This may be used where a new version of the publication is produced but you don&#039;t want to or cannot replace the [[#Document|document]] in the original eprint.  By using the succeeds field, the original eprint will be removed from search and its [[#Abstract page|abstract page]] will display a warning saying it is not the latest version of the eprint.&lt;br /&gt;
&lt;br /&gt;
=== Summary page ===&lt;br /&gt;
Same as [[#Abstract page|abstract page]].  Sometimes even referred to as the abstract/summary page.&lt;br /&gt;
&lt;br /&gt;
=== Summary table ===&lt;br /&gt;
A table on an [[#Abstract page|abstract page]] that lists the names and values for specific [[#Metadata field|Metadata fields]] for the [[#EPrint|eprint]].  These can be specified, typically in the archive&#039;s &#039;&#039;cfg/cfg.d/[[eprint_render.pl]]&#039;&#039;, under &amp;lt;tt&amp;gt;$c-&amp;gt;{summary_page_metadata}&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== Sword API ===&lt;br /&gt;
This is an API provided by [[#EPrints repository software|EPrints repository software]] that complies with the [https://guides.dataverse.org/en/latest/api/sword.html SWORD specification] for a RESTful API.  It is similar to EPrints&#039; [[#CRUD API|CRUD]] and [[#REST API|REST]] APIs but is intended to facilitate smoother interoperability between different types of Open Access repository, using an [https://datatracker.ietf.org/wg/atompub/about/ atompub] based XML format and the [https://www.dublincore.org/specifications/dublin-core/dcmi-terms/ Dublin Core schema] for [[#Metadata|metadata]] terms.&lt;br /&gt;
&lt;br /&gt;
=== System field ===&lt;br /&gt;
A [[#Metadata field|metadata field]] that is core to a [[#Data object|data object]].  Usually this field is for administrative field of little interest to a visitor or regular user but required for the management of the data object.  Typically such fields are hard-coded into the data object rather than customisable in configuration.  E.g. the &amp;lt;tt&amp;gt;dir&amp;lt;/tt&amp;gt; field for an [[#EPrint|eprint]] that records the location where uploaded [[#Document|documents]] to an eprint should be store on the filesystem.&lt;br /&gt;
&lt;br /&gt;
== T ==&lt;br /&gt;
=== Template ===&lt;br /&gt;
[[#EPrints repository software|EPrints repository software]] uses templates to apply [[#Branding|branding]] to a [[#Repository|repository]] or individual [[#Archive|archive]].  These templates provide the HTML structure for an archive&#039;s web pages and can be found in one of the following directories:&lt;br /&gt;
# [[lib/templates/]]&lt;br /&gt;
# [[flavours/pub_lib/lang/en/templates/]]&lt;br /&gt;
# [[archives/ARCHIVEID/cfg/templates/]]&lt;br /&gt;
# [[archives/ARCHIVEID/cfg/lang/en/templates/]]&lt;br /&gt;
However, there are additional directories templates maybe found if you use [[#Site lib|site_lib]] or a [[#Theme|theme]].  The higher the number determines which template will be used if they have the same name.&lt;br /&gt;
&lt;br /&gt;
The main template file is called &#039;&#039;&#039;default.xml&#039;&#039;&#039;, which will be used if not otherwise specified in the XML markup for the [[#Static page|static page]]. Also, other [[#Public facing pages|public facing pages]] such as [[#Simple search|simple]] and [[#Advanced search|advanced]] search, [[#Abstract page|abstract pages]] and [[#Browse view|browse views]] will use the default template.  Since EPrints version 3.4. [[#Management pages|management pages]] will use the &#039;&#039;&#039;default_internal.xml&#039;&#039;&#039; template.&lt;br /&gt;
&lt;br /&gt;
Bespoke template files can be defined and used (e.g. &#039;&#039;mytemplate.xml&#039;&#039;).  For applying to static pages this can be done by setting the &amp;lt;tt&amp;gt;&amp;lt;xpage:template&amp;gt;&amp;lt;/tt&amp;gt;.  For applying to browse views by setting the &amp;lt;tt&amp;gt;template&amp;lt;/tt&amp;gt; attribute for the view in [[views.pl]] and for applying to abstract pages setting the &amp;lt;tt&amp;gt;$template&amp;lt;/tt&amp;gt; in the parameters returned by &amp;lt;tt&amp;gt;$c-&amp;gt;{eprint_render}&amp;lt;/tt&amp;gt; in [[eprint_render.pl]].  See [[Branding_with_confidence#Taking_control|Branding with confidence - Taking control]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== Theme ===&lt;br /&gt;
If you have multiple [[#Archive|archives]] you want to apply the same [[#Branding|branding]] you may want to create a theme.  Themes can be found at &#039;&#039;[[lib/themes/]]&#039;&#039; and can be used by an archive by modifying the following setting in [[branding.pl]]:&lt;br /&gt;
 $c-&amp;gt;{theme} = &#039;THEMEID&#039;;&lt;br /&gt;
A theme can contain [[#Template|templates]], [[#Phrase|phrases]], [[#Static page|static pages]], JavaScript, CSS, images and icons.  Also, as the theme has its own  directory structure, it is easy to manage under version control and checkout across multiple [[#Repository|repositories]] or even make into an [[#EPM|EPM]].&lt;br /&gt;
&lt;br /&gt;
=== Third class data object ===&lt;br /&gt;
These are [[#Data object|data objects]] that are sub-objects of [[#Second class data object|second class data objects]] to exist, which in turn are sub-objects of [[#First class data object|first class data objects]].  The main example of such a data object in [[#EPrints repository software|EPrints repository software]] is a [[#File|file]] data object.&lt;br /&gt;
 File --sub-object of--&amp;gt; Document --sub-object of--&amp;gt; EPrint&lt;br /&gt;
&lt;br /&gt;
=== Trigger ===&lt;br /&gt;
[[Triggers]] allow a function to be defined that will be called at a particular execution point.  Such as before or after an eprint record is committed or when rewriting the request for a URL to return the appropriate resource.&lt;br /&gt;
&lt;br /&gt;
== U ==&lt;br /&gt;
=== User ===&lt;br /&gt;
A [[User Object|User]] is a [[#First class data object|first class]] [[#Data object|Data object]] in [[#EPrints repository software|EPrints repository software]].  It represents a user of [[#Repository|Repository]] and provides an account under which that user can login.  Storing [[#Metadata|metadata]] about that user, such as their username, given and family names, email address, department, etc.&lt;br /&gt;
&lt;br /&gt;
=== User history ===&lt;br /&gt;
This is the history of changes the [[#User|user]] has made to an [[#EPrint|eprint]] (or in fact any [[#First order data object|first order data object]] that supports [[#Revision|revisions]]) and can be found in the [[#History tab|user history tab]] on the user&#039;s [[#View page|view page]].  This is compiled by finding all [[#History|history data objects]] for the particular user and then comparing these associated revision files with their previous revision files.&lt;br /&gt;
&lt;br /&gt;
=== User menu ===&lt;br /&gt;
This is the menu available to [[#User|users]] once they are logged in.  (Although it does contain the &amp;quot;Login&amp;quot; and &amp;quot;[[#User registration|Create account]]&amp;quot; links when a user is not logged in).  This is sometimes also referred to as [[#Key tools|key tools]], as that is the ID used in configuration. By default, this contains the following options:&lt;br /&gt;
* &#039;&#039;&#039;Manage deposits&#039;&#039;&#039; - Create and edit [[#EPrint|eprint]] [[#Data object|data objects]].&lt;br /&gt;
* &#039;&#039;&#039;Manage records&#039;&#039;&#039; - Create and edit various types of data object &#039;&#039;([[#Repository admin|repository admins only]])&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Profile&#039;&#039;&#039; - View and edit the current [[#User profile|user&#039;s profile]].&lt;br /&gt;
* &#039;&#039;&#039;Saved searches&#039;&#039;&#039; - View and edit the current user&#039;s [[#Saved search|saved searches]].&lt;br /&gt;
* &#039;&#039;&#039;Review&#039;&#039;&#039; - Review eprints deposited by users into the [[#Review buffer|review buffer]] to see if they can be moved to the [[#Live archive|live archive]] &#039;&#039;([[#Editor|editors]] and repository admins only)&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Admin&#039;&#039;&#039; - Links to the [[#Admin menu|admin menu]] &#039;&#039;(repository admins only)&#039;&#039;.&lt;br /&gt;
* &#039;&#039;&#039;Logout&#039;&#039;&#039; - logout of the [[#Archive|archive]] as the current user.&lt;br /&gt;
Additional links (for [[#Screen plugin|screen plugins]]) can be added to the user menu by editing adding a line like the following to a configuration file in the archive&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory:&lt;br /&gt;
 $c-&amp;gt;{plugins}-&amp;gt;{&amp;quot;Screen::MyScreenPlugin&amp;quot;}-&amp;gt;{appears}-&amp;gt;{key_tools} = 1000;&lt;br /&gt;
The number (i.e. 1000) specifies the position the link to this screen plugin will appear relative to others.  The higher the number the later in the menu it will appear.&lt;br /&gt;
&lt;br /&gt;
To add the user menu to a [[#Template|template]], you need to include the following snippet of [[#EPrints XML|EPrints XML]]:&lt;br /&gt;
 &amp;lt;epc:pin ref=&amp;quot;login_status&amp;quot;/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== User privilege ===&lt;br /&gt;
An action a [[#User|user]] is permitted to perform.  See [[User Roles and Privileges]].&lt;br /&gt;
&lt;br /&gt;
=== User profile ===&lt;br /&gt;
A page displaying the [[#Metadata|metadata]] about a [[#User|user]].  This often links to a page where these metadata can be modified.&lt;br /&gt;
&lt;br /&gt;
=== User registration ===&lt;br /&gt;
By default, [[#EPrints repository software|EPrints repository software]] allows [[#User|users]] to register by following the &amp;quot;Create account&amp;quot; link in the [[#User menu|user menu]].  This allows them to create a user account, which most then be activated by clicking the link on an email sent to the email address for the is registered user.  &lt;br /&gt;
&lt;br /&gt;
Often you may not want unrestricted user registration.  If this is the case, you should copy [[registration.pl]] that can be found in [[lib/cfg.d/]] to the [[#Archive level|archive level]] (i.e. the archive&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory) and change the following setting to 0:&lt;br /&gt;
 $c-&amp;gt;{allow_web_signup} = 0;&lt;br /&gt;
&lt;br /&gt;
=== User review scope ===&lt;br /&gt;
[[#Editor|editor]] [[#User|users]] are allowed to review deposited [[#EPrint|eprints]] in the [[#Review buffer|review buffer]] to check whether the can be moved to the [[#Live archive|live archive]] and make any modifications required.  Sometimes you may only want a particular editor to be able to review certain eprints, which are in their area of expertise.  This can be done by setting their [[#Editorial rights restriction|editorial rights restriction]] in their [[#User profile|user profile]].  By default, restrictions can be set on the following three eprint fields:&lt;br /&gt;
* [[#Division|divisions]]&lt;br /&gt;
* [[#Subject|subjects]]&lt;br /&gt;
* [[#EPrint type|type]]&lt;br /&gt;
However, this can be modified by copying [[user_review_scope.pl]] to the [[#Archive level|archive level]] (i.e. the [[#Archive|archive]]&#039;s [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d/]] directory) and edit the setting &amp;lt;tt&amp;gt;$c-&amp;gt;{editor_limit_fields}&amp;lt;/tt&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
=== User role ===&lt;br /&gt;
A set of [[#User privileges|privileges]] that a [[#User|user]] has permission to perform.  See [[User Roles and Privileges]].&lt;br /&gt;
&lt;br /&gt;
=== User search ===&lt;br /&gt;
A form for searching across the [[#User|users]] in an [[#Archive|archive]].  See [[Admin/Editorial Tools/Search users|Search users]] for more information.&lt;br /&gt;
&lt;br /&gt;
=== User workarea ===&lt;br /&gt;
This is the status of an [[#EPrint|eprint]] whilst it is being edited by the [[#Depositing user|depositing user]].  This status is often also referred to as [[#Inbox|inbox]].  User workarea can sometimes refer to the &#039;&#039;Manage deposits&#039;&#039; page where the current [[#User|user]] can see a listing of all the EPrints they have created.&lt;br /&gt;
&lt;br /&gt;
== V ==&lt;br /&gt;
=== View page ===&lt;br /&gt;
The view page displays information about a [[#Data object|data object]], typically an [[#EPrint|eprint]].  This is why &amp;quot;view page&amp;quot; is often used as shorthand for [[#EPrint view page|eprint view page]].&lt;br /&gt;
&lt;br /&gt;
=== Virtual dataset ===&lt;br /&gt;
A virtual [[#Dataset|dataset]] is one that is derived from a real dataset.  In particular, [[#EPrints repository software|EPrints repository software]] has virtual datasets for:&lt;br /&gt;
* [[#Live archive|Live archive]] &lt;br /&gt;
* [[#Review buffer|Review buffer]] &lt;br /&gt;
* [[#User workarea|User workarea]] &lt;br /&gt;
* [[#Retired|Retired]] &lt;br /&gt;
All of these are sub-sets of the [[#EPrint|eprint]] dataset where the [[#EPrint status|eprint status]] is a particular value.  &lt;br /&gt;
&lt;br /&gt;
Additional virtual datasets can be configured for a [[#Repository|repository]] or at an [[#Archive level|archive level]]. &lt;br /&gt;
&lt;br /&gt;
=== Virtual metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] whose values are not actually stored in the database but are generated dynamically by a function probably using the values of one or more other metadata fields.  This may be useful when editing the [[#Citation|citation]] style as part of designing your [[#Archive|archive]]&#039;s [[#Abstract page|abstract page]], as being able to reference a field is very straightforward.  A basic example might be that you want to display on the abstract page the number of [[#Document|documents]] for the [[#EPrint|eprint]].  Creating a virtual field for the eprint called &#039;&#039;num_docs&#039;&#039; might look as follows:&lt;br /&gt;
 {&lt;br /&gt;
   name =&amp;gt; &#039;num_docs&#039;,&lt;br /&gt;
   type =&amp;gt; &#039;int&#039;,&lt;br /&gt;
   virtual =&amp;gt; 1,&lt;br /&gt;
   render_value =&amp;gt; &#039;get_num_docs&#039;,&lt;br /&gt;
 },&lt;br /&gt;
Then you would define a function in a configuration file and assign it to &amp;lt;tt&amp;gt;$c-&amp;gt;{get_num_docs}&amp;lt;/tt&amp;gt;.  You could then simply include this in the &#039;&#039;summary_page.xml&#039;&#039; eprint citation file as:&lt;br /&gt;
 &amp;lt;epc:print expr=&amp;quot;num_docs&amp;quot;/&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Visitor ===&lt;br /&gt;
A visitor to an [[#Archive|archive]] is distinguished from a [[#User|user]], as they are not logged in and they are accessing the archive anonymously.  They are probably just wanting to view an [[#Abstract page|abstract page]] or download an open access publication [[#Document|document]].&lt;br /&gt;
&lt;br /&gt;
=== Volatile metadata field ===&lt;br /&gt;
This is a [[#Metadata field|metadata field]] that is liable to change on a regular basis but does not really affect the overall content of the [[#Data object|data object]]&#039;s [[#Metadata|metadata]], so should not prompt a new [[#Revision|revision]] to be generated.  A metadata field can be made volatile by setting the following attribute in the field definition:&lt;br /&gt;
 volatile =&amp;gt; 1,&lt;br /&gt;
Metadata fields that are only intended for administrative purposes are often defined as volatile, such as the [[#EPrint|eprint]] [[#EPrint locking|edit_lock]] metadata field.  If a [[#User|user]] takes an edit lock on an eprint, if the edit_lock metadata field was non-volatile, this would lead to a new revision being create for the eprint when ultimately nothing had yet changed.  In fact, worse still, if the edit lock was released without making any changes, a further revision would be created, which would be basically the same as the revision before the user took the edit lock.&lt;br /&gt;
&lt;br /&gt;
== W ==&lt;br /&gt;
=== Workflow ===&lt;br /&gt;
[[#First class data object|First class]] [[#Data object|data objects]] in [[#EPrints repository software|EPrints repository software]] have a workflow to allow the metadata they store to be edited via a sequence of forms.  The most common of these is the [[#EPrint workflow|eprint workflow]] for the [[EPrint Object|eprint data object]].  By default the configuration for this workflow is written in XML and can be found in &#039;&#039;default.xml&#039;&#039; in either [[lib/workflows/eprint/]] or [[flavours/pub_lib/workflows/eprint/]]. If this needs to be modified it should be copied to the archive&#039;s [[Archives/ARCHIVEID/cfg/workflows/eprint/|cfg/workflows/eprint/]] directory before editing.  Explanation of the various elements and attributes are described in the [[Workflow_Format|workflow format guide]].&lt;br /&gt;
&lt;br /&gt;
=== Workflow component ===&lt;br /&gt;
These provide sections (i.e. boxes) within each [[#Workflow stage|workflow stage]].  A workflow component contain one or more [[#Metadata field|metadata fields]] or some other content to assist the [[#Metadata|metadata]] submission process.  There are various different types of workflow component that serve different purposes:&lt;br /&gt;
* &#039;&#039;&#039;Documents&#039;&#039;&#039; - For managing [[#Document|document]] [[#Sub-object|sub-objects]].&lt;br /&gt;
* &#039;&#039;&#039;Error&#039;&#039;&#039; - Used when there is an issue with the workflow component, (e.g. the metadata field included does not exist).&lt;br /&gt;
* &#039;&#039;&#039;Field&#039;&#039;&#039; - This has various sub-types for including one, several or [[#Subject|subjects]] type metadata fields.&lt;br /&gt;
* &#039;&#039;&#039;Upload&#039;&#039;&#039; - For uploading a file, (e.g. a document to an [[#EPrint|eprint]]).&lt;br /&gt;
* &#039;&#039;&#039;XHTML&#039;&#039;&#039; - Just some HTML markup.&lt;br /&gt;
&lt;br /&gt;
=== Workflow stage ===&lt;br /&gt;
As a [[#Workflow|workflow]] is a sequence (or flow) of forms a workflow stage defines one of these forms.  Stages can be defined within the [[Workflow_Format|workflow format]] to produce the order of forms required.  Each workflow stage contains one or more [[#Workflow component|workflow components]], that in turn include [[#Metadata field|metadata fields]] for the relevant [[#Data object|data object]].  Below, is the [[#EPrints XML|EPrints XML]] markup for the default ordering of workflow stages for an eprint data object:&lt;br /&gt;
 &amp;lt;flow&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;type&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;files&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;core&amp;quot;/&amp;gt;&lt;br /&gt;
   &amp;lt;stage ref=&amp;quot;subjects&amp;quot;/&amp;gt;&lt;br /&gt;
 &amp;lt;/flow&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== X ==&lt;br /&gt;
=== Xapian search ===&lt;br /&gt;
Originally [[#EPrints repository software|EPrints repository software]] created its own database index to support search.  However, this was not particularly efficient or quick to return results, so it started to use a [https://xapian.org/ Xapian] search index to speed up [[#Simple search|simple search]].  ([[#Advanced search|Advanced search]] still uses the database index).  Also, it made it possible to provide relevance based ordering, so that more relevant results could be displayed nearer the top of the search results.  Xapian also gives the potential to provide faceted based search, where search results can be refined by limiting the values for a particular facet (i.e. for EPrints, a [[#Metadata field|metadata field]]).&lt;br /&gt;
&lt;br /&gt;
== Y ==&lt;br /&gt;
== Z ==&lt;br /&gt;
=== Zero flavour ===&lt;br /&gt;
This is a minimal [[#Flavour|flavour]] to create very basic [[#Archive|archives]] with simple [[#EPrint|eprint]] [[#Data object|data objects]].  This may be useful if you want to develop a non-publications repository that requires a lot of bespoke configuration.  As it saves having to override exisiting publications-based configuration.&lt;br /&gt;
&lt;br /&gt;
[[Category:FAQ]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17574</id>
		<title>Archive:Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17574"/>
		<updated>2026-10-14T08:55:46Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Cause the new template to be applied */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
[[Category:Branding]]&lt;br /&gt;
There are several different types of page in the eprints WebsiteInterface and they are generated in different ways. See WebsiteInterface for an explanation.&lt;br /&gt;
&lt;br /&gt;
Every page on eprints is wrapped in the site template. This can be found at /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
==Changing the Template==&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
Make your changes. Be careful not to remove the &amp;lt;pin&amp;gt; elements as this is how eprints knows where to insert information. &lt;br /&gt;
&lt;br /&gt;
Note that this file is XML so all tags must be closed correctly.&lt;br /&gt;
&lt;br /&gt;
==Cause the new template to be applied==&lt;br /&gt;
&lt;br /&gt;
TIP: If you want to see the new template in situ without waiting to update all the webpages then run &amp;quot;generate_abstracts myid 66&amp;quot; (or some other existing abstract page) and see the change on that one page.&lt;br /&gt;
&lt;br /&gt;
This is slightly different for each part of the site...&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Static page | Static pages]] ===&lt;br /&gt;
run generate_static&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Abstract page | Abstract pages]]===&lt;br /&gt;
&lt;br /&gt;
run generate_abstracts&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#EPrint view page | View pages]] ===&lt;br /&gt;
&lt;br /&gt;
run generate_views&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary# | Dynamic pages]] ===&lt;br /&gt;
&lt;br /&gt;
run force_config_reload or resart the webserver&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17573</id>
		<title>Archive:Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17573"/>
		<updated>2026-10-14T08:54:10Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Cause the new template to be applied */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
[[Category:Branding]]&lt;br /&gt;
There are several different types of page in the eprints WebsiteInterface and they are generated in different ways. See WebsiteInterface for an explanation.&lt;br /&gt;
&lt;br /&gt;
Every page on eprints is wrapped in the site template. This can be found at /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
==Changing the Template==&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
Make your changes. Be careful not to remove the &amp;lt;pin&amp;gt; elements as this is how eprints knows where to insert information. &lt;br /&gt;
&lt;br /&gt;
Note that this file is XML so all tags must be closed correctly.&lt;br /&gt;
&lt;br /&gt;
==Cause the new template to be applied==&lt;br /&gt;
&lt;br /&gt;
TIP: If you want to see the new template in situ without waiting to update all the webpages then run &amp;quot;generate_abstracts myid 66&amp;quot; (or some other existing abstract page) and see the change on that one page.&lt;br /&gt;
&lt;br /&gt;
This is slightly different for each part of the site...&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Static page | Static pages]] ===&lt;br /&gt;
run generate_static&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Abstract page| Abstract pages]]===&lt;br /&gt;
&lt;br /&gt;
run generate_abstracts&lt;br /&gt;
&lt;br /&gt;
===View pages===&lt;br /&gt;
&lt;br /&gt;
run generate_views&lt;br /&gt;
&lt;br /&gt;
===Dynamic pages===&lt;br /&gt;
&lt;br /&gt;
run force_config_reload or resart the webserver&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17572</id>
		<title>Archive:Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17572"/>
		<updated>2026-10-14T08:53:11Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* EPrints_Glossary#Static page Static pages */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
[[Category:Branding]]&lt;br /&gt;
There are several different types of page in the eprints WebsiteInterface and they are generated in different ways. See WebsiteInterface for an explanation.&lt;br /&gt;
&lt;br /&gt;
Every page on eprints is wrapped in the site template. This can be found at /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
==Changing the Template==&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
Make your changes. Be careful not to remove the &amp;lt;pin&amp;gt; elements as this is how eprints knows where to insert information. &lt;br /&gt;
&lt;br /&gt;
Note that this file is XML so all tags must be closed correctly.&lt;br /&gt;
&lt;br /&gt;
==Cause the new template to be applied==&lt;br /&gt;
&lt;br /&gt;
TIP: If you want to see the new template in situ without waiting to update all the webpages then run &amp;quot;generate_abstracts myid 66&amp;quot; (or some other existing abstract page) and see the change on that one page.&lt;br /&gt;
&lt;br /&gt;
This is slightly different for each part of the site...&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Static page | Static pages]] ===&lt;br /&gt;
run generate_static&lt;br /&gt;
&lt;br /&gt;
===Abstract pages===&lt;br /&gt;
&lt;br /&gt;
run generate_abstracts&lt;br /&gt;
&lt;br /&gt;
===View pages===&lt;br /&gt;
&lt;br /&gt;
run generate_views&lt;br /&gt;
&lt;br /&gt;
===Dynamic pages===&lt;br /&gt;
&lt;br /&gt;
run force_config_reload or resart the webserver&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17571</id>
		<title>Archive:Branding/Logos</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Archive:Branding/Logos&amp;diff=17571"/>
		<updated>2026-10-14T08:52:58Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Static pages */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
[[Category:Branding]]&lt;br /&gt;
There are several different types of page in the eprints WebsiteInterface and they are generated in different ways. See WebsiteInterface for an explanation.&lt;br /&gt;
&lt;br /&gt;
Every page on eprints is wrapped in the site template. This can be found at /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
==Changing the Template==&lt;br /&gt;
&lt;br /&gt;
Edit /opt/eprints2/archives/myid/cfg/template-en.xml&lt;br /&gt;
&lt;br /&gt;
Make your changes. Be careful not to remove the &amp;lt;pin&amp;gt; elements as this is how eprints knows where to insert information. &lt;br /&gt;
&lt;br /&gt;
Note that this file is XML so all tags must be closed correctly.&lt;br /&gt;
&lt;br /&gt;
==Cause the new template to be applied==&lt;br /&gt;
&lt;br /&gt;
TIP: If you want to see the new template in situ without waiting to update all the webpages then run &amp;quot;generate_abstracts myid 66&amp;quot; (or some other existing abstract page) and see the change on that one page.&lt;br /&gt;
&lt;br /&gt;
This is slightly different for each part of the site...&lt;br /&gt;
&lt;br /&gt;
=== [[EPrints_Glossary#Static page Static pages]] ===&lt;br /&gt;
run generate_static&lt;br /&gt;
&lt;br /&gt;
===Abstract pages===&lt;br /&gt;
&lt;br /&gt;
run generate_abstracts&lt;br /&gt;
&lt;br /&gt;
===View pages===&lt;br /&gt;
&lt;br /&gt;
run generate_views&lt;br /&gt;
&lt;br /&gt;
===Dynamic pages===&lt;br /&gt;
&lt;br /&gt;
run force_config_reload or resart the webserver&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Template:Manual&amp;diff=17570</id>
		<title>Template:Manual</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Template:Manual&amp;diff=17570"/>
		<updated>2026-10-14T08:16:27Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{box|title=Manual Sections|content=&lt;br /&gt;
* [[Introduction]]&lt;br /&gt;
** [[Contact|How to Get Help/Support]]&lt;br /&gt;
** [[History]]&lt;br /&gt;
* Installing EPrints &amp;amp; Getting Started&lt;br /&gt;
** [[Installation|Installing EPrints]]&lt;br /&gt;
*** [[Installing EPrints on RHEL/Fedora/CentOS|Installation on RHEL-based Linux]]&lt;br /&gt;
*** [[Installing_EPrints_on_Debian/Ubuntu|Installation on Debian/Ubuntu]]&lt;br /&gt;
*** [[Generic Linux Installation|Installation on Generic Linux OS]]&lt;br /&gt;
**** [[Required software]]&lt;br /&gt;
** [[Upgrading|Upgrading EPrints]]&lt;br /&gt;
** [[Setting up an Archive]]&lt;br /&gt;
** [[Backups]]&lt;br /&gt;
** [[Troubleshooting]]&lt;br /&gt;
** Advanced Installation&lt;br /&gt;
*** [[How to use EPrints with HTTPS]]&lt;br /&gt;
*** [[Setting up email]]&lt;br /&gt;
* Configuring EPrints&lt;br /&gt;
** [[Branding/Logos]]&lt;br /&gt;
** [[Metadata|Deposit Types and Metadata]]&lt;br /&gt;
** [[Organisation Hierarchy]]&lt;br /&gt;
** [[Searches]]&lt;br /&gt;
* Advanced Configuration/Howtos&lt;br /&gt;
** [[Setting up HTTPS using Let&#039;s Encrypt]]&lt;br /&gt;
** [[HTTPS-only and HSTS]]&lt;br /&gt;
** [[Shibboleth|User Authentication using Shibboleth]]&lt;br /&gt;
* Technical Reference&lt;br /&gt;
** [[EPrints configuration|EPrints Configuration Reference]]&lt;br /&gt;
** [[Repository configuration|Repository Configuration Reference]]&lt;br /&gt;
** [[Metadata|Metadata Reference]] (also [[Functions]])&lt;br /&gt;
** [[API Overview]]&lt;br /&gt;
* [[Entire Manual]] (for printing)&lt;br /&gt;
}}&lt;br /&gt;
[[Category:Manual]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Getting_Started&amp;diff=17569</id>
		<title>Getting Started</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Getting_Started&amp;diff=17569"/>
		<updated>2026-10-14T08:15:28Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page Getting Started to Setting up an Archive: Change of name to clarify page content&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Setting up an Archive]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Setting_up_an_Archive&amp;diff=17568</id>
		<title>Setting up an Archive</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Setting_up_an_Archive&amp;diff=17568"/>
		<updated>2026-10-14T08:15:28Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Ap1e26 moved page Getting Started to Setting up an Archive: Change of name to clarify page content&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{manual}}&lt;br /&gt;
[[Category:Manual]]&lt;br /&gt;
&lt;br /&gt;
==Creating an Archive==&lt;br /&gt;
&lt;br /&gt;
EPrints 3 can run run multiple archives under one install. Multiple archives will require giving additional DNS aliases to the machine running EPrints, EPrints can then create all the parts of the apache configuration file needed to run the virtual hosts.&lt;br /&gt;
&lt;br /&gt;
===Creating MySQL eprints user===&lt;br /&gt;
If you are running a modern version of Linux (e.g. Red Hat Enterprise Linux 9+ or Ubuntu 20.04+), the eprints user will not be able to connect to the MySQL database as the root user without a password.  Therefore, before running &amp;quot;epadmin create&amp;quot; later in these instructions make sure you switch to the root user, open the MySQL client and run the following commands, (substituting the password (i.e. &#039;changeme&#039;) appropriately):&lt;br /&gt;
 CREATE USER &#039;eprints&#039;@&#039;localhost&#039; IDENTIFIED by &#039;changeme&#039;;&lt;br /&gt;
 GRANT ALL PRIVILEGES ON *.* TO &#039;eprints&#039;@&#039;localhost&#039; WITH GRANT OPTION;&lt;br /&gt;
When you are asked for the &#039;&#039;&#039;Database Superuser Username&#039;&#039;&#039; and &#039;&#039;&#039;Database Superuser Password&#039;&#039;&#039; be sure to use the username and password set above.  If you are running older version of Linux where you have not needed to do the above steps.  You can probably use the default options for these to steps.&lt;br /&gt;
&lt;br /&gt;
===Creating the Archive===&lt;br /&gt;
Make sure MySQL is actually running.&lt;br /&gt;
&lt;br /&gt;
Change to your &amp;quot;eprints&amp;quot; user.&lt;br /&gt;
&lt;br /&gt;
Change directory to the eprints directory (&amp;lt;tt&amp;gt;/opt/eprints3&amp;lt;/tt&amp;gt; by default) and run the &#039;&#039;&#039;EXACT&#039;&#039;&#039; following command to create a research publications archive. (You will be prompted to answer various questions about the configuration of your archive):&lt;br /&gt;
 bin/epadmin create pub&lt;br /&gt;
&lt;br /&gt;
If you don&#039;t want a research publications archive, in the above command use &amp;lt;code&amp;gt;zero&amp;lt;/code&amp;gt; instead of &amp;lt;code&amp;gt;pub&amp;lt;/code&amp;gt;. This will create a very basic repository, which can either store very generic items or can be more greatly customised as it does not have some of the intentional restrictions that come with a Research Publications repository.  Other flavours of repository may be available but these will have to have be added their &amp;lt;tt&amp;gt;FLAVOUR_lib&amp;lt;/tt&amp;gt; to the &amp;lt;tt&amp;gt;EPRINTS_PATH/flavours/&amp;lt;/tt&amp;gt; directory.  If you run just &amp;lt;code&amp;gt;bin/epadmin create&amp;lt;/code&amp;gt; without a further parameter or one that is not recognised, the command should suggest what types (flavours) of repository archive are available.&lt;br /&gt;
&lt;br /&gt;
===Creating the Database Tables and Website ===&lt;br /&gt;
These will have been created when you created the archive.&lt;br /&gt;
&lt;br /&gt;
==Running a Live Archive==&lt;br /&gt;
===Creating a crontab===&lt;br /&gt;
When you create an archive it will start out as a development system while you learn how to set it up (and your manager keeps changing his mind) but at some point (hopefully) you will declare your archive open for business.&lt;br /&gt;
&lt;br /&gt;
At this point you should schedule certain scripts to run periodically. The best way to do this is to use &amp;quot;cron&amp;quot; which is an integral part of most UNIX systems.&lt;br /&gt;
&lt;br /&gt;
To set up cron, run (as the eprints user):&lt;br /&gt;
 % crontab -e&lt;br /&gt;
&lt;br /&gt;
Exactly what to add to the cron table is described in the following sections - &amp;quot;Browse Views&amp;quot; and &amp;quot;Subscriptions&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
There should be one set of crontab entries per archive.&lt;br /&gt;
&lt;br /&gt;
Here is an example crontab template.  &amp;lt;code&amp;gt;EPRINTS_PATH&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;ARCHIVE_ID&amp;lt;/code&amp;gt; should be replaced as appropriate.  &lt;br /&gt;
&lt;br /&gt;
{{template:EPrints_Crontab_Template}}&lt;br /&gt;
&lt;br /&gt;
For more information about [[EPrints Cron Jobs|cron jobs for EPrints, click here]].&lt;br /&gt;
&lt;br /&gt;
===Backups===&lt;br /&gt;
You should also have made sure that the system is being properly backed up. This is gone into in more detail elsewhere in the documentation.&lt;br /&gt;
&lt;br /&gt;
===OAI===&lt;br /&gt;
We would also encourage you to configure the OAI support for your archive and register it. It&#039;s quite easy - pretty much fill in the blanks in the ArchiveOAIConfig.pm file in the archive configuration directory.&lt;br /&gt;
&lt;br /&gt;
EPrints 2.1 support OAI versions 1 and 2 at URL paths /perl/oai and /perl/oai2.&lt;br /&gt;
&lt;br /&gt;
Once you register your archive (at http://www.openarchives.org) various search systems will be able to collect the metadata (titles, authors, abstract etc.) and allow more people to find records in your archive.&lt;br /&gt;
&lt;br /&gt;
See http://www.openarchives.org/ for more information on the OAI protocol. For more information setting up the OAI interface archive see the section in this documentation about Configuring an Archive.&lt;br /&gt;
&lt;br /&gt;
==Browse Views==&lt;br /&gt;
Once every so often you should run the &amp;quot;generate_views&amp;quot; script on each archive in your system to regenerate the browse views section of the site.&lt;br /&gt;
&lt;br /&gt;
This is a set of static pages. By default one per subject, and one per year (only years with papers in that year not EVERY year ever!). Some users prefer to browse the system than search it. This also gives search engines a way to reach, and index, the abstract pages.&lt;br /&gt;
&lt;br /&gt;
See the ArchiveConfig.pm config notes on how to edit the views it generates.&lt;br /&gt;
&lt;br /&gt;
See the How-To section for some suggestions on how to set up views.&lt;br /&gt;
&lt;br /&gt;
===But I don&#039;t want this feature...===&lt;br /&gt;
If you don&#039;t want to use this feature: don&#039;t, it&#039;s your archive. Remove the link from the template and front page. Don&#039;t run the generate_views script.&lt;br /&gt;
&lt;br /&gt;
===Setting it up===&lt;br /&gt;
This is best done by using the UNIX &amp;quot;cron&amp;quot; command (as user &amp;quot;eprints&amp;quot;). Cron will email &amp;quot;eprints&amp;quot; on that machine with the output, so best use the --quiet option so it only bothers you with errors.&lt;br /&gt;
&lt;br /&gt;
How often you want to run this depends on the size of your archive, and how fast the contents changes. This feature is roughly order &amp;quot;n&amp;quot;. Which means if you double the number of items in your archive then you double the time it takes to run (ish).&lt;br /&gt;
&lt;br /&gt;
Once an hour would seem a good starting point. If your archive gets real big, say more than 10000 records, then maybe once a day is more realistic - the one thing that you don&#039;t want to happen is for a new generate_views to start before the old one finishes as they will mess up each others output.&lt;br /&gt;
&lt;br /&gt;
Run generate_views on the command line to find out how long it takes.&lt;br /&gt;
&lt;br /&gt;
and add the line&lt;br /&gt;
 23 * * * * /opt/eprints2/bin/generate_views I&amp;lt;archiveid&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This runs at 23 minutes past each hour. If you have more than one archive, don&#039;t make them all start rebuilding stuff at the same time, stagger it. Otherwise once an hour everything will slow down as it fights to run several intensive scripts at once.&lt;br /&gt;
&lt;br /&gt;
See the crontab man page &amp;lt;tt&amp;gt;man 5 crontab&amp;lt;/tt&amp;gt; for more information on using cron.&lt;br /&gt;
&lt;br /&gt;
==Default Configuration==&lt;br /&gt;
EPrints configures a new archive with a set of metadata fields aimed at an archive of research papers.&lt;br /&gt;
&lt;br /&gt;
The initial &amp;quot;types&amp;quot; of eprint (book, poster, conference paper) are configured in metadata-types.xml&lt;br /&gt;
&lt;br /&gt;
The initial subjects are a subset of the library of congress subjects. Feel free to totally replace them with your own subjects, but the more standard your subject tree the more useful your metadata will be to other people.&lt;br /&gt;
&lt;br /&gt;
The authors and editors have the &amp;quot;hasid&amp;quot; option set which allows people to optionally use a unique id for a person in addition to their name (names are NOT unique!) - this can be useful for generating &amp;quot;CV&amp;quot; pages (see the views how-to) and possibly for generating statistics. Without it you will never be sure which &amp;quot;John Smith&amp;quot; wrote that paper. If you don&#039;t like this feature remove the &amp;quot;hasid&amp;quot; from the authors and editors - this will require you to recreate the tables, erasing the archive, so decide before you start. If you want to be more clear about what information goes in that field, edit the phrases &amp;lt;tt&amp;gt;eprint_fieldname_authors_id&amp;lt;/tt&amp;gt; and &amp;lt;tt&amp;gt;eprint_fieldname_editors_id&amp;lt;/tt&amp;gt; in the archive phrase file(s).&lt;br /&gt;
&lt;br /&gt;
In general: Change it! It&#039;s not a recommended system setup, just a good starting point.&lt;br /&gt;
&lt;br /&gt;
===Example Configuration===&lt;br /&gt;
The &amp;quot;epadmin create&amp;quot; script will run through a number of configuration options, an example of which is listed below. Please change the settings to suit your site configuration.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
-bash-4.1$ ./bin/epadmin create pub&lt;br /&gt;
&lt;br /&gt;
Create an EPrint Repository&lt;br /&gt;
&lt;br /&gt;
Please select an ID for the repository, which will be used to create a directory&lt;br /&gt;
and identify the repository. Lower case letters and numbers, may not start with&lt;br /&gt;
a number. examples: &amp;quot;lemurprints&amp;quot; or &amp;quot;test3&amp;quot;&lt;br /&gt;
&lt;br /&gt;
Archive ID? testrepo  &lt;br /&gt;
We need to create /usr/share/eprints/archives/testrepo, doing it now…&lt;br /&gt;
&lt;br /&gt;
Creating initial files:&lt;br /&gt;
Installing: /usr/share/eprints/archives/testrepo/cfg&lt;br /&gt;
Installing: /usr/share/eprints/archives/testrepo/cfg/lang&lt;br /&gt;
[...]&lt;br /&gt;
Installing: /usr/share/eprints/archives/testrepo/cfg/workflows/eprint&lt;br /&gt;
&lt;br /&gt;
Ok. I&#039;ve created the initial config files and directory structure. &lt;br /&gt;
I&#039;ve also created a &amp;quot;disk0&amp;quot; directory under documents/ if you want&lt;br /&gt;
your full texts to be stored on a different partition then remove &lt;br /&gt;
the disk0, and create a symbolic link to the directory you wish to&lt;br /&gt;
store the full texts in. Additional links may be placed here to be&lt;br /&gt;
used when the first is full.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Configure vital settings? [yes] ? &lt;br /&gt;
Core configuration for testrepo&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Please enter the fully qualified hostname of the repository. &lt;br /&gt;
&lt;br /&gt;
For a production system we recommend against using the real hostname of the &lt;br /&gt;
machine. &lt;br /&gt;
&lt;br /&gt;
Example: testrepo.footle.ac.uk&lt;br /&gt;
&lt;br /&gt;
Hostname? testprint&lt;br /&gt;
&lt;br /&gt;
Please enter the port of the webserver. This is probably 80, but you may wish &lt;br /&gt;
to run apache on a different port if you are experimenting.&lt;br /&gt;
&lt;br /&gt;
Webserver Port [80] ? &lt;br /&gt;
&lt;br /&gt;
Please enter all the aliases which could reach the repository, and indicate if &lt;br /&gt;
you would like EPrints to write a Redirect Rule to redirect requests to this&lt;br /&gt;
alias to the correct URL.&lt;br /&gt;
Some suggestions:&lt;br /&gt;
centos610.local&lt;br /&gt;
centos610&lt;br /&gt;
centos610&lt;br /&gt;
&lt;br /&gt;
Enter a single hash (#) when you&#039;re done.&lt;br /&gt;
&lt;br /&gt;
Alias (enter # when done) [#] ? testprint.local&lt;br /&gt;
Redirect testprint.local to testprint [yes] ? &lt;br /&gt;
&lt;br /&gt;
Alias (enter # when done) [#] ? &lt;br /&gt;
&lt;br /&gt;
Please enter the path part of the repository&#039;s base URL. This should probably&lt;br /&gt;
be &#039;/&#039;.&lt;br /&gt;
&lt;br /&gt;
Path [/] ? &lt;br /&gt;
&lt;br /&gt;
If you will use https for your user pages (including login) enter the https hostname&lt;br /&gt;
here, or leave blank when using http only.&lt;br /&gt;
&lt;br /&gt;
HTTPS Hostname [] ? &lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Administrator Email? someone@example.com&lt;br /&gt;
&lt;br /&gt;
Enter the name of the repository in the default language. If you wish to enter &lt;br /&gt;
other titles for other languages or enter non ascii characters then you may&lt;br /&gt;
enter something as a placeholder and edit the XML config file which this&lt;br /&gt;
script generates.&lt;br /&gt;
&lt;br /&gt;
Archive Name [Test Repository] ? &lt;br /&gt;
&lt;br /&gt;
Write these core settings? [yes] ? &lt;br /&gt;
Wrote /usr/share/eprints/archives/testrepo/cfg/cfg.d/adminemail.pl&lt;br /&gt;
Wrote /usr/share/eprints/archives/testrepo/cfg/cfg.d/10_core.pl&lt;br /&gt;
Wrote /usr/share/eprints/archives/testrepo/cfg/lang/en/phrases/archive_name.xml&lt;br /&gt;
&lt;br /&gt;
Configure database? [yes] ? &lt;br /&gt;
&lt;br /&gt;
Configuring Database for: testrepo&lt;br /&gt;
Database Name [testrepo] ? &lt;br /&gt;
MySQL Host [localhost] ? &lt;br /&gt;
&lt;br /&gt;
You probably don&#039;t need to set socket and port (unless you do!?).&lt;br /&gt;
MySQL Port (# for no setting) [#] ? &lt;br /&gt;
MySQL Socket (# for no setting) [#] ? &lt;br /&gt;
Database User [testrepo] ? &lt;br /&gt;
Database Password [nxxxxuAw] ? &lt;br /&gt;
Database Engine [MyISAM] ? &lt;br /&gt;
&lt;br /&gt;
Write these database settings? [yes] ?  &lt;br /&gt;
Wrote /usr/share/eprints/archives/testrepo/cfg/cfg.d/database.pl&lt;br /&gt;
&lt;br /&gt;
EPrints can create the database, and grant the correct permissions.&lt;br /&gt;
&lt;br /&gt;
Create database &amp;quot;testrepo&amp;quot; [yes] ? &lt;br /&gt;
Database Superuser Username [root] ? &lt;br /&gt;
Database Superuser Password? &lt;br /&gt;
Create database tables? [yes] ? &lt;br /&gt;
Creating database tables...&lt;br /&gt;
Set DB compatibility flag to &#039;3.3.4&#039;.&lt;br /&gt;
Done creating database tables.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Create an initial user? [yes] ? &lt;br /&gt;
Creating a new user in testrepo&lt;br /&gt;
&lt;br /&gt;
Enter a username [admin] ?&lt;br /&gt;
Select a user type (user|editor|admin) [admin] ?    &lt;br /&gt;
Enter Password? &lt;br /&gt;
Email? first.last@example.org&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Successfully created new user:&lt;br /&gt;
       ID: 1&lt;br /&gt;
Do you want to build the static web pages? [yes] ? &lt;br /&gt;
&lt;br /&gt;
Starting EPrints Repository.&lt;br /&gt;
Connecting to DB ... done.&lt;br /&gt;
mkdir /usr/share/eprints/archives/testrepo/html/en/codemirror/mode/velocity&lt;br /&gt;
/usr/share/eprints/lib/static/codemirror/mode/velocity/velocity.js -&amp;gt; /usr/share/eprints/archives/testrepo/html/en/codemirror/mode/velocity/velocity.js&lt;br /&gt;
mkdir /usr/share/eprints/archives/testrepo/html/en/style/images&lt;br /&gt;
/usr/share/eprints/lib/static/style/images/action_edit.png -&amp;gt; /usr/share/eprints/archives/testrepo/html/en/style/images/action_edit.png&lt;br /&gt;
[...]&lt;br /&gt;
/usr/share/eprints/lib/static/style/images/action_unpack.png -&amp;gt; /usr/share/eprints/archives/testrepo/html/en/style/images/action_unpack.png&lt;br /&gt;
/usr/share/eprints/lib/static/codemirror/lib/util/loadmode.js -&amp;gt; /usr/share/eprints/archives/testrepo/html/en/codemirror/lib/util/loadmode.js&lt;br /&gt;
Ending EPrints Repository.&lt;br /&gt;
&lt;br /&gt;
Do you want to import the LOC subjects? [yes] ? &lt;br /&gt;
&lt;br /&gt;
Starting EPrints Repository.&lt;br /&gt;
Connecting to DB ... done.&lt;br /&gt;
Importing from /usr/share/eprints/archives/testrepo/cfg/subjects...&lt;br /&gt;
Done importing 280 subjects from /usr/share/eprints/archives/testrepo/cfg/subjects&lt;br /&gt;
Reindexing subject dataset to set ancestor data&lt;br /&gt;
Reindexing item: subject/A&lt;br /&gt;
Reindexing item: subject/AC&lt;br /&gt;
Reindexing item: subject/AI&lt;br /&gt;
Reindexing item: subject/AM&lt;br /&gt;
[...]&lt;br /&gt;
Reindexing item: subject/sch_soc&lt;br /&gt;
Reindexing item: subject/subjects&lt;br /&gt;
Done reindexing&lt;br /&gt;
Ending EPrints Repository.&lt;br /&gt;
&lt;br /&gt;
Exiting normally.&lt;br /&gt;
Do you want to update the apache config files? (you still need to add the&lt;br /&gt;
&#039;Include&#039; line) [yes] ? &lt;br /&gt;
Wrote /usr/share/eprints/cfg/apache/testrepo.conf&lt;br /&gt;
&lt;br /&gt;
You must restart apache for any changes to take effect!&lt;br /&gt;
&lt;br /&gt;
--------------------------------------------------------------------------&lt;br /&gt;
That seemed to more or less work...&lt;br /&gt;
--------------------------------------------------------------------------&lt;br /&gt;
&lt;br /&gt;
Now make any required changes to the cfg files. &lt;br /&gt;
&lt;br /&gt;
Note that changing the metadata configuration may require the database&lt;br /&gt;
tables to be regenerated. epadmin erase_data will regenerate the &lt;br /&gt;
eprints and documents tables only. erase_data will regenerate everything.&lt;br /&gt;
(nb. these also do erase the contents of the tables, and any uploaded &lt;br /&gt;
files).&lt;br /&gt;
&lt;br /&gt;
Make sure that your main apache config file contains the line:&lt;br /&gt;
&lt;br /&gt;
 Include /usr/share/eprints/cfg/apache.conf&lt;br /&gt;
&lt;br /&gt;
Then stop and start your webserver:&lt;br /&gt;
Often:&lt;br /&gt;
 /etc/rc.d/init.d/httpd stop&lt;br /&gt;
 /etc/rc.d/init.d/httpd start&lt;br /&gt;
(or maybe /usr/local/apache/bin/apachectl stop &amp;amp; start)&lt;br /&gt;
&lt;br /&gt;
And then try connecting to your repository.&lt;br /&gt;
--------------------------------------------------------------------------&lt;br /&gt;
&lt;br /&gt;
Don&#039;t forget to register your repository at http://roar.eprints.org/&lt;br /&gt;
&lt;br /&gt;
-bash-4.1$ &lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==New Configurations==&lt;br /&gt;
If you are setting up more than one archive which are related to each other, a &amp;quot;community&amp;quot;, you may wish to establish common subjects and metadata.&lt;br /&gt;
&lt;br /&gt;
Removing and adding types is easy. Removing and adding fields is a bit more work. All &amp;quot;screen&amp;quot; names of values are stored in the archives own &amp;quot;phrase file&amp;quot; which comes with phrases for the default config.&lt;br /&gt;
&lt;br /&gt;
If you create a good default configuration for a different purpose or language(s) (and would like to share it), please contact the eprints admin who may want to put it online as an example or even include it as an alternate default in a later version.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17567</id>
		<title>Installing an EPM</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17567"/>
		<updated>2026-10-13T13:50:43Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Howto]]&lt;br /&gt;
== Important ==&lt;br /&gt;
Broadly EPMs have been superseded by Ingredients and should be avoided. If you find you must install one, this guide aims to help.&lt;br /&gt;
&lt;br /&gt;
== Installing from GitHub repository ==&lt;br /&gt;
1. Clone from Github the Bazaar plugin repository (e.g. https://github.com/eprints/reports.git) to /opt/eprints3/lib/epm/ and fetch the required version.&lt;br /&gt;
 cd /opt/eprints3/lib/epm/&lt;br /&gt;
 git clone https://github.com/eprints/reports.git&lt;br /&gt;
 cd reports&lt;br /&gt;
 git checkout v3.2.1&lt;br /&gt;
&lt;br /&gt;
2. Run the /opt/eprints3/ingredients/bazaar/tools/epm command to link the library from /opt/eprints3/lib/epm/ in the appropriate locations under /opt/eprints3/lib/&lt;br /&gt;
 /opt/eprints3/ingredients/bazaar/tools/epm link_lib reports # EPrints 3.4.6+&lt;br /&gt;
&lt;br /&gt;
== Integration with the Archive ==&lt;br /&gt;
1. Enable the plugin using tools/epm&lt;br /&gt;
 /opt/eprints3/ingredients/bazaar/tools/epm enable &amp;lt;ARCHIVE_ID&amp;gt; &amp;lt;PLUGIN_ID&amp;gt;&lt;br /&gt;
&amp;lt;i&amp;gt;Note: &amp;lt;code&amp;gt;PLUGIN_ID&amp;lt;/code&amp;gt; in our example is &amp;lt;code&amp;gt;reports&amp;lt;/code&amp;gt;&amp;lt;/i&amp;gt;&lt;br /&gt;
&lt;br /&gt;
2. Where any warnings are produced compare the current and .epmnew version of a file and reconcile any differences.  Removing the .epmnew file when you are done.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Installing_Ingredients&amp;diff=17566</id>
		<title>Installing Ingredients</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Installing_Ingredients&amp;diff=17566"/>
		<updated>2026-10-13T13:49:57Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Howto]]&lt;br /&gt;
An &#039;&#039;&#039;Ingredient&#039;&#039;&#039; in EPrints is a modular package or extension (such as `image_tiles`) that adds specific functionality to an EPrints repository flavour. &lt;br /&gt;
&lt;br /&gt;
This guide explains how to install an ingredient by cloning its source repository and registering it in your flavour&#039;s inclusion configuration file.&lt;br /&gt;
&lt;br /&gt;
== Clone the Ingredient Repository ==&lt;br /&gt;
Navigate to your EPrints ingredients directory (`/opt/eprints3/ingredients/`) and clone the git repository. &lt;br /&gt;
&lt;br /&gt;
For example, to install the &#039;&#039;&#039;image_tiles&#039;&#039;&#039; ingredient:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;syntaxhighlight lang=&amp;quot;bash&amp;quot;&amp;gt;&lt;br /&gt;
cd /opt/eprints3/ingredients/&lt;br /&gt;
git clone https://github.com/eprints/image_tiles&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;Note: Ensure the resulting destination directory path matches `/opt/eprints3/ingredients/image_tiles`.&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Register the Ingredient in the Flavour Include File ==&lt;br /&gt;
To activate the ingredient, you must declare it in your flavour&#039;s `inc` configuration file located at:&lt;br /&gt;
&lt;br /&gt;
`/opt/eprints3/flavours/&amp;lt;flavour_name&amp;gt;_lib/inc`&lt;br /&gt;
&amp;lt;i&amp;gt;the most common flavour name is pub_lib&lt;br /&gt;
&lt;br /&gt;
# Open the `inc` file in a text editor (e.g., `nano` or `vim`):&lt;br /&gt;
#: &amp;lt;syntaxhighlight lang=&amp;quot;bash&amp;quot;&amp;gt;nano /opt/eprints3/flavours/&amp;lt;flavour_name&amp;gt;_lib/inc&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
# Add the ingredient path line above the site library inclusion line (typically `#site_lib` or `site_lib`):&lt;br /&gt;
#: &amp;lt;syntaxhighlight lang=&amp;quot;text&amp;quot;&amp;gt;&lt;br /&gt;
ingredients/image_tiles&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Configuration File Example ===&lt;br /&gt;
Your `inc` file structure should look similar to this:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;syntaxhighlight lang=&amp;quot;text&amp;quot;&amp;gt;&lt;br /&gt;
# Active ingredients&lt;br /&gt;
ingredients/image_tiles&lt;br /&gt;
&lt;br /&gt;
# Site core library&lt;br /&gt;
site_lib&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Step 3: Restart Apache ==&lt;br /&gt;
For EPrints to pick up the changes to the flavour configuration, restart the web server:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;syntaxhighlight lang=&amp;quot;bash&amp;quot;&amp;gt;&lt;br /&gt;
sudo systemctl restart apache2&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Installing_Ingredients&amp;diff=17565</id>
		<title>Installing Ingredients</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Installing_Ingredients&amp;diff=17565"/>
		<updated>2026-10-13T13:49:18Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Created page with &amp;quot;Category:Howto An &amp;#039;&amp;#039;&amp;#039;Ingredient&amp;#039;&amp;#039;&amp;#039; in EPrints is a modular package or extension (such as `image_tiles`) that adds specific functionality to an EPrints repository flavo...&amp;quot;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Howto]]&lt;br /&gt;
An &#039;&#039;&#039;Ingredient&#039;&#039;&#039; in [[EPrints]] is a modular package or extension (such as `image_tiles`) that adds specific functionality to an EPrints repository flavour. &lt;br /&gt;
&lt;br /&gt;
This guide explains how to install an ingredient by cloning its source repository and registering it in your flavour&#039;s inclusion configuration file.&lt;br /&gt;
&lt;br /&gt;
== Clone the Ingredient Repository ==&lt;br /&gt;
Navigate to your EPrints ingredients directory (`/opt/eprints3/ingredients/`) and clone the git repository. &lt;br /&gt;
&lt;br /&gt;
For example, to install the &#039;&#039;&#039;image_tiles&#039;&#039;&#039; ingredient:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;syntaxhighlight lang=&amp;quot;bash&amp;quot;&amp;gt;&lt;br /&gt;
cd /opt/eprints3/ingredients/&lt;br /&gt;
git clone https://github.com/eprints/image_tiles&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;Note: Ensure the resulting destination directory path matches `/opt/eprints3/ingredients/image_tiles`.&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Register the Ingredient in the Flavour Include File ==&lt;br /&gt;
To activate the ingredient, you must declare it in your flavour&#039;s `inc` configuration file located at:&lt;br /&gt;
&lt;br /&gt;
`/opt/eprints3/flavours/&amp;lt;flavour_name&amp;gt;_lib/inc`&lt;br /&gt;
&amp;lt;i&amp;gt;the most common flavour name is pub_lib&lt;br /&gt;
&lt;br /&gt;
# Open the `inc` file in a text editor (e.g., `nano` or `vim`):&lt;br /&gt;
#: &amp;lt;syntaxhighlight lang=&amp;quot;bash&amp;quot;&amp;gt;nano /opt/eprints3/flavours/&amp;lt;flavour_name&amp;gt;_lib/inc&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
# Add the ingredient path line above the site library inclusion line (typically `#site_lib` or `site_lib`):&lt;br /&gt;
#: &amp;lt;syntaxhighlight lang=&amp;quot;text&amp;quot;&amp;gt;&lt;br /&gt;
ingredients/image_tiles&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Configuration File Example ===&lt;br /&gt;
Your `inc` file structure should look similar to this:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;syntaxhighlight lang=&amp;quot;text&amp;quot;&amp;gt;&lt;br /&gt;
# Active ingredients&lt;br /&gt;
ingredients/image_tiles&lt;br /&gt;
&lt;br /&gt;
# Site core library&lt;br /&gt;
site_lib&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Step 3: Restart Apache ==&lt;br /&gt;
For EPrints to pick up the changes to the flavour configuration, restart the web server:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;syntaxhighlight lang=&amp;quot;bash&amp;quot;&amp;gt;&lt;br /&gt;
sudo systemctl restart apache2&lt;br /&gt;
&amp;lt;/syntaxhighlight&amp;gt;&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17564</id>
		<title>Upgrading</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17564"/>
		<updated>2026-10-13T13:05:07Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
{{manual}}&lt;br /&gt;
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, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
= General Advice =&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
= Upgrade Schedules =&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
= From GitHub release =&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== In-place Upgrade ==&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
== Clean Upgrade ==&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
= From a source tarball =&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.3_Versions&amp;diff=17563</id>
		<title>Upgrading between EPrints 3.3 Versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.3_Versions&amp;diff=17563"/>
		<updated>2026-10-13T13:04:53Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
== Upgrade between same series versions of EPrints ==&lt;br /&gt;
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,  &#039;&#039;&#039;[[Upgrading between EPrints 3.4 versions]]&#039;&#039;&#039; provides additional specific information about EPrints 3.4 series.&lt;br /&gt;
&lt;br /&gt;
=== From a Linux Package Manager ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
Once the package upgrade has completed make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives.  The package manager may only tell you need to run &#039;&#039;epadmin upgrade&#039;&#039; but &#039;&#039;epadmin update&#039;&#039; is also needed to ensure newly added fields to data objects are also incorporated.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
=== From GitHub ===&lt;br /&gt;
If you have installed with GitHub, the preferred method for production repositories, you can update to the latest version using the following commands, substituting &#039;&#039;y&#039;&#039; for the version you want and &#039;&#039;x&#039;&#039; for the 3 or 4 depending on whether you are upgrading between EPrints 3.3 or 3.4 series:&lt;br /&gt;
&lt;br /&gt;
 git fetch origin&lt;br /&gt;
 git merge tags/v3.x.y&lt;br /&gt;
&lt;br /&gt;
This should warn you if you have made any locally uncommitted changes.  You may need to use &#039;&#039;git stash&#039;&#039; to move these temporarily and reintegrate after updating from GitHub.&lt;br /&gt;
&lt;br /&gt;
Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives and then reload the webserver and EPrints indexer, e.g.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
 apachectl graceful&lt;br /&gt;
 /opt/eprints3/bin indexer restart&lt;br /&gt;
&lt;br /&gt;
=== From a Tarball ===&lt;br /&gt;
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&#039;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):&lt;br /&gt;
&lt;br /&gt;
==== Downloading and Unpacking 3.3 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf eprints-3.3.16.tar.gz&lt;br /&gt;
 mv eprints-3.3.16 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
==== Downloading and Unpacking 3.4 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6.tar.gz&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6-flavours.tar.gz&lt;br /&gt;
 mv eprints-3.4.6 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Installing and Configuring ====&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, stop Apache and EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/epindexer stop&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Move the archive(s) from your old EPrints to your new one, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3_new/archives/&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Copy SystemSettings.pm to your new EPrints as well as site-wide settings&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cp -p /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/&lt;br /&gt;
 cp -pR /opt/eprints3/cfg /opt/eprints3_new/cfg&lt;br /&gt;
 cp -pR /opt/eprints3/site_lib /opt/eprints3_new/site_lib&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm &lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, switch round the old and new versions of EPrints, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3_old&lt;br /&gt;
 mv /opt/eprints3_new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run epadmin test to check there are no configuration issues, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; to deploy any structural changes or addition of fields to the database, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Restart EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epindexer start&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, restart Apache.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl restart&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt;Don&#039;t forget to reinstall your Bazaar packages.&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.3 ==&lt;br /&gt;
Upgrading from older 3.1 and 3.2 versions of EPrints to 3.3 is somewhat more involved.  Please see the following guides:&lt;br /&gt;
* [[Upgrading from 3.1]]&lt;br /&gt;
* [[Upgrading from 3.2]]&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.4 ==&lt;br /&gt;
To upgrade to EPrints 3.4 you will need to already be running a version of EPrints 3.3.  Ideally at least 3.3.12, which has the following guide:&lt;br /&gt;
* [[Upgrading 3.3.12+ to 3.4]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17562</id>
		<title>Upgrading</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17562"/>
		<updated>2026-10-13T13:04:19Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* From a source tarball */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
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, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
= General Advice =&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
= Upgrade Schedules =&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
= From GitHub release =&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== In-place Upgrade ==&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
== Clean Upgrade ==&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
= From a source tarball =&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17561</id>
		<title>Upgrading</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17561"/>
		<updated>2026-10-13T13:04:06Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* From GitHub release */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
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, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
= General Advice =&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
= Upgrade Schedules =&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
= From GitHub release =&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
== In-place Upgrade ==&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
== Clean Upgrade ==&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
== From a source tarball ==&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17560</id>
		<title>Upgrading between EPrints 3.4 versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17560"/>
		<updated>2026-10-13T13:03:22Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Redirected page to Upgrading&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Upgrading]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17559</id>
		<title>Upgrading</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17559"/>
		<updated>2026-10-13T13:02:14Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
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, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
= General Advice =&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
= Upgrade Schedules =&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
== From GitHub release ==&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== In-place Upgrade ===&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
=== Clean Upgrade ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
== From a source tarball ==&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.3_Versions&amp;diff=17558</id>
		<title>Upgrading between EPrints 3.3 Versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.3_Versions&amp;diff=17558"/>
		<updated>2026-10-13T13:01:44Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
{{manual}}&lt;br /&gt;
== Upgrade between same series versions of EPrints ==&lt;br /&gt;
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,  &#039;&#039;&#039;[[Upgrading between EPrints 3.4 versions]]&#039;&#039;&#039; provides additional specific information about EPrints 3.4 series.&lt;br /&gt;
&lt;br /&gt;
=== From a Linux Package Manager ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
Once the package upgrade has completed make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives.  The package manager may only tell you need to run &#039;&#039;epadmin upgrade&#039;&#039; but &#039;&#039;epadmin update&#039;&#039; is also needed to ensure newly added fields to data objects are also incorporated.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
=== From GitHub ===&lt;br /&gt;
If you have installed with GitHub, the preferred method for production repositories, you can update to the latest version using the following commands, substituting &#039;&#039;y&#039;&#039; for the version you want and &#039;&#039;x&#039;&#039; for the 3 or 4 depending on whether you are upgrading between EPrints 3.3 or 3.4 series:&lt;br /&gt;
&lt;br /&gt;
 git fetch origin&lt;br /&gt;
 git merge tags/v3.x.y&lt;br /&gt;
&lt;br /&gt;
This should warn you if you have made any locally uncommitted changes.  You may need to use &#039;&#039;git stash&#039;&#039; to move these temporarily and reintegrate after updating from GitHub.&lt;br /&gt;
&lt;br /&gt;
Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives and then reload the webserver and EPrints indexer, e.g.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
 apachectl graceful&lt;br /&gt;
 /opt/eprints3/bin indexer restart&lt;br /&gt;
&lt;br /&gt;
=== From a Tarball ===&lt;br /&gt;
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&#039;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):&lt;br /&gt;
&lt;br /&gt;
==== Downloading and Unpacking 3.3 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf eprints-3.3.16.tar.gz&lt;br /&gt;
 mv eprints-3.3.16 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
==== Downloading and Unpacking 3.4 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6.tar.gz&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6-flavours.tar.gz&lt;br /&gt;
 mv eprints-3.4.6 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Installing and Configuring ====&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, stop Apache and EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/epindexer stop&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Move the archive(s) from your old EPrints to your new one, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3_new/archives/&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Copy SystemSettings.pm to your new EPrints as well as site-wide settings&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cp -p /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/&lt;br /&gt;
 cp -pR /opt/eprints3/cfg /opt/eprints3_new/cfg&lt;br /&gt;
 cp -pR /opt/eprints3/site_lib /opt/eprints3_new/site_lib&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm &lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, switch round the old and new versions of EPrints, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3_old&lt;br /&gt;
 mv /opt/eprints3_new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run epadmin test to check there are no configuration issues, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; to deploy any structural changes or addition of fields to the database, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Restart EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epindexer start&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, restart Apache.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl restart&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt;Don&#039;t forget to reinstall your Bazaar packages.&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.3 ==&lt;br /&gt;
Upgrading from older 3.1 and 3.2 versions of EPrints to 3.3 is somewhat more involved.  Please see the following guides:&lt;br /&gt;
* [[Upgrading from 3.1]]&lt;br /&gt;
* [[Upgrading from 3.2]]&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.4 ==&lt;br /&gt;
To upgrade to EPrints 3.4 you will need to already be running a version of EPrints 3.3.  Ideally at least 3.3.12, which has the following guide:&lt;br /&gt;
* [[Upgrading 3.3.12+ to 3.4]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.3_Versions&amp;diff=17557</id>
		<title>Upgrading between EPrints 3.3 Versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.3_Versions&amp;diff=17557"/>
		<updated>2026-10-13T13:01:32Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Created page with &amp;quot;Category:Upgrading {{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...&amp;quot;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
{{manual}}&lt;br /&gt;
== Upgrade between same series versions of EPrints ==&lt;br /&gt;
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,  &#039;&#039;&#039;[[Upgrading between EPrints 3.4 versions]]&#039;&#039;&#039; provides additional specific information about EPrints 3.4 series.&lt;br /&gt;
[[Upgrading between EPrints 3.3 Versions]]&lt;br /&gt;
&lt;br /&gt;
=== From a Linux Package Manager ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
Once the package upgrade has completed make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives.  The package manager may only tell you need to run &#039;&#039;epadmin upgrade&#039;&#039; but &#039;&#039;epadmin update&#039;&#039; is also needed to ensure newly added fields to data objects are also incorporated.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
=== From GitHub ===&lt;br /&gt;
If you have installed with GitHub, the preferred method for production repositories, you can update to the latest version using the following commands, substituting &#039;&#039;y&#039;&#039; for the version you want and &#039;&#039;x&#039;&#039; for the 3 or 4 depending on whether you are upgrading between EPrints 3.3 or 3.4 series:&lt;br /&gt;
&lt;br /&gt;
 git fetch origin&lt;br /&gt;
 git merge tags/v3.x.y&lt;br /&gt;
&lt;br /&gt;
This should warn you if you have made any locally uncommitted changes.  You may need to use &#039;&#039;git stash&#039;&#039; to move these temporarily and reintegrate after updating from GitHub.&lt;br /&gt;
&lt;br /&gt;
Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives and then reload the webserver and EPrints indexer, e.g.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
 apachectl graceful&lt;br /&gt;
 /opt/eprints3/bin indexer restart&lt;br /&gt;
&lt;br /&gt;
=== From a Tarball ===&lt;br /&gt;
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&#039;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):&lt;br /&gt;
&lt;br /&gt;
==== Downloading and Unpacking 3.3 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf eprints-3.3.16.tar.gz&lt;br /&gt;
 mv eprints-3.3.16 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
==== Downloading and Unpacking 3.4 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6.tar.gz&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6-flavours.tar.gz&lt;br /&gt;
 mv eprints-3.4.6 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Installing and Configuring ====&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, stop Apache and EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/epindexer stop&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Move the archive(s) from your old EPrints to your new one, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3_new/archives/&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Copy SystemSettings.pm to your new EPrints as well as site-wide settings&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cp -p /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/&lt;br /&gt;
 cp -pR /opt/eprints3/cfg /opt/eprints3_new/cfg&lt;br /&gt;
 cp -pR /opt/eprints3/site_lib /opt/eprints3_new/site_lib&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm &lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, switch round the old and new versions of EPrints, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3_old&lt;br /&gt;
 mv /opt/eprints3_new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run epadmin test to check there are no configuration issues, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; to deploy any structural changes or addition of fields to the database, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Restart EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epindexer start&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, restart Apache.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl restart&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt;Don&#039;t forget to reinstall your Bazaar packages.&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.3 ==&lt;br /&gt;
Upgrading from older 3.1 and 3.2 versions of EPrints to 3.3 is somewhat more involved.  Please see the following guides:&lt;br /&gt;
* [[Upgrading from 3.1]]&lt;br /&gt;
* [[Upgrading from 3.2]]&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.4 ==&lt;br /&gt;
To upgrade to EPrints 3.4 you will need to already be running a version of EPrints 3.3.  Ideally at least 3.3.12, which has the following guide:&lt;br /&gt;
* [[Upgrading 3.3.12+ to 3.4]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17556</id>
		<title>Installing an EPM</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17556"/>
		<updated>2026-10-13T12:59:53Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Integration with the Archive */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Important ==&lt;br /&gt;
Broadly EPMs have been superseded by Ingredients and should be avoided. If you find you must install one, this guide aims to help.&lt;br /&gt;
&lt;br /&gt;
== Installing from GitHub repository ==&lt;br /&gt;
1. Clone from Github the Bazaar plugin repository (e.g. https://github.com/eprints/reports.git) to /opt/eprints3/lib/epm/ and fetch the required version.&lt;br /&gt;
 cd /opt/eprints3/lib/epm/&lt;br /&gt;
 git clone https://github.com/eprints/reports.git&lt;br /&gt;
 cd reports&lt;br /&gt;
 git checkout v3.2.1&lt;br /&gt;
&lt;br /&gt;
2. Run the /opt/eprints3/ingredients/bazaar/tools/epm command to link the library from /opt/eprints3/lib/epm/ in the appropriate locations under /opt/eprints3/lib/&lt;br /&gt;
 /opt/eprints3/ingredients/bazaar/tools/epm link_lib reports # EPrints 3.4.6+&lt;br /&gt;
&lt;br /&gt;
== Integration with the Archive ==&lt;br /&gt;
1. Enable the plugin using tools/epm&lt;br /&gt;
 /opt/eprints3/ingredients/bazaar/tools/epm enable &amp;lt;ARCHIVE_ID&amp;gt; &amp;lt;PLUGIN_ID&amp;gt;&lt;br /&gt;
&amp;lt;i&amp;gt;Note: &amp;lt;code&amp;gt;PLUGIN_ID&amp;lt;/code&amp;gt; in our example is &amp;lt;code&amp;gt;reports&amp;lt;/code&amp;gt;&amp;lt;/i&amp;gt;&lt;br /&gt;
&lt;br /&gt;
2. Where any warnings are produced compare the current and .epmnew version of a file and reconcile any differences.  Removing the .epmnew file when you are done.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17555</id>
		<title>Installing an EPM</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17555"/>
		<updated>2026-10-13T12:59:35Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Important ==&lt;br /&gt;
Broadly EPMs have been superseded by Ingredients and should be avoided. If you find you must install one, this guide aims to help.&lt;br /&gt;
&lt;br /&gt;
== Installing from GitHub repository ==&lt;br /&gt;
1. Clone from Github the Bazaar plugin repository (e.g. https://github.com/eprints/reports.git) to /opt/eprints3/lib/epm/ and fetch the required version.&lt;br /&gt;
 cd /opt/eprints3/lib/epm/&lt;br /&gt;
 git clone https://github.com/eprints/reports.git&lt;br /&gt;
 cd reports&lt;br /&gt;
 git checkout v3.2.1&lt;br /&gt;
&lt;br /&gt;
2. Run the /opt/eprints3/ingredients/bazaar/tools/epm command to link the library from /opt/eprints3/lib/epm/ in the appropriate locations under /opt/eprints3/lib/&lt;br /&gt;
 /opt/eprints3/ingredients/bazaar/tools/epm link_lib reports # EPrints 3.4.6+&lt;br /&gt;
&lt;br /&gt;
== Integration with the Archive ==&lt;br /&gt;
1. Enable the plugin using tools/epm&lt;br /&gt;
 /opt/eprints3/ingredients/bazaar/tools/epm enable &amp;lt;ARCHIVE_ID&amp;gt; &amp;lt;PLUGIN_ID&amp;gt;&lt;br /&gt;
&amp;lt;i&amp;gt;&amp;lt;code&amp;gt;PLUGIN_ID&amp;lt;/code&amp;gt; in our example is &amp;lt;code&amp;gt;reports&amp;lt;/code&amp;gt;&amp;lt;/i&amp;gt;&lt;br /&gt;
&lt;br /&gt;
2. Where any warnings are produced compare the current and .epmnew version of a file and reconcile any differences.  Removing the .epmnew file when you are done.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17554</id>
		<title>Installing an EPM</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Installing_an_EPM&amp;diff=17554"/>
		<updated>2026-10-13T12:55:55Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: Created page with &amp;quot;== Important == Broadly EPMs have been superseded by Ingredients and should be avoided. If you find you must install one, this guide aims to help.  == Installing from GitHub r...&amp;quot;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Important ==&lt;br /&gt;
Broadly EPMs have been superseded by Ingredients and should be avoided. If you find you must install one, this guide aims to help.&lt;br /&gt;
&lt;br /&gt;
== Installing from GitHub repository ==&lt;br /&gt;
1. Clone from Github the Bazaar plugin repository (e.g. https://github.com/eprints/reports.git) to /opt/eprints3/lib/epm/ and fetch the required version.  (If you are installing a different version to what they have already installed you will need to take great care when &#039;&#039;&#039;Integration with the Archive&#039;&#039;&#039;).&lt;br /&gt;
 cd /opt/eprints3/lib/epm/&lt;br /&gt;
 git clone https://github.com/eprints/reports.git&lt;br /&gt;
 cd reports&lt;br /&gt;
 git checkout v3.2.1&lt;br /&gt;
&lt;br /&gt;
2. Run the /opt/eprints3/ingredients/bazaar/tools/epm command to link the library from /opt/eprints3/lib/epm/ in the appropriate locations under /opt/eprints3/lib/&lt;br /&gt;
 /opt/eprints3/ingredients/bazaar/tools/epm link_lib reports # EPrints 3.4.6+&lt;br /&gt;
 /opt/eprints3/site_lib/tools/epm link_lib reports # EPrints 3.4.5-&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17541</id>
		<title>Upgrading</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17541"/>
		<updated>2026-10-12T09:27:25Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Upgrade between same series versions of EPrints */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
{{manual}}&lt;br /&gt;
== Upgrade between same series versions of EPrints ==&lt;br /&gt;
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,  &#039;&#039;&#039;[[Upgrading between EPrints 3.4 versions]]&#039;&#039;&#039; provides additional specific information about EPrints 3.4 series.&lt;br /&gt;
[[Upgrading between EPrints 3.3 Versions]]&lt;br /&gt;
&lt;br /&gt;
=== From a Linux Package Manager ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
Once the package upgrade has completed make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives.  The package manager may only tell you need to run &#039;&#039;epadmin upgrade&#039;&#039; but &#039;&#039;epadmin update&#039;&#039; is also needed to ensure newly added fields to data objects are also incorporated.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
=== From GitHub ===&lt;br /&gt;
If you have installed with GitHub, the preferred method for production repositories, you can update to the latest version using the following commands, substituting &#039;&#039;y&#039;&#039; for the version you want and &#039;&#039;x&#039;&#039; for the 3 or 4 depending on whether you are upgrading between EPrints 3.3 or 3.4 series:&lt;br /&gt;
&lt;br /&gt;
 git fetch origin&lt;br /&gt;
 git merge tags/v3.x.y&lt;br /&gt;
&lt;br /&gt;
This should warn you if you have made any locally uncommitted changes.  You may need to use &#039;&#039;git stash&#039;&#039; to move these temporarily and reintegrate after updating from GitHub.&lt;br /&gt;
&lt;br /&gt;
Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives and then reload the webserver and EPrints indexer, e.g.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
 apachectl graceful&lt;br /&gt;
 /opt/eprints3/bin indexer restart&lt;br /&gt;
&lt;br /&gt;
=== From a Tarball ===&lt;br /&gt;
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&#039;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):&lt;br /&gt;
&lt;br /&gt;
==== Downloading and Unpacking 3.3 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf eprints-3.3.16.tar.gz&lt;br /&gt;
 mv eprints-3.3.16 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
==== Downloading and Unpacking 3.4 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6.tar.gz&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6-flavours.tar.gz&lt;br /&gt;
 mv eprints-3.4.6 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Installing and Configuring ====&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, stop Apache and EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/epindexer stop&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Move the archive(s) from your old EPrints to your new one, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3_new/archives/&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Copy SystemSettings.pm to your new EPrints as well as site-wide settings&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cp -p /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/&lt;br /&gt;
 cp -pR /opt/eprints3/cfg /opt/eprints3_new/cfg&lt;br /&gt;
 cp -pR /opt/eprints3/site_lib /opt/eprints3_new/site_lib&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm &lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, switch round the old and new versions of EPrints, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3_old&lt;br /&gt;
 mv /opt/eprints3_new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run epadmin test to check there are no configuration issues, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; to deploy any structural changes or addition of fields to the database, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Restart EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epindexer start&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, restart Apache.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl restart&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt;Don&#039;t forget to reinstall your Bazaar packages.&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.3 ==&lt;br /&gt;
Upgrading from older 3.1 and 3.2 versions of EPrints to 3.3 is somewhat more involved.  Please see the following guides:&lt;br /&gt;
* [[Upgrading from 3.1]]&lt;br /&gt;
* [[Upgrading from 3.2]]&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.4 ==&lt;br /&gt;
To upgrade to EPrints 3.4 you will need to already be running a version of EPrints 3.3.  Ideally at least 3.3.12, which has the following guide:&lt;br /&gt;
* [[Upgrading 3.3.12+ to 3.4]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17540</id>
		<title>Upgrading</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading&amp;diff=17540"/>
		<updated>2026-10-12T09:21:23Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Upgrading to EPrints to 3.3 */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
{{manual}}&lt;br /&gt;
== Upgrade between same series versions of EPrints ==&lt;br /&gt;
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,  &#039;&#039;&#039;[[Upgrading between EPrints 3.4 versions]]&#039;&#039;&#039; provides additional specific information about EPrints 3.4 series.&lt;br /&gt;
&lt;br /&gt;
=== From a Linux Package Manager ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
Once the package upgrade has completed make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives.  The package manager may only tell you need to run &#039;&#039;epadmin upgrade&#039;&#039; but &#039;&#039;epadmin update&#039;&#039; is also needed to ensure newly added fields to data objects are also incorporated.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
=== From GitHub ===&lt;br /&gt;
If you have installed with GitHub, the preferred method for production repositories, you can update to the latest version using the following commands, substituting &#039;&#039;y&#039;&#039; for the version you want and &#039;&#039;x&#039;&#039; for the 3 or 4 depending on whether you are upgrading between EPrints 3.3 or 3.4 series:&lt;br /&gt;
&lt;br /&gt;
 git fetch origin&lt;br /&gt;
 git merge tags/v3.x.y&lt;br /&gt;
&lt;br /&gt;
This should warn you if you have made any locally uncommitted changes.  You may need to use &#039;&#039;git stash&#039;&#039; to move these temporarily and reintegrate after updating from GitHub.&lt;br /&gt;
&lt;br /&gt;
Once updated to the intended tagged release version any resolved and local uncommitted changes then make sure to run both &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; on all archives and then reload the webserver and EPrints indexer, e.g.&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
 apachectl graceful&lt;br /&gt;
 /opt/eprints3/bin indexer restart&lt;br /&gt;
&lt;br /&gt;
=== From a Tarball ===&lt;br /&gt;
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&#039;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):&lt;br /&gt;
&lt;br /&gt;
==== Downloading and Unpacking 3.3 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the tarball from files.eprints.org, (e.g. https://files.eprints.org/2306/5/eprints-3.3.16.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf eprints-3.3.16.tar.gz&lt;br /&gt;
 mv eprints-3.3.16 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
==== Downloading and Unpacking 3.4 ====&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the main tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/5/eprints-3.4.6.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; Download the publications tarball from files.eprints.org, (e.g. https://files.eprints.org/3097/6/eprints-3.4.6-flavours.tar.gz)&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; 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&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cd /opt&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6.tar.gz&lt;br /&gt;
 tar -xzvf /home/eprints/eprints-3.4.6-flavours.tar.gz&lt;br /&gt;
 mv eprints-3.4.6 eprints3_new&lt;br /&gt;
 chown -R eprints:eprints /opt/eprints3_new&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==== Installing and Configuring ====&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;ol&amp;gt;&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, stop Apache and EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/epindexer stop&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Move the archive(s) from your old EPrints to your new one, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3_new/archives/&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Copy SystemSettings.pm to your new EPrints as well as site-wide settings&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 cp -p /opt/eprints3/perl_lib/EPrints/SystemSettings.pm /opt/eprints3_new/perl_lib/EPrints/&lt;br /&gt;
 cp -pR /opt/eprints3/cfg /opt/eprints3_new/cfg&lt;br /&gt;
 cp -pR /opt/eprints3/site_lib /opt/eprints3_new/site_lib&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; 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.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 diff /opt/eprints3/perl_lib/EPrints/MetaField/Date.pm /opt/eprints3_new/perl_lib/EPrints/MetaField/Date.pm &lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, switch round the old and new versions of EPrints, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3_old&lt;br /&gt;
 mv /opt/eprints3_new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run epadmin test to check there are no configuration issues, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Run &#039;&#039;epadmin upgrade&#039;&#039; and &#039;&#039;epadmin update&#039;&#039; to deploy any structural changes or addition of fields to the database, e.g.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
 /opt/eprints3/bin/epadmin update ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; Restart EPrints&#039; indexer.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 /opt/eprints3/bin/epindexer start&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt; As the root user, restart Apache.&amp;lt;/li&amp;gt;&lt;br /&gt;
&lt;br /&gt;
 apachectl restart&lt;br /&gt;
&lt;br /&gt;
&amp;lt;li&amp;gt;Don&#039;t forget to reinstall your Bazaar packages.&amp;lt;/li&amp;gt;&lt;br /&gt;
&amp;lt;/ol&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.3 ==&lt;br /&gt;
Upgrading from older 3.1 and 3.2 versions of EPrints to 3.3 is somewhat more involved.  Please see the following guides:&lt;br /&gt;
* [[Upgrading from 3.1]]&lt;br /&gt;
* [[Upgrading from 3.2]]&lt;br /&gt;
&lt;br /&gt;
== Upgrading to EPrints 3.4 ==&lt;br /&gt;
To upgrade to EPrints 3.4 you will need to already be running a version of EPrints 3.3.  Ideally at least 3.3.12, which has the following guide:&lt;br /&gt;
* [[Upgrading 3.3.12+ to 3.4]]&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17539</id>
		<title>Upgrading between EPrints 3.4 versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17539"/>
		<updated>2026-10-12T09:19:51Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
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, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
= General Advice =&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
= Upgrade Schedules =&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
== From GitHub release ==&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== In-place Upgrade ===&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
=== Clean Upgrade ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
== From a source tarball ==&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17538</id>
		<title>Upgrading between EPrints 3.4 versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17538"/>
		<updated>2026-10-12T09:18:23Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* Upgrade Schedules */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
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 source tarballs available on [https://files.eprints.org/ files.eprints.org] or upgrading tagged release from [https://github.com/eprints/eprints3.4/ EPrints 3.4 GitHub repository].  However, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
= General Advice =&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
= Upgrade Schedules =&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
== From GitHub release ==&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== In-place Upgrade ===&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
=== Clean Upgrade ===&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
== From a source tarball ==&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17537</id>
		<title>Upgrading between EPrints 3.4 versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17537"/>
		<updated>2026-10-12T09:17:15Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: /* General Advice */&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
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 source tarballs available on [https://files.eprints.org/ files.eprints.org] or upgrading tagged release from [https://github.com/eprints/eprints3.4/ EPrints 3.4 GitHub repository].  However, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
= General Advice =&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
== Upgrade Schedules ==&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
=== From GitHub release ===&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== From a source tarball ===&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;br /&gt;
&lt;br /&gt;
==== In-place Upgrade ====&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
==== Clean Upgrade ====&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17536</id>
		<title>Upgrading between EPrints 3.4 versions</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Upgrading_between_EPrints_3.4_versions&amp;diff=17536"/>
		<updated>2026-10-12T09:16:50Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category:Upgrading]]&lt;br /&gt;
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 source tarballs available on [https://files.eprints.org/ files.eprints.org] or upgrading tagged release from [https://github.com/eprints/eprints3.4/ EPrints 3.4 GitHub repository].  However, &#039;&#039;&#039;new versions of EPrints 3.4 will no longer be released as Linux packages&#039;&#039;&#039; (i.e. [http://rpm.eprints.org/eprints3.4 RPMs] or [http://deb.eprints.org/3.4 Debs]).&lt;br /&gt;
&lt;br /&gt;
== General Advice ==&lt;br /&gt;
If you are running EPrints as a virtual machine, then it is worthwhile taking a snapshot that you could revert back to this in the event of an unsuccessful upgrade. Otherwise, you should take the following backups before starting an upgrade:&lt;br /&gt;
; The EPrints database &lt;br /&gt;
: This will likely have the same name as the archive.&lt;br /&gt;
; The documents directory&lt;br /&gt;
: This is the &#039;&#039;documents&#039;&#039; directory, directly under the archive&#039;s directory (i.e. &#039;&#039;/opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/&#039;&#039;).&lt;br /&gt;
; The Xapian index&lt;br /&gt;
: This is in the &#039;&#039;var&#039;&#039; directory of the archive under the directory named or starting &#039;&#039;xapian&#039;&#039;.&lt;br /&gt;
; Your EPrints archive&lt;br /&gt;
: All the directories and any files in your archive, &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;documents&#039;&#039; (see above), &#039;&#039;html&#039;&#039; and &#039;&#039;var&#039;&#039; (&#039;&#039;&#039;except&#039;&#039;&#039; &#039;&#039;xapian&#039;&#039;, see above). If you have multiple archives be sure to backup each one.&lt;br /&gt;
; The current EPrints codebase&lt;br /&gt;
: In case any changes have been made to this.  These may be needed if you have to rollback an upgrade or also apply these changes if they are needed in the upgraded version of EPrints.  All directories in the EPrints path (e.g. /opt/eprints3/) should be backed up &#039;&#039;&#039;except&#039;&#039;&#039;: &#039;&#039;archives&#039;&#039; (see above), &#039;&#039;debian&#039;&#039;, &#039;&#039;license&#039;&#039;, &#039;&#039;pod&#039;&#039;, &#039;&#039;testdata&#039;&#039;, &#039;&#039;tests&#039;&#039;,&#039;&#039;tmp&#039;&#039; and &#039;&#039;var&#039;&#039;.  No files in the top level EPrints path directory need to be backed up.&lt;br /&gt;
&lt;br /&gt;
Again, if you have the ability to take a virtual machine snapshot of your EPrints repository, it is worth using this to produce a clone, (if you do not already have a test or pre-production server version of your EPrints repository).  This will allow you to check if you will have any snags either with the upgrade process or with the upgraded repository itself.  It should also allow you to refine your upgrade schedule for your live EPrints repository to reduce the amount of scheduled downtime required.&lt;br /&gt;
&lt;br /&gt;
== Upgrade Schedules ==&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
=== From GitHub release ===&lt;br /&gt;
&#039;&#039;&#039;N.B. These instructions are a work in progress.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Before staring check that no critical files have been modified in the core codebase.  &lt;br /&gt;
 cd /opt/eprints3/&lt;br /&gt;
 git status&lt;br /&gt;
The only file that should have been modified (assuming you are running a publications flavour of EPrints) is &#039;&#039;flavours/pub_lib/inc&#039;&#039;.  &lt;br /&gt;
&lt;br /&gt;
There may be various new directories/files under the &#039;&#039;lib&#039;&#039; and &#039;&#039;ingredients&#039;&#039; directories.  These will most likely have been created as a result of installing Bazaar plug-ins or EPrints ingredients.  You should make a note of these and check to see that they are present after the upgrade schedule has been completed.  &lt;br /&gt;
&lt;br /&gt;
If there are modified files (according to &#039;&#039;git status&#039;&#039;), you should similarly make a note of these and the changes made, so it can be checked if either these changes have already been applied in the upgraded versions of these files or that they need to be re-applied after upgrading.  &lt;br /&gt;
&lt;br /&gt;
If &#039;&#039;git status&#039;&#039; finds missing files, then similarly these should be checked to make sure they are not present after completing your upgrade and remove them if they still exist.  They were most likely removed to deliberately disable a piece of unwanted functionality.  Although generally it should be possible to disable this with configuration. &lt;br /&gt;
&lt;br /&gt;
If only the flavour&#039;s inc file is modified and the only other things &#039;&#039;git status&#039;&#039; shows are additional untracked files, then it is safe to do an &#039;&#039;&#039;In-place Upgrade&#039;&#039;&#039;.  Otherwise, you will want to do a &#039;&#039;&#039;Clean Upgrade&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
=== From a source tarball ===&lt;br /&gt;
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.&lt;br /&gt;
 tar -xzvf eprints-3.4.1.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.1-flavours.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3.tar.gz /home/eprints/&lt;br /&gt;
 tar -xzvf eprints-3.4.3-flavours.tar.gz /home/eprints/&lt;br /&gt;
&lt;br /&gt;
2. Compare the code to see if any critical changes have been made to the core codebase:&lt;br /&gt;
 diff -x archives -x cfg -x tmp -rq /opt/eprints3 /home/eprints/eprints-3.4.1 | grep -v &amp;quot;/\(ingredients\|var\)&amp;quot;&lt;br /&gt;
Depending on your level of customization you should also pay attention to the results of&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/defaultcfg/ /home/eprints/eprints3.4.1/flavours/pub_lib/defaultcfg/&lt;br /&gt;
or the equivalent command for the other flavours, or for a Zero EPrints repository&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/defaultcfg_zero /home/eprints/eprints3.4.1/lib/defaultcfg_zero&lt;br /&gt;
and even&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/flavours/pub_lib/cfg.d/ /home/eprints/eprints3.4.1/flavours/pub_lib/cfg.d/&lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/cfg.d/ /home/eprints/eprints3.4.1/lib/cfg.d/ &lt;br /&gt;
 diff -rq /home/eprints/eprints3.4.3/lib/syscfg.d/ /home/eprints/eprints3.4.1/lib/syscfg.d/ &lt;br /&gt;
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 ...&lt;br /&gt;
Decide whether any personal version is still necessary, or meanwhile obsolete!&lt;br /&gt;
&lt;br /&gt;
3. If there are any changes check to see if the change is present in the new version of EPrints. E.g.:&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.1/flavours/pub_lib/inc&lt;br /&gt;
 diff /opt/eprints3/flavours/pub_lib/inc /home/eprints/eprints-3.4.3/flavours/pub_lib/inc&lt;br /&gt;
If the files in &amp;lt;Code&amp;gt;/opt/eprints3/&amp;lt;/Code&amp;gt; are the same as that in the latest version (e.g. &amp;lt;Code&amp;gt;/home/eprints-3.4.3/&amp;lt;/Code&amp;gt;) 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 &amp;lt;Code&amp;gt;/home/eprints/eprints-3.4.3/flavours/pub_lib/inc&amp;lt;/Code&amp;gt;). 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&#039;s local modifications to this file and modifications in the latest version of EPrints can be reconciled.&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Developer Tools&#039;&#039; tab.&lt;br /&gt;
&lt;br /&gt;
5. Stop the webserver and EPrints indexer on your repository server and check they have stopped running:&lt;br /&gt;
 systemctl stop httpd&lt;br /&gt;
 ps aux | grep httpd&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 ps aux | grep indexer&lt;br /&gt;
&#039;&#039;httpd&#039;&#039; is for RHEL-based Linux OS, for Debian-based Linux OS use &#039;&#039;apache2&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
6. As root, move the new version of EPrints (with any ported changes, from step 3) to &amp;lt;Code&amp;gt;/opt/eprints3-new&amp;lt;/code&amp;gt;&lt;br /&gt;
 mv /home/eprints-3.4.3 /opt/eprints3-new&lt;br /&gt;
&lt;br /&gt;
7. As the eprints user move the contents of the current archives into the new directory:&lt;br /&gt;
 mv /opt/eprints3/archives/* /opt/eprints3-new/archives/&lt;br /&gt;
If &amp;lt;Code&amp;gt;/opt/eprints3/archives&amp;lt;/Code&amp;gt; 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).&lt;br /&gt;
&lt;br /&gt;
8. As the eprints user copy across ingredients (&#039;&#039;&#039;except&#039;&#039;&#039; the bazaar and jquery ingredient) to the new version:&lt;br /&gt;
 rsync -a --exclude=bazaar --exclude=jquery /opt/eprints3/ingredients/ /opt/eprints3-new/ingredients/&lt;br /&gt;
&lt;br /&gt;
9. As root, switch round the old and new eprints directories:&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3-old&lt;br /&gt;
 mv /opt/eprints3-new /opt/eprints3&lt;br /&gt;
&lt;br /&gt;
10. As the eprints user, test EPrints is in a good state:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
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.&lt;br /&gt;
 cd /opt/eprints3/archives/&amp;lt;ARCHIVE_NAME&amp;gt;/cfg/cfg.d/&lt;br /&gt;
 rm ../epm/*&lt;br /&gt;
 mv z_orcid_support.pl z_orcid_support.pl.disabled&lt;br /&gt;
 mv zz_hefce_oa_fields.pl zz_hefce_oa_fields.pl.disabled&lt;br /&gt;
 mv zz_rioxx2.pl zz_rioxx2.pl.disabled&lt;br /&gt;
 mv z_meprints.pl z_meprints.pl.disabled &lt;br /&gt;
 mv kultur.pl kultur.pl.disabled&lt;br /&gt;
&lt;br /&gt;
11. Assuming EPrints is (now) in a good state, regenerate EPrints&#039; Apache configuration:&lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
12. As root, check the Apache configuration is sound and restart the webserver:&lt;br /&gt;
 apachectl configtest&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
For Debian-based LinuxOS use:&lt;br /&gt;
 apache2ctl configtest&lt;br /&gt;
 systemctl start apache2&lt;br /&gt;
&lt;br /&gt;
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 &#039;&#039;Available&#039;&#039; tab and using the &#039;&#039;Upload and Install&#039;&#039; 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 &#039;&#039;epadmin&#039;&#039; to re-test and restart the webserver:&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
 systemctl start httpd&lt;br /&gt;
&lt;br /&gt;
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).&lt;br /&gt;
&lt;br /&gt;
13. Finally, as the eprints user, restart the indexer.&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
It is advised that you keep the &amp;lt;Code&amp;gt;/opt/eprints3-old&amp;lt;/Code&amp;gt; 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.&lt;br /&gt;
&lt;br /&gt;
==== In-place Upgrade ====&lt;br /&gt;
All steps should be done as the eprints users, although some commands may prompt for a root password.&lt;br /&gt;
&lt;br /&gt;
1. Stop the webserver and EPrints indexer.&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
&lt;br /&gt;
2. Make a copy of the flavour&#039;s inc file:&lt;br /&gt;
 cp /opt/eprints3/flavours/FLAVOUR_lib/inc /home/eprints/inc.backup&lt;br /&gt;
&lt;br /&gt;
3. Get the latest code version. This can be done with the following commands (substituting X for the latest version):&lt;br /&gt;
 git fetch&lt;br /&gt;
 git checkout v3.4.X  &lt;br /&gt;
&lt;br /&gt;
4. Check if the flavour&#039;s inc file has been reverted, if it is move back the backup to re-update it&lt;br /&gt;
 mv /home/eprints/inc.backup /opt/eprints3/flavours/FLAVOUR_lib/inc&lt;br /&gt;
&lt;br /&gt;
5. Test the new configuration and fix ans issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
6. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
7. Regenerate the EPrints Apache configuration, just in case there have been any improvements to this in the new version: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
8. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;br /&gt;
&lt;br /&gt;
==== Clean Upgrade ====&lt;br /&gt;
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.&lt;br /&gt;
&lt;br /&gt;
1. Create a new directory for latest version of eprints (substituting X for the latest version):&lt;br /&gt;
 mkdir /opt/eprints3.4.X&lt;br /&gt;
 chmod 2775 /opt/eprints3.4.X&lt;br /&gt;
 chown eprints:eprints /opt/eprints3.4.X&lt;br /&gt;
&lt;br /&gt;
2. Clone the latest released version of EPrints 3.4 (again substituting X for the latest version):&lt;br /&gt;
 git clone https://github.com/eprints/eprints3.4 /opt/eprints3.4.X&lt;br /&gt;
 cd /opt/eprints3.4.X&lt;br /&gt;
 git checkout v3.4.X&lt;br /&gt;
&lt;br /&gt;
3a. If you are not using the &#039;&#039;flavours/pub_lib&#039;&#039; copy the flavour library across (substituting &#039;&#039;FLAVOUR_LIB&#039;&#039; and &#039;&#039;X&#039;&#039; as appropriate): &lt;br /&gt;
 cp -rf /opt/eprints3/flavours/FLAVOUR_LIB/ /opt/eprints3.4.X/flavours/&lt;br /&gt;
&lt;br /&gt;
3b. If you are using &#039;&#039;flavours/pub_lib&#039;&#039; just copy over the &#039;&#039;inc&#039;&#039; file to the newly checked out &#039;&#039;pub_lib&#039;&#039; (again substituting &#039;&#039;X&#039;&#039; as appropriate):&lt;br /&gt;
 cp /opt/eprints3/flavours/pub_lib/inc /opt/eprints3.4.X/flavours/pub_lib/&lt;br /&gt;
&lt;br /&gt;
4. Review any modified tracked files by comparing these with the new version of the file in /opt/eprints3.4.X/.  If the change is present in the new version then this change can be ignored, if it is not you may need to figure out how to incorporate this change into the new version of EPrints.&lt;br /&gt;
&lt;br /&gt;
5. Copy across any additional untracked files from &amp;lt;code&amp;gt;/opt/eprints3/&amp;lt;/code&amp;gt; to &amp;lt;code&amp;gt;/opt/eprints3.4.X/&amp;lt;/code&amp;gt;.  These will likely be either ingredients or separate files installed as part of a Bazaar plug-in.&lt;br /&gt;
&lt;br /&gt;
6. Stop the EPrints indexer and webserver:&lt;br /&gt;
 /opt/eprints3/bin/indexer stop&lt;br /&gt;
 apachectl graceful-stop&lt;br /&gt;
&lt;br /&gt;
7. Move around the old and new eprints directories and then move the archive directory across to the newly created archives sub-directory (substituting &#039;&#039;X&#039;&#039; and &#039;&#039;ARCHIVEID&#039;&#039; as appropriate):&lt;br /&gt;
 mv /opt/eprints3 /opt/eprints3.old&lt;br /&gt;
 mv /opt/eprints3.4.X /opt/eprints3&lt;br /&gt;
 mv /opt/eprints3.old/archives/ARCHIVEID /opt/eprints3/archives/&lt;br /&gt;
&lt;br /&gt;
8. Test the new configuration and fix any issues reported.&lt;br /&gt;
 /opt/eprints3/bin/epadmin test&lt;br /&gt;
&lt;br /&gt;
9. Update the database schema for any changes between versions&lt;br /&gt;
 /opt/eprints3/bin/epadmin upgrade ARCHIVEID&lt;br /&gt;
&lt;br /&gt;
10. Regenerate the EPrints Apache configuration: &lt;br /&gt;
 /opt/eprints3/bin/generate_apacheconf --system --replace&lt;br /&gt;
&lt;br /&gt;
11. Start the webserver and EPrints Indexer&lt;br /&gt;
 apachectl start&lt;br /&gt;
 /opt/eprints3/bin/indexer start&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Category:Installation&amp;diff=17535</id>
		<title>Category:Installation</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Category:Installation&amp;diff=17535"/>
		<updated>2026-10-12T09:09:04Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Default Install ==&lt;br /&gt;
The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;The EPrints team currently recommends installing EPrints in the following way:&#039;&#039;&#039;&lt;br /&gt;
* &#039;&#039;&#039;[[Installing EPrints on_RHEL/Fedora/CentOS]]&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Alternative Installs ==&lt;br /&gt;
You may need to intall EPrints in a different environment:&lt;br /&gt;
* &#039;&#039;&#039;[[Installing EPrints on Debian/Ubuntu]]&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Some people have gone a step further and installed EPrints in other ways:&lt;br /&gt;
* &#039;&#039;&#039;[[Generic_Linux_Installation|Installing from source]]&#039;&#039;&#039;&lt;br /&gt;
* [[non-root_proxy|Proxied to a non-root user account]]: Where the server and all associated code is installed without root/admin access to anything&lt;br /&gt;
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server&lt;br /&gt;
&lt;br /&gt;
== This category ==&lt;br /&gt;
This category contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}&lt;br /&gt;
&lt;br /&gt;
If you want to write installation instructions for a system other than those listed here please do so. Remember to tag the page with &amp;lt;nowiki&amp;gt;[[Category:Installation]]&amp;lt;/nowiki&amp;gt; so that it appears in this list. &lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;If you use one of the installation guides below and it doesn&#039;t work, edit the page to say what went wrong and how you fixed it. This will help others (and maybe yourself) tackle these problems in the future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Distribution Notes ==&lt;br /&gt;
&lt;br /&gt;
Known issues and gotchas on various Linux distributions&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Distibution&lt;br /&gt;
! Support&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 8&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 8]].&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 9&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 9]]. EPrints Services test builds against this release.&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 10&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 10]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 22.04 LTS&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 22.04]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 24.04 LTS&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 24.04]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 26.04 LTS&lt;br /&gt;
| Under testing&lt;br /&gt;
| Any issues will be reported at [[Issues with Installing EPrints on Ubuntu 26.04]].&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Category:Installation&amp;diff=17534</id>
		<title>Category:Installation</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Category:Installation&amp;diff=17534"/>
		<updated>2026-10-12T09:08:23Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;- Default Install -&lt;br /&gt;
The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;The EPrints team currently recommends installing EPrints in the following way:&#039;&#039;&#039;&lt;br /&gt;
* &#039;&#039;&#039;[[Installing EPrints on_RHEL/Fedora/CentOS]]&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
- Alternative Installs -&lt;br /&gt;
You may need to intall EPrints in a different environment:&lt;br /&gt;
* &#039;&#039;&#039;[[Installing EPrints on Debian/Ubuntu]]&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Some people have gone a step further and installed EPrints in other ways:&lt;br /&gt;
* &#039;&#039;&#039;[[Generic_Linux_Installation|Installing from source]]&#039;&#039;&#039;&lt;br /&gt;
* [[non-root_proxy|Proxied to a non-root user account]]: Where the server and all associated code is installed without root/admin access to anything&lt;br /&gt;
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server&lt;br /&gt;
&lt;br /&gt;
- This category -&lt;br /&gt;
This category contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}&lt;br /&gt;
&lt;br /&gt;
If you want to write installation instructions for a system other than those listed here please do so. Remember to tag the page with &amp;lt;nowiki&amp;gt;[[Category:Installation]]&amp;lt;/nowiki&amp;gt; so that it appears in this list. &lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;If you use one of the installation guides below and it doesn&#039;t work, edit the page to say what went wrong and how you fixed it. This will help others (and maybe yourself) tackle these problems in the future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Distribution Notes ==&lt;br /&gt;
&lt;br /&gt;
Known issues and gotchas on various Linux distributions&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Distibution&lt;br /&gt;
! Support&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 8&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 8]].&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 9&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 9]]. EPrints Services test builds against this release.&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 10&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 10]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 22.04 LTS&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 22.04]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 24.04 LTS&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 24.04]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 26.04 LTS&lt;br /&gt;
| Under testing&lt;br /&gt;
| Any issues will be reported at [[Issues with Installing EPrints on Ubuntu 26.04]].&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
	<entry>
		<id>https://wiki.eprints.org/w/index.php?title=Category:Installation&amp;diff=17533</id>
		<title>Category:Installation</title>
		<link rel="alternate" type="text/html" href="https://wiki.eprints.org/w/index.php?title=Category:Installation&amp;diff=17533"/>
		<updated>2026-10-12T09:07:00Z</updated>

		<summary type="html">&lt;p&gt;Ap1e26: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;The EPrints team currently recommends installing EPrints in the following way:&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
* &#039;&#039;&#039;[[Installing EPrints on_RHEL/Fedora/CentOS]]&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
You may need to intall EPrints in a different environment:&lt;br /&gt;
* &#039;&#039;&#039;[[Installing EPrints on Debian/Ubuntu]]&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Some people have gone a step further and installed EPrints in other ways:&lt;br /&gt;
* &#039;&#039;&#039;[[Generic_Linux_Installation|Installing from source]]&#039;&#039;&#039;&lt;br /&gt;
* [[non-root_proxy|Proxied to a non-root user account]]: Where the server and all associated code is installed without root/admin access to anything&lt;br /&gt;
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server&lt;br /&gt;
&lt;br /&gt;
This category contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}&lt;br /&gt;
&lt;br /&gt;
If you want to write installation instructions for a system other than those listed here please do so. Remember to tag the page with &amp;lt;nowiki&amp;gt;[[Category:Installation]]&amp;lt;/nowiki&amp;gt; so that it appears in this list. &lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;If you use one of the installation guides below and it doesn&#039;t work, edit the page to say what went wrong and how you fixed it. This will help others (and maybe yourself) tackle these problems in the future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
== Distribution Notes ==&lt;br /&gt;
&lt;br /&gt;
Known issues and gotchas on various Linux distributions&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Distibution&lt;br /&gt;
! Support&lt;br /&gt;
! Notes&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 8&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 8]].&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 9&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 9]]. EPrints Services test builds against this release.&lt;br /&gt;
|-&lt;br /&gt;
| RHEL / Centos / Rocky 10&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 10]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 22.04 LTS&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 22.04]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 24.04 LTS&lt;br /&gt;
| Supported&lt;br /&gt;
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 24.04]].&lt;br /&gt;
|-&lt;br /&gt;
| Ubuntu 26.04 LTS&lt;br /&gt;
| Under testing&lt;br /&gt;
| Any issues will be reported at [[Issues with Installing EPrints on Ubuntu 26.04]].&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Ap1e26</name></author>
	</entry>
</feed>