https://wiki.eprints.org/w/api.php?action=feedcontributions&feedformat=atom&user=LukeWallinEPrints Documentation - User contributions [en-gb]2026-10-12T15:19:53ZUser contributionsMediaWiki 1.31.8https://wiki.eprints.org/w/index.php?title=Main_Page&diff=17553Main Page2026-10-12T13:30:25Z<p>LukeWallin: /* Getting Started */</p>
<hr />
<div>[[Category:Howto]]__NOTOC__<br />
= Welcome to the EPrints Wiki =<br />
<br />
This wiki contains technical and user-contributed documentation for the [[Introduction|EPrints repository software]].<br />
<br />
[http://tryme.demo.eprints-hosting.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first. There are also [http://pub.demo.eprints-hosting.org/ examples] of various 'flavours' of EPrints available to view as well as some more information on the [https://eprints.org/ EPrints project] and related activities.<br />
<br />
==New to EPrints?==<br />
<br />
Found out more through our:<br />
* [[EPrints Glossary]] - Descriptions of the terminology used within EPrints repository software.<br />
* [[:Category:Training Video|Video Training Course]] - Videos showing how to use, configure, maintain and develop EPrints repository software.<br />
* [[EPrints_Manual|Documentation]] - Written documentation for how to use, configure, maintain and develop EPrints repository software.<br />
* Mailing lists - There are two mail lists that you might like to join and where you can ask for help and share ideas:<br />
** '''[[eprints-tech Mailing List|The EPrints Technical Mailing List]]''' <br />
*** If you have technical questions, or a part of your EPrints installation is not working properly, this group has people who might be able to help!<br />
*** [[eprints-tech Mailing List|Click here]] for information about [[eprints-tech Mailing List#Subscription_Options|subscribing to this list]] or [[eprints-tech Mailing List#List_Archives|reading its archives]].<br />
** '''[https://groups.google.com/forum/#!forum/eprints-uk-user-group The EPrints User Group Google Group]'''<br />
*** This group is for anyone involved in using EPrints. Ask questions, share ideas, hear about forthcoming meetings.<br />
* How to [[Main_Page#Contributing_to_the_Wiki|contribute to the EPrints wiki]]<br />
* EPrints source code on GitHub:<br />
** Core and major plugins - https://github.com/eprints<br />
** Community code sharing - https://eprintsug.github.io and the repositories at https://github.com/eprintsug<br />
<br />
== Download EPrints ==<br />
<br />
{{Download}}<br />
<br />
==Installation==<br />
<br />
* [[:Category:Installation|Installing]] EPrints on various platforms<br />
<br />
==[[New_Repository | Getting Started]]==<br />
<br />
* [[EPrints Manual|EPrints 3 Documentation]]<br />
* [[Perl 101 for EPrints]]<br />
* [[Frequently Asked Questions]]<br />
* [[:Category:Howto|How to ...]]<br />
* [[:Category:Plugins|Plugins and Bazaar packages for EPrints]]<br />
* [[:Category:Training Video|EPrints Training Course]]<br />
* [[Abubis - Staying Online with AI Bots]]<br />
<br />
==Getting Support==<br />
<br />
* [https://www.eprints.org/eprints-services/ EPrints Services] - premium support, training and hosting from EPrints experts<br />
* [[Contact]] - mailing lists, bug reports etc.<br />
* [[User group meetings]] - regional meetings for users, which often have notes, presentations and information of general interest<br />
<br />
==Add-ons, patches and translations==<br />
* As of version 3.4 EPrints can be deployed in one of a number of [[EPrints Flavours|flavours]]. The flavours can be supplemented with [[EPrints Ingredients|ingredients]]. These ingredients are [https://github.com/search?q=topic%3Aingredient+org%3Aeprints+org%3Aeprintsug&type=repositories available from GitHub].<br />
* As of version 3.3 EPrints can now install plugins and translations through the [https://bazaar.eprints.org EPrints Bazaar] the wiki also has information about [[:Category:EPrints Bazaar|packaging plugins for the Bazaar]].<br />
* The [https://files.eprints.org/ EPrints Files Repository] contains add-on and 3rd party scripts, patches and translations. This also provides an archive of all previous EPrints releases (3.0 onwards).<br />
* [[:Category:Plugins|Plugins]]: Some Wiki pages about scripts and patches.<br />
<br />
{{Register}}<br />
<br />
==Contributing to EPrints==<br />
<br />
* [[Usability|EPrints usability]]<br />
* New features in EPrints - [[:Category:Releases|released]] and [[:Category:Planned Releases|proposed]]<br />
* [[How to contribute|How to contribute to EPrints development]]<br />
* [https://github.com/eprints/eprints3.4 EPrints 3.4 on GitHub] - Codebase, releases and issues tracker for EPrints 3.4.<br />
* [https://github.com/eprints/eprints3 EPrints 3.3 on GitHub] - Codebase, releases and issues tracker for EPrints 3.3 (legacy).<br />
<br />
== Content management ==<br />
<br />
* [[Digital preservation]]: managing content for longer-term access and use</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17551Abubis - Staying Online with AI Bots2026-10-12T13:30:05Z<p>LukeWallin: LukeWallin moved page Staying Online with AI Bots to Abubis - Staying Online with AI Bots</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===<br />
<br />
The ingredient [https://github.com/eprints/anubis "Anubis"] contains our solution with Anubis and Nginx. Its README will be the most up to date source of information, therefore this will only summarise.<br />
<br />
* EPrints is run on its own internal instance of Apache, because it is unstable in Apache's multithreaded mode, and the layers in front exacerbate the effects of a segfault.<br />
* Apache is used as the front webserver (listening on port 80/443) because this is currently the only way to support Shibboleth Single Sign On and SSL is already configured for Apache.<br />
* Nginx is used instead of Apache because it natively supports more open connections than Apache (originally it was intended to be the front facing webserver) and it has some very useful rate limiting and caching features.<br />
* In order to support not caching logged in users, the ingredient has some fixes for core EPrints code for setting and unsetting session cookies. Hopefully the next (3.4.9) release of EPrints will include these fixes.</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Staying_Online_with_AI_Bots&diff=17552Staying Online with AI Bots2026-10-12T13:30:05Z<p>LukeWallin: LukeWallin moved page Staying Online with AI Bots to Abubis - Staying Online with AI Bots</p>
<hr />
<div>#REDIRECT [[Abubis - Staying Online with AI Bots]]</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17550Abubis - Staying Online with AI Bots2026-10-12T13:19:43Z<p>LukeWallin: /* Our Solution */</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===<br />
<br />
The ingredient [https://github.com/eprints/anubis "Anubis"] contains our solution with Anubis and Nginx. Its README will be the most up to date source of information, therefore this will only summarise.<br />
<br />
* EPrints is run on its own internal instance of Apache, because it is unstable in Apache's multithreaded mode, and the layers in front exacerbate the effects of a segfault.<br />
* Apache is used as the front webserver (listening on port 80/443) because this is currently the only way to support Shibboleth Single Sign On and SSL is already configured for Apache.<br />
* Nginx is used instead of Apache because it natively supports more open connections than Apache (originally it was intended to be the front facing webserver) and it has some very useful rate limiting and caching features.<br />
* In order to support not caching logged in users, the ingredient has some fixes for core EPrints code for setting and unsetting session cookies. Hopefully the next (3.4.9) release of EPrints will include these fixes.</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17549Abubis - Staying Online with AI Bots2026-10-12T13:17:05Z<p>LukeWallin: /* Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. */</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===<br />
<br />
The ingredient [https://github.com/eprints/anubis "Anubis"] contains our solution with Anubis and Nginx. Its README will be the most up to date source of information, therefore this will only summarise.<br />
<br />
* EPrints is run on its own internal instance of Apache, because it is unstable in Apache's multithreaded mode, and the layers in front exacerbate the effects of a segfault.<br />
* Apache is used as the front webserver (listening on port 80/443) because this is currently the only way to support Shibboleth Single Sign On and SSL is already configured for Apache.</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17548Abubis - Staying Online with AI Bots2026-10-12T13:13:20Z<p>LukeWallin: /* Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. */</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===<br />
<br />
The ingredient [https://github.com/eprints/anubis "Anubis"] contains our solution with Anubis and Nginx. Its README will be the most up to date source of information, therefore this will only summarise.<br />
<br />
* EPrints is run on its own internal instance of Apache, because it is unstable in Apache's multithreaded mode.<br />
* Apache is used as the front webserver (listening on port 80/443) because SSL is</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17547Abubis - Staying Online with AI Bots2026-10-12T13:13:10Z<p>LukeWallin: /* Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. */</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===<br />
<br />
The ingredient [https://github.com/eprints/anubis "Anubis"] contains our solution with Anubis and Nginx. Its README will be the most up to date source of information, therefore this will only summarise.<br />
<br />
* EPrints is run on its own internal instance of Apache, because it is unstable in Apache's multithreaded mode.<br />
* Apache is used as the front webserver (listening on port 80/443) because SSL is</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17546Abubis - Staying Online with AI Bots2026-10-12T13:12:11Z<p>LukeWallin: /* Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. */</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===<br />
<br />
The ingredient [https://github.com/eprints/anubis "Anubis"] contains our solution with Anubis and Nginx. Its README will be the most up to date source of information, therefore this will only summarise.<br />
<br />
* EPrints is run on its own internal instance of Apache, because it is unstable in Apache's multithreaded mode.<br />
*</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17545Abubis - Staying Online with AI Bots2026-10-12T13:10:05Z<p>LukeWallin: /* Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. */</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===<br />
<br />
The ingredient [https://github.com/eprints/anubis "Anubis"] contains our solution with Anubis and Nginx. Its README will be the most up to date source of information</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17544Abubis - Staying Online with AI Bots2026-10-12T12:41:58Z<p>LukeWallin: </p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.<br />
<br />
EPrints Services have been working on a solution that uses Anubis to attempt filter out bots for specific pages, and nginx to add a cache and apply rate and connection limiting. Our solution is tailored to our hosting infrastructure, but should be relatively easy to adapt to a bespoke EPrints installation. This page documents how the solution works and how it is configured.<br />
<br />
=== Our Solution ===</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Abubis_-_Staying_Online_with_AI_Bots&diff=17543Abubis - Staying Online with AI Bots2026-10-12T11:00:33Z<p>LukeWallin: Created page with "== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. == From 2025(ish) onwards, EPrints instances can struggle to..."</p>
<hr />
<div>== Hardening your EPrints instance so it can survive the onslaught of bizarre behaviour from (presumed) AI bots. ==<br />
<br />
From 2025(ish) onwards, EPrints instances can struggle to stay online from DDOS-like behaviour that is flung at it regularly.</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Main_Page&diff=17542Main Page2026-10-12T10:56:44Z<p>LukeWallin: /* Getting Started */</p>
<hr />
<div>[[Category:Howto]]__NOTOC__<br />
= Welcome to the EPrints Wiki =<br />
<br />
This wiki contains technical and user-contributed documentation for the [[Introduction|EPrints repository software]].<br />
<br />
[http://tryme.demo.eprints-hosting.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first. There are also [http://pub.demo.eprints-hosting.org/ examples] of various 'flavours' of EPrints available to view as well as some more information on the [https://eprints.org/ EPrints project] and related activities.<br />
<br />
==New to EPrints?==<br />
<br />
Found out more through our:<br />
* [[EPrints Glossary]] - Descriptions of the terminology used within EPrints repository software.<br />
* [[:Category:Training Video|Video Training Course]] - Videos showing how to use, configure, maintain and develop EPrints repository software.<br />
* [[EPrints_Manual|Documentation]] - Written documentation for how to use, configure, maintain and develop EPrints repository software.<br />
* Mailing lists - There are two mail lists that you might like to join and where you can ask for help and share ideas:<br />
** '''[[eprints-tech Mailing List|The EPrints Technical Mailing List]]''' <br />
*** If you have technical questions, or a part of your EPrints installation is not working properly, this group has people who might be able to help!<br />
*** [[eprints-tech Mailing List|Click here]] for information about [[eprints-tech Mailing List#Subscription_Options|subscribing to this list]] or [[eprints-tech Mailing List#List_Archives|reading its archives]].<br />
** '''[https://groups.google.com/forum/#!forum/eprints-uk-user-group The EPrints User Group Google Group]'''<br />
*** This group is for anyone involved in using EPrints. Ask questions, share ideas, hear about forthcoming meetings.<br />
* How to [[Main_Page#Contributing_to_the_Wiki|contribute to the EPrints wiki]]<br />
* EPrints source code on GitHub:<br />
** Core and major plugins - https://github.com/eprints<br />
** Community code sharing - https://eprintsug.github.io and the repositories at https://github.com/eprintsug<br />
<br />
== Download EPrints ==<br />
<br />
{{Download}}<br />
<br />
==Installation==<br />
<br />
* [[:Category:Installation|Installing]] EPrints on various platforms<br />
<br />
==[[New_Repository | Getting Started]]==<br />
<br />
* [[EPrints Manual|EPrints 3 Documentation]]<br />
* [[Perl 101 for EPrints]]<br />
* [[Frequently Asked Questions]]<br />
* [[:Category:Howto|How to ...]]<br />
* [[:Category:Plugins|Plugins and Bazaar packages for EPrints]]<br />
* [[:Category:Training Video|EPrints Training Course]]<br />
* [[Staying Online with AI Bots]]<br />
<br />
==Getting Support==<br />
<br />
* [https://www.eprints.org/eprints-services/ EPrints Services] - premium support, training and hosting from EPrints experts<br />
* [[Contact]] - mailing lists, bug reports etc.<br />
* [[User group meetings]] - regional meetings for users, which often have notes, presentations and information of general interest<br />
<br />
==Add-ons, patches and translations==<br />
* As of version 3.4 EPrints can be deployed in one of a number of [[EPrints Flavours|flavours]]. The flavours can be supplemented with [[EPrints Ingredients|ingredients]]. These ingredients are [https://github.com/search?q=topic%3Aingredient+org%3Aeprints+org%3Aeprintsug&type=repositories available from GitHub].<br />
* As of version 3.3 EPrints can now install plugins and translations through the [https://bazaar.eprints.org EPrints Bazaar] the wiki also has information about [[:Category:EPrints Bazaar|packaging plugins for the Bazaar]].<br />
* The [https://files.eprints.org/ EPrints Files Repository] contains add-on and 3rd party scripts, patches and translations. This also provides an archive of all previous EPrints releases (3.0 onwards).<br />
* [[:Category:Plugins|Plugins]]: Some Wiki pages about scripts and patches.<br />
<br />
{{Register}}<br />
<br />
==Contributing to EPrints==<br />
<br />
* [[Usability|EPrints usability]]<br />
* New features in EPrints - [[:Category:Releases|released]] and [[:Category:Planned Releases|proposed]]<br />
* [[How to contribute|How to contribute to EPrints development]]<br />
* [https://github.com/eprints/eprints3.4 EPrints 3.4 on GitHub] - Codebase, releases and issues tracker for EPrints 3.4.<br />
* [https://github.com/eprints/eprints3 EPrints 3.3 on GitHub] - Codebase, releases and issues tracker for EPrints 3.3 (legacy).<br />
<br />
== Content management ==<br />
<br />
* [[Digital preservation]]: managing content for longer-term access and use</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=How_to_add_monthly_downloads_to_abstract&diff=17170How to add monthly downloads to abstract2026-09-21T13:30:29Z<p>LukeWallin: </p>
<hr />
<div>[[Category:Howto]]<br />
<br />
create zz_irstats2.pl in archive<br />
<br />
# If you are embedding in abstract pages using a phrase set below to 1.<br />
$c->{irstats2}->{abstract_embed} = 1;<br />
<br />
<br />
then in abstract xml:<br />
<br />
<!-- Downloads for the past 3 years --><br />
<h3>Monthly Downloads for the past 3 years</h3><br />
<div id="downloadsmonthlygraph" class="irstats2_googlegraph"><br />
<script type="text/javascript"><br />
document.observe( "dom:loaded", function() {<br />
new EPJS_Stats_GoogleGraph( {<br />
'context': { 'datatype': 'downloads', 'range': '3y', 'set_name': 'eprint', 'set_value': '<epc:print expr="eprintid"/>' },<br />
'options': { 'graph_type': 'column', 'container_id': 'downloadsmonthlygraph', 'view': 'Google:Graph', 'show_average': '0', 'date_resolution': 'month' }<br />
} );<br />
});<br />
</script><br />
</div></div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=How_to_add_monthly_downloads_to_abstract&diff=17169How to add monthly downloads to abstract2026-09-21T13:28:35Z<p>LukeWallin: Created page with "create zz_irstats2.pl in archive # If you are embedding in abstract pages using a phrase set below to 1. $c->{irstats2}->{abstract_embed} = 1; then in abstract xml: <!--..."</p>
<hr />
<div>create zz_irstats2.pl in archive<br />
<br />
# If you are embedding in abstract pages using a phrase set below to 1.<br />
$c->{irstats2}->{abstract_embed} = 1;<br />
<br />
<br />
then in abstract xml:<br />
<br />
<!-- Downloads for the past 3 years --><br />
<h3>Monthly Downloads for the past 3 years</h3><br />
<div id="downloadsmonthlygraph" class="irstats2_googlegraph"><br />
<script type="text/javascript"><br />
document.observe( "dom:loaded", function() {<br />
new EPJS_Stats_GoogleGraph( {<br />
'context': { 'datatype': 'downloads', 'range': '3y', 'set_name': 'eprint', 'set_value': '<epc:print expr="eprintid"/>' },<br />
'options': { 'graph_type': 'column', 'container_id': 'downloadsmonthlygraph', 'view': 'Google:Graph', 'show_average': '0', 'date_resolution': 'month' }<br />
} );<br />
});<br />
</script><br />
</div></div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Installing_EPrints_on_RHEL/Fedora/CentOS&diff=17168Installing EPrints on RHEL/Fedora/CentOS2026-09-14T09:25:42Z<p>LukeWallin: /* Create initial directory with correct permissions */</p>
<hr />
<div>{{manual}}<br />
[[Category:Installation]]<br />
<br />
== Requirements ==<br />
* Red Hat Enterprise (RHEL) / CentOS / Rocky Linux 8 or 9. (EPrints can be installed on RHEL / CentOS / Rocky Linux 10 but there are currently a [[#RHEL / CentOS / Rocky 10|number of issues]], some which should be resolved in later version of these Linux OSs).<br />
<br />
== Prerequisites ==<br />
* Pre-install and enable the EPEL DNF repository.<br />
**: <code>dnf install epel-release</code><br />
* Pre-install and enable the CodeReady Builder DNF repository.<br />
** RHEL<br />
**: <code>subscription-manager repos --enable "codeready-builder-for-rhel-$(releasever)-$(arch)-rpms"</code><br />
** CentOS Stream / Rocky Linux 8<br />
**: <code>dnf config-manager --set-enabled powertools</code><br />
** CentOS Stream / Rocky Linux 9 and 10<br />
**: <code>dnf config-manager --set-enabled crb</code><br />
* Pre-install MySQL server and client and make sure the former is enabled and running.<br />
** RHEL / Fedora:<br />
**: <code>dnf install mysql-server mysql mysql-devel<br/>&nbsp;systemctl enable --now mysqld</code><br />
** CentOS / Rocky Linux:<br />
**: <code>dnf install mariadb-server mariadb mariadb-devel<br/>&nbsp;systemctl enable --now mariadb</code><br />
* From the MySQL command prompt, pre-configure an eprints user with password for MariaDB/MySQL, which can be used as the Database super user when creating the database for an archive. (Be sure to change the password from "changeme"):<br />
*: <code>CREATE USER 'eprints'@'localhost' IDENTIFIED by 'changeme';<br/>&nbsp;GRANT ALL PRIVILEGES ON *.* TO 'eprints'@'localhost' WITH GRANT OPTION;</code><br />
* As root, from a command prompt add the <tt>eprints</tt> user:<br />
*: <code>adduser eprints</code><br />
<br />
== Dependencies ==<br />
The following RPMs need to be installed using the dnf command:<br />
dnf install libxml2 libxslt httpd mod_perl perl-Apache-DBI perl-DBI perl-DBD-MySQL perl-IO-Socket-SSL \<br />
perl-Time-HiRes perl-CGI perl-Digest-MD5 perl-Digest-SHA perl-Digest-SHA1 perl-JSON perl-XML-LibXML \<br />
perl-XML-LibXSLT perl-XML-SAX perl-MIME-Lite perl-Text-Unidecode perl-JSON perl-Unicode-Collate \<br />
perl-LWP-Protocol-https perl-IO-String tetex-latex wget gzip tar ImageMagick poppler-utils \<br />
chkconfig unzip cpan python3-html2text expat-devel libxslt-devel<br />
<br />
'''N.B.''' If you are running RHEL / CentOS / Rocky Linux 10, '''perl-Apache-DBI''' is no longer available and will need to be installed with CPAN and '''python3-html2text''' will not be available until RHEL / CentOS / Rocky Linux 10.1. You should exclude these when running the dnf command above. (See [[#RHEL_.2F_CentOS_.2F_Rocky_10|Operating System Version Specific Requirements for RHEL / CentOS / Rocky Linux 10]] below for more details).<br />
<br />
== Installing EPrints 3.4.7 from Source ==<br />
'''Ideally you will install from source from [https://github.com/eprints/eprints3.4 EPrints Core Git repository], which includes the core codebase and the publications flavour. However, you may choose to download tarballs of the EPrints core codebase and publications flavour from files.eprints.org as an alternative means of installation.<br />
<br />
== Downloading and Deploying EPrints Source ==<br />
<br />
=== Create initial directory with correct permissions ===<br />
As root:<br />
mkdir /opt/eprints3<br />
chown eprints:eprints /opt/eprints3<br />
chmod 2775 /opt/eprints3<br />
<br />
=== Cloning from Git ===<br />
Clone the Git repository from GitHub to <tt>/opt/</tt> and set the <tt>eprints</tt> user as the owner. It is probably best to checkout the latest release rather than using HEAD, which may have known issues:<br />
<br />
dnf install git<br />
su eprints<br />
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3<br />
cd /opt/eprints3/<br />
git checkout tags/v3.4.7<br />
<br />
== Configuration ==<br />
<span id="getting_started_and_apache">EPrints</span> is now fully installed at <tt>/opt/eprints3</tt>. However, you will not yet have a running archive. Follow the [[Getting Started with EPrints 3]] instructions to set this up.<br />
<br />
== Post-configuration ==<br />
Add the <tt>eprints</tt> user to the <tt>apache</tt> group and vice-versa.<br />
usermod -aG apache eprints<br />
usermod -aG eprints apache<br />
<br />
Finally, restart Apache:<br />
service httpd restart<br />
<br />
=== SELinux ===<br />
There is a fair chance your operating system will have SELinux enabled. If so, follow the advice at [[EPrints and SELinux]] for how to let EPrints do what it needs to do through SELinux. Otherwise, you could disable SELinux with the following:<br />
setenforce 0<br />
However, that will only disable it until the next reboot. You should also edit '''/etc/selinux/config''' and make sure the <code>SELINUX=enforcing</code> is set to:<br />
SELINUX=disabled<br />
<br />
== Non-critical Dependencies ==<br />
Some of EPrints non-core functionality may not work out of the box as these dependencies are not included as part of the installation process. Here is a list of known additional packages (and the DNF repositories in which they can be found) or CPAN modules than can be installed. The latter should be installed using the ''cpan'' command as the root user.<br />
<br />
* '''perl-Geo-IP (epel)''' - Allows IRstats2 to determine the location of views/downloads for publications. (RHEL/CentOS/Rocky Linux 8 only)<br />
* '''perl-GeoIP2 (@System and epel)''' - Allows IRstats2 to determine the location of views/downloads for publications. (RHEL/CentOS/Rocky Linux 9+)<br />
* '''perl-Spreadsheet-WriteExcel (epel)''' - To allow Multiline Excel export.<br />
* '''CPAN module Text::Refer''' - Required for EndNote import.<br />
* '''CPAN module TeX::Encode''' - Required for BibTex export needed for publications flavour.<br />
* '''perl-Image-ExifTool (epel)''' - Sometimes needed to support generation of thumbnails for uploaded documents/images.<br />
* '''perl-LWP-Protocol-https (base)''' - Needed by DataCite plugin to register repository DOIs.<br />
<br />
== Operating System Version Specific Requirements ==<br />
<br />
=== RHEL / CentOS / Rocky 8 ===<br />
{{:Issues with installing EPrints on RHEL / CentOS / Rocky 8}}<br />
<br />
=== RHEL / CentOS / Rocky 9 ===<br />
{{:Issues with installing EPrints on RHEL / CentOS / Rocky 9}}<br />
<br />
=== RHEL / CentOS / Rocky 10 ===<br />
{{:Issues with installing EPrints on RHEL / CentOS / Rocky 10}}<br />
<br />
== Troubleshooting ==<br />
* If setup is successful but then you cannot access EPrints through your web browser this is often due to firewalld being enabled by default on recent versions of RHEL, Fedora and CentOS. If firewalld is running either disable it (<tt>systemctl disable --now firewalld</tt>) or [https://docs.rackspace.com/support/how-to/allow-web-traffic-in-a-firewalld-software-firewall/ configure it to allow HTTP/HTTPS traffic].<br />
* If you are running a version of EPrints below 3.4.6 you cannot run Apache in MPM event mode and you need to use MPM prefork instead. This is due to Perl's <tt>XML::LibXSLT</tt> being initiated at the wrong time leading earlier version of EPrints to cause Apache (httpd) to segfault when started. If you are running an earlier version and want to run Apache in MPM event mode, you can uninstall <tt>XML::LibXSLT</tt> either as the RPM perl-XML-LibXSLT or possible from CPAN using <code>cpanm --uninstall XML::LibXSLT</code>.<br />
* If you are having problems uploading files or similar functional issues, this may be due to SELinux being enabled. [[EPrints and SELinux|See advice for enabling SELinux with EPrints]].<br />
* If you are having trouble getting additional subdomains beyond username.eprints-hosting.org working, then it could be you need wildcards enabled on the DNS records to facilitate the likes of somethingcoolhere.username.eprints-hosting.org urls.</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Installing_EPrints_on_Debian/Ubuntu&diff=17167Installing EPrints on Debian/Ubuntu2026-09-14T09:25:37Z<p>LukeWallin: /* Downloading and Deploying EPrints Source */</p>
<hr />
<div>{{manual}}<br />
[[Category:Debian and Ubuntu]]<br />
[[Category:Installation]]<br />
<br />
== Requirements ==<br />
* Ubuntu 22.04 LTS and Ubuntu 24.04 LTS (non-LTS versions not recommended)<br />
* Debian 11 (Bullseye), Debian 12 (Bookworm) or Debian 13 (Trixie) - These are not as comprehensively tested as Ubuntu LTS versions.<br />
<br />
=== Dependencies and Pre-configuration ===<br />
'''The ideal way to install from source is via git using the Core Git repositories [https://github.com/eprints/eprints3.4 EPrints 3.4] or [https://github.com/eprints/eprints EPrints 3.3], and installing from a source tarball is generally discouraged.'''<br />
<br />
'''Installing from source via git is now the recommended way to install EPrints for production repositories, after having proved to be a useful installation method to those seeking to develop the EPrints code, develop a plugin or develop a Bazaar package too.'''<br />
<br />
First, as the root user install all the dependencies for EPrints ('''N.B.''' Some dependencies may not be able in certain versions of Debian/Ubuntu. See [[#Operating System Version Specific Requirements|Operating System Version Specific Requirements]] towards the end of this page):<br />
<br />
apt install perl libncurses6 libselinux1 apache2 libapache2-mod-perl2 libxml-libxml-perl \<br />
libunicode-string-perl libterm-readkey-perl libmime-lite-perl libmime-types-perl libdigest-sha-perl \<br />
libdbd-mysql-perl libxml-parser-perl libxml2-dev libxml-twig-perl libarchive-any-perl libjson-perl \<br />
liblwp-protocol-https-perl libtext-unidecode-perl lynx wget ghostscript poppler-utils antiword elinks \<br />
texlive-base texlive-binaries psutils imagemagick adduser tar gzip unzip libsearch-xapian-perl \<br />
libtex-encode-perl libio-string-perl python3-html2text make libexpat1-dev libxslt1-dev<br />
<br />
If you are installing on Ubuntu, install MySQL server and client:<br />
<br />
apt install mysql-server mysql-client libmysqlclient-dev<br />
<br />
If you are installing on Debian, install MariaDB server and client:<br />
<br />
apt install mariadb-server mariadb-client libmariadb-dev<br />
<br />
Next, create the eprints user<br />
<br />
adduser eprints<br />
<br />
Now add the eprints user to the www-data group and vice-versa<br />
<br />
usermod -a -G eprints www-data<br />
usermod -a -G www-data eprints<br />
<br />
=== Downloading and Deploying EPrints Source ===<br />
<br />
==== Create initial directory with correct permissions ====<br />
As root:<br />
mkdir /opt/eprints3<br />
chown eprints:eprints /opt/eprints3<br />
chmod 2775 /opt/eprints3<br />
<br />
==== Cloning from Git ====<br />
<br />
apt install git<br />
su eprints<br />
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3<br />
cd /opt/eprints3/<br />
git checkout tags/v3.4.7<br />
<br />
== Configuration ==<br />
Next, as the eprints user copy <code>EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm.tmpl</code> to <code>EPRINTS_PATH/perl_lib/EPrints/SystemSettings.pm</code>, if it does not already exist.<br />
<br />
<code>EPRINTS_PATH</code> should now always be <code>/opt/eprints3</code>. However, historically other paths have been used when EPrints was available as a Deb package.<br />
<br />
EPrints is now fully installed at <code>EPRINTS_PATH/</code>. However, you will not yet have a running archive. Follow the [[Getting Started with EPrints 3]] instructions to set this up.<br />
<br />
=== Post-configuration ===<br />
Next, add the file <code>/etc/apache2/sites-available/eprints.conf</code> with the following line:<br />
<br />
Include EPRINTS_PATH/cfg/apache.conf<br />
<br />
To enable this as root run the command:<br />
<br />
root> a2ensite eprints<br />
<br />
Also it may be necessary to disable the default site otherwise the default Apache page will still be shown:<br />
<br />
a2dissite 000-default<br />
<br />
Finally, restart Apache:<br />
<br />
service apache2 restart<br />
<br />
You should now be able to access your vanilla repository at the hostname you specified when running '''epadmin create''' from the [[Getting Started with EPrints 3]] instructions. You should then login as the admin user you created during this process and turn on the indexer. This can be done by clicking on the '''Admin''' link under the Logged in menu, then clicking on the '''System Tools''' tab and finally the '''Start Indexer''' button.<br />
<br />
== Operating System Version Specific Requirements ==<br />
<br />
=== Ubuntu 22.04 LTS ===<br />
{{:Issues with Installing EPrints on Ubuntu 22.04}}<br />
<br />
=== Ubuntu 24.04 LTS ===<br />
{{:Issues with Installing EPrints on Ubuntu 24.04}}<br />
<br />
=== Debian Known Issues ===<br />
See [[Debian Known Issues]]</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Installing_EPrints_on_RHEL/Fedora/CentOS&diff=17166Installing EPrints on RHEL/Fedora/CentOS2026-09-14T09:17:50Z<p>LukeWallin: /* Installing EPrints 3.4.7 from Source */</p>
<hr />
<div>{{manual}}<br />
[[Category:Installation]]<br />
<br />
== Requirements ==<br />
* Red Hat Enterprise (RHEL) / CentOS / Rocky Linux 8 or 9. (EPrints can be installed on RHEL / CentOS / Rocky Linux 10 but there are currently a [[#RHEL / CentOS / Rocky 10|number of issues]], some which should be resolved in later version of these Linux OSs).<br />
<br />
== Prerequisites ==<br />
* Pre-install and enable the EPEL DNF repository.<br />
**: <code>dnf install epel-release</code><br />
* Pre-install and enable the CodeReady Builder DNF repository.<br />
** RHEL<br />
**: <code>subscription-manager repos --enable "codeready-builder-for-rhel-$(releasever)-$(arch)-rpms"</code><br />
** CentOS Stream / Rocky Linux 8<br />
**: <code>dnf config-manager --set-enabled powertools</code><br />
** CentOS Stream / Rocky Linux 9 and 10<br />
**: <code>dnf config-manager --set-enabled crb</code><br />
* Pre-install MySQL server and client and make sure the former is enabled and running.<br />
** RHEL / Fedora:<br />
**: <code>dnf install mysql-server mysql mysql-devel<br/>&nbsp;systemctl enable --now mysqld</code><br />
** CentOS / Rocky Linux:<br />
**: <code>dnf install mariadb-server mariadb mariadb-devel<br/>&nbsp;systemctl enable --now mariadb</code><br />
* From the MySQL command prompt, pre-configure an eprints user with password for MariaDB/MySQL, which can be used as the Database super user when creating the database for an archive. (Be sure to change the password from "changeme"):<br />
*: <code>CREATE USER 'eprints'@'localhost' IDENTIFIED by 'changeme';<br/>&nbsp;GRANT ALL PRIVILEGES ON *.* TO 'eprints'@'localhost' WITH GRANT OPTION;</code><br />
* As root, from a command prompt add the <tt>eprints</tt> user:<br />
*: <code>adduser eprints</code><br />
<br />
== Dependencies ==<br />
The following RPMs need to be installed using the dnf command:<br />
dnf install libxml2 libxslt httpd mod_perl perl-Apache-DBI perl-DBI perl-DBD-MySQL perl-IO-Socket-SSL \<br />
perl-Time-HiRes perl-CGI perl-Digest-MD5 perl-Digest-SHA perl-Digest-SHA1 perl-JSON perl-XML-LibXML \<br />
perl-XML-LibXSLT perl-XML-SAX perl-MIME-Lite perl-Text-Unidecode perl-JSON perl-Unicode-Collate \<br />
perl-LWP-Protocol-https perl-IO-String tetex-latex wget gzip tar ImageMagick poppler-utils \<br />
chkconfig unzip cpan python3-html2text expat-devel libxslt-devel<br />
<br />
'''N.B.''' If you are running RHEL / CentOS / Rocky Linux 10, '''perl-Apache-DBI''' is no longer available and will need to be installed with CPAN and '''python3-html2text''' will not be available until RHEL / CentOS / Rocky Linux 10.1. You should exclude these when running the dnf command above. (See [[#RHEL_.2F_CentOS_.2F_Rocky_10|Operating System Version Specific Requirements for RHEL / CentOS / Rocky Linux 10]] below for more details).<br />
<br />
== Installing EPrints 3.4.7 from Source ==<br />
'''Ideally you will install from source from [https://github.com/eprints/eprints3.4 EPrints Core Git repository], which includes the core codebase and the publications flavour. However, you may choose to download tarballs of the EPrints core codebase and publications flavour from files.eprints.org as an alternative means of installation.<br />
<br />
== Create initial directory with correct permissions ==<br />
As root:<br />
mkdir /opt/eprints3<br />
chown eprints:eprints /opt/eprints3<br />
chmod 2775 /opt/eprints3<br />
<br />
=== Cloning from Git ===<br />
Clone the Git repository from GitHub to <tt>/opt/</tt> and set the <tt>eprints</tt> user as the owner. It is probably best to checkout the latest release rather than using HEAD, which may have known issues:<br />
<br />
dnf install git<br />
su eprints<br />
git clone https://github.com/eprints/eprints3.4.git /opt/eprints3<br />
cd /opt/eprints3/<br />
git checkout tags/v3.4.7<br />
<br />
If you want a publications flavoured repository (you probably will, this is the most common flavour deployed), then you will also need to download, unpack and move that into the appropriate location:<br />
wget https://files.eprints.org/3288/2/eprints-3.4.7-flavours.tar.gz<br />
tar -xzvf eprints-3.4.7-flavours.tar.gz<br />
mv eprints-3.4.7/flavours/pub_lib /opt/eprints3/flavours<br />
chmod -R g+w /opt/eprints3/flavours/pub_lib<br />
chown -R eprints:eprints /opt/eprints3/flavours/pub_lib<br />
<br />
== Configuration ==<br />
<span id="getting_started_and_apache">EPrints</span> is now fully installed at <tt>/opt/eprints3</tt>. However, you will not yet have a running archive. Follow the [[Getting Started with EPrints 3]] instructions to set this up.<br />
<br />
== Post-configuration ==<br />
Add the <tt>eprints</tt> user to the <tt>apache</tt> group and vice-versa.<br />
usermod -aG apache eprints<br />
usermod -aG eprints apache<br />
<br />
Finally, restart Apache:<br />
service httpd restart<br />
<br />
=== SELinux ===<br />
There is a fair chance your operating system will have SELinux enabled. If so, follow the advice at [[EPrints and SELinux]] for how to let EPrints do what it needs to do through SELinux. Otherwise, you could disable SELinux with the following:<br />
setenforce 0<br />
However, that will only disable it until the next reboot. You should also edit '''/etc/selinux/config''' and make sure the <code>SELINUX=enforcing</code> is set to:<br />
SELINUX=disabled<br />
<br />
== Non-critical Dependencies ==<br />
Some of EPrints non-core functionality may not work out of the box as these dependencies are not included as part of the installation process. Here is a list of known additional packages (and the DNF repositories in which they can be found) or CPAN modules than can be installed. The latter should be installed using the ''cpan'' command as the root user.<br />
<br />
* '''perl-Geo-IP (epel)''' - Allows IRstats2 to determine the location of views/downloads for publications. (RHEL/CentOS/Rocky Linux 8 only)<br />
* '''perl-GeoIP2 (@System and epel)''' - Allows IRstats2 to determine the location of views/downloads for publications. (RHEL/CentOS/Rocky Linux 9+)<br />
* '''perl-Spreadsheet-WriteExcel (epel)''' - To allow Multiline Excel export.<br />
* '''CPAN module Text::Refer''' - Required for EndNote import.<br />
* '''CPAN module TeX::Encode''' - Required for BibTex export needed for publications flavour.<br />
* '''perl-Image-ExifTool (epel)''' - Sometimes needed to support generation of thumbnails for uploaded documents/images.<br />
* '''perl-LWP-Protocol-https (base)''' - Needed by DataCite plugin to register repository DOIs.<br />
<br />
== Operating System Version Specific Requirements ==<br />
<br />
=== RHEL / CentOS / Rocky 8 ===<br />
{{:Issues with installing EPrints on RHEL / CentOS / Rocky 8}}<br />
<br />
=== RHEL / CentOS / Rocky 9 ===<br />
{{:Issues with installing EPrints on RHEL / CentOS / Rocky 9}}<br />
<br />
=== RHEL / CentOS / Rocky 10 ===<br />
{{:Issues with installing EPrints on RHEL / CentOS / Rocky 10}}<br />
<br />
== Troubleshooting ==<br />
* If setup is successful but then you cannot access EPrints through your web browser this is often due to firewalld being enabled by default on recent versions of RHEL, Fedora and CentOS. If firewalld is running either disable it (<tt>systemctl disable --now firewalld</tt>) or [https://docs.rackspace.com/support/how-to/allow-web-traffic-in-a-firewalld-software-firewall/ configure it to allow HTTP/HTTPS traffic].<br />
* If you are running a version of EPrints below 3.4.6 you cannot run Apache in MPM event mode and you need to use MPM prefork instead. This is due to Perl's <tt>XML::LibXSLT</tt> being initiated at the wrong time leading earlier version of EPrints to cause Apache (httpd) to segfault when started. If you are running an earlier version and want to run Apache in MPM event mode, you can uninstall <tt>XML::LibXSLT</tt> either as the RPM perl-XML-LibXSLT or possible from CPAN using <code>cpanm --uninstall XML::LibXSLT</code>.<br />
* If you are having problems uploading files or similar functional issues, this may be due to SELinux being enabled. [[EPrints and SELinux|See advice for enabling SELinux with EPrints]].<br />
* If you are having trouble getting additional subdomains beyond username.eprints-hosting.org working, then it could be you need wildcards enabled on the DNS records to facilitate the likes of somethingcoolhere.username.eprints-hosting.org urls.</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Transitioning_from_IRUS_to_OpenAIRE_Usage_Counts&diff=17046Transitioning from IRUS to OpenAIRE Usage Counts2026-04-27T09:32:42Z<p>LukeWallin: updated eprints repo link</p>
<hr />
<div><br />
# Register your repository in the [https://provide.openaire.eu/home OpenAIRE Provide service]<br />
# Install [https://github.com/eprintsug/EPrintsOpenAIRE/ EPrintsOpenAIRE export extension] (v1.1.0+)<br />
## Bazaar: https://bazaar.eprints.org/1309/ <br />
## Ingredient: https://github.com/eprintsug/EPrintsOpenAIRE/releases/tag/v1.1.0-ingredient<br />
## EPM / Git Repo: https://github.com/eprintsug/EPrintsOpenAIRE/releases/tag/v1.1.0-epm<br />
# Make sure repository is getting harvested in OpenAIRE Provide (TODO (JS): screenshots of process, run limited harvest first!!)<br />
# Install tracker NB we need to consolidate these (which are in approx. chronological order):<br />
## https://github.com/Rudjer-Boskovic-Institute/EPrints-OAPiwik <br />
## https://github.com/openaire/EPrints-OAPiwik (forked from the above)<br />
## https://github.com/alex-ball/EPrints-OAPing<br />
## https://github.com/eprints/EPrints-Matomo ''I think this is where the official release will live?''<br />
# Check data is being received - OpenAIRE is only updated monthly<br />
# remove/disable IRUS tracker<br />
<br />
== Instructions for sending historic data ==<br />
See notes in Eprints-OAPiwik?<br />
<br />
<br />
== Useful links ==<br />
# [https://www.openaire.eu/?view=article&id=2343&catid=255 UsageCounts – How to track the usage activity of your repository]<br />
# [https://usagecounts.openaire.eu/resources#apis OpenAIRE - Provide - APIs and reports (COUNTER v4 compliant!?)]</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Recaptcha3_field&diff=17041Recaptcha3 field2026-03-19T14:19:34Z<p>LukeWallin: </p>
<hr />
<div>{{fieldtypes}}<br />
<br />
<br />
== Description ==<br />
Allows a Captcha using [https://developers.google.com/recaptcha/docs/v3 Google's reCAPTCHAv3 service] to be added to a form to protect it from being spammed by bots.<br />
<br />
Add the following configuration to a file called <code>cfg/cfg.d/recaptcha3.pl</code> in your archive, if it does not already exist.<br />
$c->{recaptcha3}->{private_key} = "CHANGEME";<br />
$c->{recaptcha3}->{public_key} = "CHANGEME";<br />
$c->{recaptcha3}->{min_score} = 0.5;<br />
<br />
As this field uses the Google's reCAPTCHAv3 service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private and public key (also known by Google as a '''secret key''' and '''site key''' respectively) for the above configuration. This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''. By sure to use '''Score based (v3)''' option when registering. <br />
<br />
If you are setting up a Recaptcha3 field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.<br />
$c->add_dataset_field( "request", {<br />
name => "captcha",<br />
replace_core => 1,<br />
type => "recaptcha3",<br />
});<br />
Also make a copy of <code>lib/workflows/request/default.xml</code> in <code>your/archive/cfg/workflows/request/default.xml</code> and uncomment <code><component surround="None"><field ref="captcha" /></component></code><br />
<br />
If you find you are still getting spam from the form to which you have applied a Recaptcha3 field, then try increasing <code>$c->{recaptcha3}->{min_score}</code> to a higher value such as <code>0.7</code>.<br />
<br />
== Inheritance ==<br />
* [[:Category:EPrints_Metadata_Fields|Metadata Field]]<br />
** [[Id field]]<br />
*** [[Recaptcha3 field]]<br />
<br />
== Additional Properties ==<br />
As for [[Id field#Additional_Phrases|Id fields]].<br />
<br />
== Required Phrases ==<br />
<tt>validate:recaptcha3_mismatch</tt> - Phrase to display if reCAPTCHAv3 submission errored in some way.<br />
<br />
== Database ==<br />
Recaptcha3 fields are not stored in the database they are just so reCAPTCHAv3 can be added to certain forms. The result of the reCAPTCHAv3 does not need to be stored.<br />
<br />
== API ==<br />
See [[API:EPrints/MetaField/Recaptcha3|API page]].<br />
<br />
== Examples ==<br />
Most basic example.<br />
{<br />
name => 'captcha',<br />
type => 'recaptcha3',<br />
}</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Recaptcha3_field&diff=17040Recaptcha3 field2026-03-19T14:19:00Z<p>LukeWallin: </p>
<hr />
<div>{{fieldtypes}}<br />
<br />
<br />
== Description ==<br />
Allows a Captcha using [https://developers.google.com/recaptcha/docs/v3 Google's reCAPTCHAv3 service] to be added to a form to protect it from being spammed by bots.<br />
<br />
Add the following configuration to a file called <code>cfg/cfg.d/recaptcha3.pl</code> in your archive, if it does not already exist.<br />
$c->{recaptcha3}->{private_key} = "CHANGEME";<br />
$c->{recaptcha3}->{public_key} = "CHANGEME";<br />
$c->{recaptcha3}->{min_score} = 0.5;<br />
<br />
As this field uses the Google's reCAPTCHAv3 service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private and public key (also known by Google as a '''secret key''' and '''site key''' respectively) for the above configuration. This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''. By sure to use '''Score based (v3)''' option when registering. <br />
<br />
If you are setting up a Recaptcha3 field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.<br />
$c->add_dataset_field( "request", {<br />
name => "captcha",<br />
replace_core => 1,<br />
type => "recaptcha3",<br />
});<br />
Also make a copy of <code>lib/workflows/request/default.xml<code> in <code>your/archive/cfg/workflows/request/default.xml</code> and uncomment <component surround="None"><field ref="captcha" /></component><br />
<br />
If you find you are still getting spam from the form to which you have applied a Recaptcha3 field, then try increasing <code>$c->{recaptcha3}->{min_score}</code> to a higher value such as <code>0.7</code>.<br />
<br />
== Inheritance ==<br />
* [[:Category:EPrints_Metadata_Fields|Metadata Field]]<br />
** [[Id field]]<br />
*** [[Recaptcha3 field]]<br />
<br />
== Additional Properties ==<br />
As for [[Id field#Additional_Phrases|Id fields]].<br />
<br />
== Required Phrases ==<br />
<tt>validate:recaptcha3_mismatch</tt> - Phrase to display if reCAPTCHAv3 submission errored in some way.<br />
<br />
== Database ==<br />
Recaptcha3 fields are not stored in the database they are just so reCAPTCHAv3 can be added to certain forms. The result of the reCAPTCHAv3 does not need to be stored.<br />
<br />
== API ==<br />
See [[API:EPrints/MetaField/Recaptcha3|API page]].<br />
<br />
== Examples ==<br />
Most basic example.<br />
{<br />
name => 'captcha',<br />
type => 'recaptcha3',<br />
}</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Category:Installation&diff=17021Category:Installation2026-01-26T15:51:13Z<p>LukeWallin: adding link for Generic_Linux_Installation to installing from source</p>
<hr />
<div>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.<br />
<br />
'''The EPrints team currently recommends installing EPrints in one of the following ways:'''<br />
<br />
* '''[[Installing EPrints on Debian/Ubuntu]]'''<br />
* '''[[Installing EPrints on_RHEL/Fedora/CentOS]]'''<br />
* '''[[Generic_Linux_Installation|Installing from source]]'''<br />
<br />
Here are some other ways:<br />
<br />
* [[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<br />
* [[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<br />
<br />
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}}<br />
<br />
If you want to write installation instructions for a system other than those listed here please do so. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that it appears in this list. <br />
<br />
'''If you use one of the installation guides below and it doesn'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.'''<br />
<br />
== Distribution Notes ==<br />
<br />
Known issues and gotchas on various Linux distributions<br />
<br />
{| class="wikitable"<br />
|-<br />
! Distibution<br />
! Support<br />
! Notes<br />
|-<br />
| RHEL / Centos / Rocky 8<br />
| Supported<br />
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 8]].<br />
|-<br />
| RHEL / Centos / Rocky 9<br />
| Supported<br />
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 9]]. EPrints Services test builds against this release.<br />
|-<br />
| RHEL / Centos / Rocky 10<br />
| Supported<br />
| Some minor issues. See [[Issues with installing EPrints on RHEL / CentOS / Rocky 10]].<br />
|-<br />
| Ubuntu 22.04 LTS<br />
| Supported<br />
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 22.04]].<br />
|-<br />
| Ubuntu 24.04 LTS<br />
| Supported<br />
| Some minor issues. See [[Issues with Installing EPrints on Ubuntu 24.04]].<br />
|-<br />
|}</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Shibboleth_Debug_Logging&diff=17002Shibboleth Debug Logging2025-11-17T11:28:06Z<p>LukeWallin: </p>
<hr />
<div>As described on the main [[Shibboleth]] page. EPrints uses the Shibboleth Service Provider (SP) provided by shibboleth.net. This includes a logger that can be configured at '''/etc/shibboleth/shibd.logger''' and which logs to '''/var/log/shibboleth/shibd.log'''. This typically only logs errors and warnings and the occasionally informationl log message, typically when starting or stopping. However, if you are having problems with the Shibboleth SP, particularly when setting up, it may be useful to enable debug. To do this<br />
<br />
1. Edit the '''/etc/shibboleth/shibd.logger''' and uncomment the following lines:<br />
# tracing of SAML messages and security policies<br />
#log4j.category.OpenSAML.MessageDecoder=DEBUG<br />
#log4j.category.OpenSAML.MessageEncoder=DEBUG<br />
#log4j.category.OpenSAML.SecurityPolicyRule=DEBUG<br />
#log4j.category.XMLTooling.SOAPClient=DEBUG<br />
# interprocess message remoting<br />
#log4j.category.Shibboleth.Listener=DEBUG<br />
# mapping of requests to applicationId<br />
#log4j.category.Shibboleth.RequestMapper=DEBUG<br />
# high level session cache operations<br />
#log4j.category.Shibboleth.SessionCache=DEBUG<br />
# persistent storage and caching<br />
#log4j.category.XMLTooling.StorageService=DEBUG<br />
So they look like<br />
# tracing of SAML messages and security policies<br />
log4j.category.OpenSAML.MessageDecoder=DEBUG<br />
log4j.category.OpenSAML.MessageEncoder=DEBUG<br />
log4j.category.OpenSAML.SecurityPolicyRule=DEBUG<br />
log4j.category.XMLTooling.SOAPClient=DEBUG<br />
# interprocess message remoting<br />
log4j.category.Shibboleth.Listener=DEBUG<br />
# mapping of requests to applicationId<br />
log4j.category.Shibboleth.RequestMapper=DEBUG<br />
# high level session cache operations<br />
log4j.category.Shibboleth.SessionCache=DEBUG<br />
# persistent storage and caching<br />
log4j.category.XMLTooling.StorageService=DEBUG<br />
<br />
2. Test the Shibboleth SP is correctly configured<br />
shibd -t<br />
<br />
3. Restart the Shibboleth SP<br />
systemctl restart shibd<br />
<br />
There is various debugging that has been enabled by these changes. Particularly useful are the first two line:<br />
log4j.category.OpenSAML.MessageDecoder=DEBUG<br />
log4j.category.OpenSAML.MessageEncoder=DEBUG<br />
This will allow you to see the XML messages sent to and from the Shibboleth Identity Provider (IdP), such as MicroSoft Entra or OpenAthens. <br />
<br />
== Debugging User Attributes Mapping Issues ==<br />
This debugging can be particularly useful if you are trying to work attributes in your attribute-map.xml are not being mapped as expected. If you tail the log file '''/var/log/shibboleth/shibd.log''' and then try to login using the Shibboleth, you should see a line in the logs that starts:<br />
<samlp:Response ...<br />
If you copy the whole of that line into a text file in /tmp/ and save it. Then you can run xmllint on it to format the output. E.g.<br />
xmllint --format /tmp/saml-response.xml<br />
If attributes are being mapped, in the formatted output you should be able to see section that starts with an '''AttributeStatment''' XML tag. E.g.<br />
<AttributeStatement><br />
<Attribute Name="http://schemas.microsoft.com/identity/claims/tenantid"><br />
<AttributeValue>01234567-89ab-cdef-0123-456789abcdef</AttributeValue><br />
</Attribute><br />
<Attribute Name="http://schemas.microsoft.com/identity/claims/objectidentifier"><br />
<AttributeValue>fedcba98-7654-3210-fedc-ba9876543210</AttributeValue><br />
</Attribute><br />
<Attribute Name="http://schemas.microsoft.com/identity/claims/identityprovider"><br />
<AttributeValue>https://sts.windows.net/89abcdef-0123-4567-89ab-cdef01234567/</AttributeValue><br />
</Attribute><br />
<Attribute Name="http://schemas.microsoft.com/claims/authnmethodsreferences"><br />
<AttributeValue>http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password</AttributeValue><br />
<AttributeValue>http://schemas.microsoft.com/claims/multipleauthn</AttributeValue><br />
</Attribute><br />
<Attribute Name="urn:oid:0.9.2342.19200300.100.1.3"><br />
<AttributeValue>j.bloggs@example.org</AttributeValue><br />
</Attribute><br />
<Attribute Name="urn:oid:2.5.4.4"><br />
<AttributeValue>Bloggs</AttributeValue><br />
</Attribute><br />
<Attribute Name="urn:oid:2.5.4.42"><br />
<AttributeValue>Joe</AttributeValue><br />
</Attribute><br />
</AttributeStatement><br />
If you cannot find users attributes you are expecting to see based on what you have configurured in your Shibboleth SP's attribute-map.xml, then you will need to get the maintainer of Shibboleth IdP to make sure these attributes are released or otherwise release attributes that store the sane user metadata. At this point you can re-run this debugging to see what user attributes you are now getting and update your Shibboleth SP's attribute-map.xml as appropriate.<br />
<br />
'''When you have finished debugging. It is sensible to comment out the debug lines in '''/etc/shibboleth/shibd.logger''' again and restart the Shibboleth SP.'''</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=Branding_with_confidence&diff=16765Branding with confidence2025-05-01T13:44:58Z<p>LukeWallin: /* Changing the theme */</p>
<hr />
<div>[[Category:Branding]]<br />
<br />
One of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface - this may include logos, page layouts, stylesheets and colour schemes.<br />
<br />
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 ''Config. Tools -> View Configuration'' 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 ''View Configuration'' pages to revert the changes you have made.<br />
<br />
__TOC__<br />
<br />
==Branding fast track==<br />
<br />
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.<br />
<br />
===Adding a logo===<br />
<br />
'''Example 1'''<br />
<br />
The simplest approach, (which will require command line access to the server, as this cannot be done safely through the ''Config. Tools -> View Configuration'' 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: <br />
<br />
EPRINTS_PATH/archives/ARCHIVEID/cfg/static/images/sitelogo.png<br />
<br />
And refresh the web page. Your logo should now be displayed in place of the default EPrints logo.<br />
<br />
'''Example 2'''<br />
<br />
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's Web page.<br />
<br />
Open the branding configuration file in a text editor (e.g. Vim or Nano) if you are editing it from the command line:<br />
<br />
EPRINTS_PATH/archives/ARCHIVEID/cfg/cfg.d/branding.pl<br />
<br />
You can alternatively edit this file via the '''Config. Tools -> View Configuration''' section of the EPrints Admin web interface, under just:<br />
<br />
cfg/cfg.d/branding.pl<br />
<br />
Find the site_logo configuration setting:<br />
<br />
<source lang="perl"><br />
$c->{site_logo} = "/images/sitelogo.png";<br />
</source><br />
<br />
Change the setting to point to your own logo image:<br />
<br />
<source lang="perl"><br />
$c->{site_logo} = "http://www.soton.ac.uk/img/furniture/royal/corp_logo.gif";<br />
</source><br />
<br />
Reload the EPrints configuration by typing:<br />
<br />
EPRINTS_PATH/bin/epadmin reload ARCHIVEID<br />
<br />
If you are doing this via the EPrints Admin web interface click on the '''Reload Configuration''' button under the '''Config. Tools''' tab.<br />
<br />
'''Example 3'''<br />
<br />
You can also adjust the <tt>site_logo</tt> 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 <tt>EPRINTS_PATH/archives/ARCHIVEID/cfg/static/images/</tt> directory and then update the branding configuration file to point to it.<br />
<br />
<source lang="perl"><br />
$c->{site_logo} = "/images/mylogo.gif";<br />
</source><br />
<br />
Reload the EPrints configuration by typing:<br />
<br />
EPRINTS_PATH/bin/epadmin reload ARCHIVEID<br />
<br />
===Changing the theme===<br />
<br />
Open the branding configuration file in a text editor:<br />
(Note if this file does not exist, copy it from lib/cfg.d/branding.pl)<br />
<br />
archives/ARCHIVEID/cfg/cfg.d/branding.pl<br />
<br />
Find the theme configuration setting:<br />
<br />
<source lang="perl"><br />
# $c->{theme} = "green";<br />
</source><br />
<br />
Change the setting to use the chosen theme.<br />
<br />
<source lang="perl"><br />
$c->{theme} = "green";<br />
</source><br />
<br />
''Currently EPrints 3 only includes the default and "green" theme, but look out for more themes in future versions of EPrints and on the http://files.eprints.org/ community repository.<br />
<br />
==Taking control==<br />
<br />
This section describes techniques for taking complete control of the appearance of your repository.<br />
<br />
===Changing the page layout===<br />
<br />
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.<br />
<br />
Copy the default layout to your repository:<br />
<br />
cp lib/templates/default.xml archives/ARCHIVEID/cfg/templates/default.xml<br />
<br />
Open the template file for your repository:<br />
<br />
archives/ARCHIVEID/cfg/templates/default.xml<br />
<br />
The template is an XHTML file with some additional syntax (see [[API:EPrints/Apache/Template]]).<br />
<br />
====Pins====<br />
<br />
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.<br />
<br />
'''Example<br />
<br />
<source lang="xml"><br />
<div><br />
<div class="ep_tm_page_content"><br />
<h1 class="ep_tm_pagetitle"><br />
<epc:pin ref="title"/><br />
</h1><br />
<epc:pin ref="page"/><br />
</div><br />
</div><br />
</source><br />
<br />
This part of the template lays out the main content area of the page (the ''page'' pin) which is centered on the page.<br />
<br />
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).<br />
<br />
====Configuration Strings====<br />
<br />
There are also a number of epc:print elements in the default template which are useful for including configuration values in the template.<br />
<br />
'''Example<br />
<br />
<source lang="html4strict"><br />
<style type="text/css" media="screen">@import url(<epc:print expr="$config{base_url}"/>/style/auto.css);</style><br />
</source><br />
<br />
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).<br />
<br />
Configuration values can also be used inside attributes, using the {...} syntax.<br />
<br />
'''Example<br />
<br />
<source lang="html4strict"><br />
<a href="{$config{frontpage}}"><img alt="Logo" src="{$config{site_logo}}" /></a><br />
</source><br />
<br />
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.<br />
<br />
====Template checklist====<br />
<br />
A typical repository page layout will include:<br />
<br />
# the correct XML declaration at the top of the file<br />
# a head section (load default and custom stylesheets, ''title'' and ''head'' pins)<br />
# a body section, containing:<br />
## ''pagetop'' pin<br />
## header (repository title and logo)<br />
## navigation menu (links to browse, search etc.)<br />
## quick search box<br />
## toolbar (''login_status'' and ''toolbar'' pins)<br />
## main content area (''title'' and ''page'' pins)<br />
## footer (copyright notice etc.)<br />
<br />
====Loading the new template====<br />
<br />
Load your new template by running:<br />
<br />
bin/epadmin reload ARCHIVEID<br />
<br />
====Dealing with template errors====<br />
<br />
A common cause of errors when loading a new template is that the template is not ''well formed''. The template is in XHTML syntax, and therefore must follow the rules for writing well-formed XML documents:<br />
<br />
* http://en.wikipedia.org/wiki/XML#Well-formed_documents<br />
<br />
'''Example<br />
<br />
You get the following error when reloading the template:<br />
<br />
parser error : Opening and ending tag mismatch: img line 25 and div<br />
<br />
Open the template file, and look for an img tag on line 25:<br />
<br />
<img src="/images/mylogo.gif"> <br />
<br />
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:<br />
<br />
<img src="/images/mylogo.gif" /> <br />
<br />
'''Example<br />
<br />
parser error : Opening and ending tag mismatch: p line 60 and body<br />
<br />
Open the template file and look for the p tag on line 60:<br />
<br />
<pre><br />
<p>This repository is maintained by the <b>Library and Computing team</b>.<br />
</pre><br />
<br />
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:<br />
<br />
<pre><br />
<p>This repository is maintained by the <b>Library and Computing team</b>.</p><br />
</pre><br />
<br />
===Adding extra images===<br />
<br />
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's image directory:<br />
<br />
archives/ARCHIVEID/cfg/static/images/<br />
<br />
'''Example<br />
<br />
Place a copy of small_logo.gif in:<br />
<br />
archives/ARCHIVEID/cfg/static/images/<br />
<br />
Use the image in the template:<br />
<br />
<source lang="html4strict"><br />
<img src="{$config{base_url}}/images/small_logo.gif" /><br />
</source><br />
<br />
===Working with stylesheets===<br />
<br />
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.<br />
<br />
The default stylesheets can be found here:<br />
<br />
lib/static/style/auto/<br />
<br />
====Overriding default style rules====<br />
<br />
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's overrides file:<br />
<br />
archives/ARCHIVEID/cfg/static/style/auto/zzz_local.css<br />
<br />
Remember that the stylesheets are applied in alphabetical order, so this file will be applied last.<br />
<br />
'''Example<br />
<br />
<source lang="css"><br />
h1 {<br />
margin: 0px 0px 10px 0px;<br />
font: bold 130% Arial,Sans-serif;<br />
text-align: center;<br />
color: #606060;<br />
}<br />
</source><br />
<br />
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).<br />
<br />
Edit the local overrides file for your repository:<br />
<br />
archives/ARCHIVEID/cfg/static/style/auto/zzz_local.css<br />
<br />
Override the ''font'' part of the h1 style:<br />
<br />
<source lang="css"><br />
h1 {<br />
font: bold 200% Arial,Sans-serif;<br />
}<br />
</source><br />
<br />
This renders the page title on each page in a larger font.<br />
<br />
====Overriding default stylesheets====<br />
<br />
If you want to override a default stylesheet in its entirety, you should copy it into your repository's stylesheet directory and edit it there.<br />
<br />
'''Example<br />
<br />
Make a copy of the default stylesheet general.css:<br />
<br />
cp lib/static/style/auto/general.css archives/ARCHIVEID/cfg/static/style/auto/<br />
<br />
Edit the repository copy:<br />
<br />
archives/ARCHIVEID/cfg/static/style/auto/general.css<br />
<br />
After making changes to the repository copy of general.css, apply the new stylesheet by running:<br />
<br />
bin/generate_static ARCHIVEID<br />
<br />
====Adding institutional stylesheets====<br />
<br />
Your institutional Web site may already have a stylesheet or set of stylesheets that you want to apply to your repository.<br />
<br />
Copy the institutional stylesheets into your repository stylesheet directory:<br />
<br />
archives/ARCHIVEID/cfg/static/style/<br />
<br />
Process the stylesheets by running:<br />
<br />
bin/generate_static ARCHIVEID<br />
<br />
The stylesheets are then available to use in the template file.<br />
<br />
'''Example<br />
<br />
<source lang="html4strict"><br />
<head><br />
...<br />
<style type="text/css" media="screen">@import url(<epc:print expr="$config{base_url}"/>/style/auto.css);</style><br />
<style type="text/css" media="screen">@import url(<epc:print expr="$config{base_url}"/>/style/my_inst.css);</style><br />
</source><br />
<br />
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 ''after'' the repository stylesheets (applied in order by auto.css) so that the institutional style rules override the repository style rules.<br />
<br />
====Adding extra style-related images====<br />
<br />
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:<br />
<br />
archives/ARCHIVEID/cfg/static/style/images/<br />
<br />
Note that this keeps the style-related images separate from other images used by your repository pages, such as logos.<br />
<br />
The images can then be used in your stylesheet.<br />
<br />
===Adding dynamic content===<br />
<br />
You can add dynamic content to the template by adding extra epc:pin elements.<br />
<br />
Dynamic pins can be created in the dynamic template configuration file:<br />
<br />
archives/ARCHIVEID/cfg/cfg.d/dynamic_template.pl<br />
<br />
'''Example<br />
<br />
Open the template file for your repository:<br />
<br />
archives/ARCHIVEID/cfg/lang/en/templates/default.xml<br />
<br />
Add a new pin called ''todays_date'' to the template; here we add the pin next to the user's login status:<br />
<br />
<source lang="html4strict"><br />
<div><br />
<div class="ep_tm_page_content"><br />
<h1 class="ep_tm_pagetitle"><br />
<epc:pin ref="title"/><br />
</h1><br />
<epc:pin ref="page"/><br />
<epc:pin ref="todays_date"/><br />
</div><br />
</div><br />
</source><br />
<br />
Open the dynamic template configuration file for your repository:<br />
<br />
archives/ARCHIVEID/cfg/cfg.d/dynamic_template.pl<br />
<br />
Find and uncomment the function that creates the content for the dynamic pins:<br />
<br />
<source lang="perl"><br />
$c->{dynamic_template}->{function} = sub {<br />
my( $repository, $parts ) = @_;<br />
};<br />
</source><br />
<br />
Add a line which creates the content for the ''todays_date'' pin:<br />
<br />
<source lang="perl"><br />
$c->{dynamic_template}->{function} = sub {<br />
my( $repository, $parts ) = @_;<br />
$parts->{todays_date} = $repository->make_text( scalar localtime );<br />
};<br />
</source><br />
<br />
Reload the dynamic template configuration:<br />
<br />
bin/epadmin reload ARCHIVEID<br />
<br />
The date should now be displayed on your repository pages.<br />
<br />
== See also ==<br />
* [[Branding, the next level]]</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=User:LukeWallin&diff=16725User:LukeWallin2025-02-18T15:21:50Z<p>LukeWallin: </p>
<hr />
<div>Employee of EPrints Services.</div>LukeWallinhttps://wiki.eprints.org/w/index.php?title=EPrints_and_SELinux&diff=16724EPrints and SELinux2025-02-18T15:21:29Z<p>LukeWallin: /* Changing Directory Permissions and SELinux Contexts */</p>
<hr />
<div>This page is intended to write a rough set of instructions for how to get a CentOS 7 system setup with SELinux enforcing so EPrints 3.4 (with site_lib) runs without any issues. This guidance will be applicable to other versions of CentOS as well as RHEL and Fedora. Furthermore, it may be applicable for enabling SELinux on other Linux operatings ystems.<br />
<br />
'''N.B. All commands described below need to be run as the root user or using sudo.'''<br />
<br />
== Apache Configuration ==<br />
* Set the httpd user and group to Apache (rather than eprints like is currently used on our hosted CentOS 7 VMs) in '''/etc/httpd/conf/httpd.conf'''.<br />
User apache<br />
Group apache<br />
<br />
== System Users and Groups ==<br />
* Add eprints to the apache group and apache to the eprints group (so that '''/etc/group''' for these looks something like the following, order does not matter):<br />
apache:x:48:eprints<br />
eprints:x:1000:apache<br />
<br />
== Changing Directory Permissions and SELinux Contexts ==<br />
In general when a new EPrints root is deployed in /opt/eprints3/ this directory has been setup to have eprints as its owner and group with permissions set to 2775 (drwxrwsr-x). This should generally ensure that all subdirectories will share the same permissions when checked out from SVN/Git and all files will get the permissions 0664 (-rw-rw-r--). If directories of files to not have at least these permissions (with the exception of and SSL keys) then these permissions should be added. svn:executable should be set on appropriate files so when they are checked out they should have 0775 (-rwxrwxr-x) permissions.<br />
<br />
What will need to be changed are the SELinux contexts of various directory. This is the list compiled so far for the changes required. It is assumed the command are run from the /opt/eprints3/ directory:<br />
<br />
(if the directory does not exist, there is no need to run that line)<br />
<br />
chcon -R -t httpd_sys_content_t archives/<br />
chcon -R -t httpd_sys_content_t flavours/<br />
chcon -R -t httpd_sys_content_t ingredients/<br />
chcon -R -t httpd_sys_content_t site_lib/<br />
chcon -R -t httpd_sys_rw_content_t archives/ARCHIVENAME/cfg/<br />
chcon -R -t httpd_sys_rw_content_t archives/ARCHIVENAME/documents/<br />
chcon -R -t httpd_sys_rw_content_t archives/ARCHIVENAME/html/<br />
chcon -R -t httpd_sys_rw_content_t archives/ARCHIVENAME/var/<br />
chcon -R -t httpd_sys_rw_content_t lib/<br />
chcon -R -t httpd_sys_rw_content_t tmp/<br />
chcon -R -t httpd_sys_rw_content_t var/<br />
<br />
== Setting SELinux Booleans ==<br />
You will definitely need to modify the SELinux boolean so that Apache (httpd) to be able to send email:<br />
setsebool -P httpd_can_sendmail 1<br />
Unless you are running an absolutely vanilla repository you will almost certainly need to allow APache (httpd) to connect to the network:<br />
setsebool -P httpd_can_network_connect 1<br />
In particular this should allow EPrints to connect to LDAP to authenticate user login and allow connecting to remote detabases. There are also the following options for these two things but ''httpd_can_network_connect'' should be sufficient.<br />
setsebool -P httpd_can_connect_ldap 1<br />
setsebool -P httpd_can_network_connect_db 1<br />
By default the following booleans for httpd should be set on:<br />
httpd_enable_cgi<br />
httpd_builtin_scripting<br />
httpd_graceful_shutdown<br />
There is no need to turn any of these off. However, the ''httpd_builtin_scripting'' is probably not needed as ModPerl uses ''httpd_enable_cgi'', which definitely should not be turned off. Having ''httpd_graceful_shutdown'' is useful for reloading Apache after making changes to EPrints configuration.<br />
<br />
== Extra settings for OpenOffice/Coversheets ==<br />
'''This assumes switching to use packaged LibreOffice and UNO converter as detailed [[Coversheets#LibreOffice|here]].'''<br />
<br />
* The following changes are need so that httpd can execute things for coversheets:<br />
<br />
chcon -t httpd_sys_script_exec_t "/PATH/TO/stitchPDFs"<br />
setsebool -P httpd_execmem 1<br />
<br />
* Ensure the httpd can manage TCP port 2002 that OpenOffice listens on:<br />
semanage port -a -t http_port_t -p tcp 2002<br />
<br />
* Add executables and invocation lines for openoffice to /opt/eptints3/EPrints/SystemSettings.pm<br />
# invocation<br />
openoffice' => '/usr/lib64/libreoffice/program/soffice.bin',<br />
# executable<br />
openoffice' => '$(openoffice) "-accept=socket,host=localhost,port=2002;urp;StarOffice.ServiceManager" -norestore -nofirststartwizard -nologo -headless',<br />
<br />
<br />
* Make sure $ENV{'HOME'} as well as $ENV{'TMPDIR'} is set to /opt/eprints3/tmp/ in the appropriate session.pl<br />
<br />
== Extra settings for MePrints ==<br />
chcon -t httpd_sys_rw_content_t "/opt/eprints3/archives/ARCHIVENAME/meprints"<br />
<br />
== Testing ==<br />
I have tested and have been able to successfully install the following Bazaar plugin:<br />
* Dates, Dates, Dates<br />
* Generic Reporting Framework<br />
* IRStats2<br />
* RIOXX2<br />
* REFCC (hefce_oa)<br />
* Coversheets<br />
* OpenOffice<br />
* MePrints<br />
However there are some issue with OpenOffice saying it is running when it is not and not being able to get soffice.bin actually running as a result. You can upload and frontfile.odt file as a coversheet and this will get stored under cfg/static/coversheets/ in the archive.<br />
<br />
If you install MePrints you subsequently need to create archives/ARCHIVENAME/meprints directory and then run:<br />
<br />
chcon -R -t httpd_sys_rw_content_t archives/ARCHIVENAME/meprints/<br />
<br />
Otherwise, the above Bazaar plugins need to be tested to make sure they are full functional along with other functionality of the repository like: the phrase editor, "edit this page", storage manger, subjects editor, send test email, etc.<br />
<br />
== Policy file ==<br />
First install the following packages:<br />
yum install checkpolicy policycoreutils-python<br />
Then put all these files under /home/eprints/policy/ and run '''redeploy_policy.sh''' as the root user:<br />
bash /home/eprints/policy/redeploy_policy.sh<br />
After this be sure to run '''restorecon''' on your EPrints path<br />
restorecon -R /opt/eprints3<br />
<br />
=== eprints.fc ===<br />
It is assumed that the the path for your EPrints installation is ''/opt/eprints3'' if that is not the case or even that you have symlinked ''/opt/eprints3'' to where EPrints is actually installed the file below will not work as intended. However you can fix this with a simple find and replace. <br />
# SELinux file contexts for EPrints<br />
<br />
/opt/eprints3/archives(/.*)? unconfined_u:object_r:httpd_sys_content_t:s0<br />
/opt/eprints3/flavours(/.*)? unconfined_u:object_r:httpd_sys_content_t:s0<br />
/opt/eprints3/ingredients(/.*)? unconfined_u:object_r:httpd_sys_content_t:s0<br />
/opt/eprints3/site_lib(/.*)? unconfined_u:object_r:httpd_sys_content_t:s0<br />
/opt/eprints3/archives/[^/]*/bin(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/archives/[^/]*/cfg(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/archives/[^/]*/cgi(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/archives/[^/]*/documents(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/archives/[^/]*/html(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/archives/[^/]*/var(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/lib(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/tmp(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
/opt/eprints3/var(/.*)? unconfined_u:object_r:httpd_sys_rw_content_t:s0<br />
<br />
=== eprints.te ===<br />
module eprints 1.2;<br />
<br />
require {<br />
type cgroup_t;<br />
type fusefs_t;<br />
type http_port_t;<br />
type httpd_sys_content_t;<br />
type httpd_sys_rw_content_t;<br />
type httpd_sys_script_exec_t;<br />
type httpd_sys_script_t;<br />
type httpd_t;<br />
type init_t;<br />
type modules_object_t;<br />
type mysqld_db_t;<br />
type mysqld_etc_t;<br />
type mysqld_t;<br />
type mysqld_var_run_t;<br />
type nrpe_t;<br />
type shadow_t;<br />
type smtp_port_t;<br />
type unconfined_service_t;<br />
type var_run_t;<br />
class dir { add_name create getattr open read remove_name rmdir search setattr write };<br />
class file { create execute execute_no_trans getattr ioctl map open read rename unlink write };<br />
class lnk_file { getattr read };<br />
class sock_file { write };<br />
class tcp_socket{ name_connect };<br />
class unix_stream_socket { connectto };<br />
}<br />
<br />
# Required by the HTTP webserver<br />
allow httpd_t http_port_t:tcp_socket { name_connect };<br />
allow httpd_t httpd_sys_content_t:dir { add_name create remove_name setattr write };<br />
allow httpd_t httpd_sys_content_t:file { create rename unlink write };<br />
allow httpd_t smtp_port_t:tcp_socket { name_connect };<br />
allow httpd_t unconfined_service_t:dir { getattr };<br />
<br />
# Requiired by init processes<br />
allow init_t httpd_sys_content_t:file { create execute execute_no_trans ioctl open read };<br />
allow init_t httpd_sys_rw_content_t:dir { add_name remove_name };<br />
allow init_t httpd_sys_rw_content_t:file { ioctl open read unlink write };<br />
allow init_t mysqld_t:unix_stream_socket { connectto };<br />
<br />
# Required for Icinga NRPE checks<br />
allow nrpe_t httpd_sys_content_t:dir { read };<br />
allow nrpe_t httpd_sys_content_t:file { getattr };<br />
allow nrpe_t httpd_sys_rw_content_t:dir { search };<br />
allow nrpe_t httpd_sys_rw_content_t:file { getattr open read };<br />
allow nrpe_t modules_object_t:dir { search };<br />
allow nrpe_t modules_object_t:file { getattr };<br />
allow nrpe_t modules_object_t:lnk_file { getattr read };<br />
allow nrpe_t mysqld_t:unix_stream_socket { connectto };<br />
allow nrpe_t mysqld_db_t:dir { search };<br />
allow nrpe_t mysqld_etc_t:dir { getattr open read search };<br />
allow nrpe_t mysqld_etc_t:file { getattr open read };<br />
allow nrpe_t mysqld_var_run_t:sock_file { write }; <br />
<br />
# Only needed for coversheets, considering commenting out otherwise.<br />
allow httpd_t shadow_t:file { getattr open read };<br />
<br />
# Only needed for Shibboleth authentication, consider commenting out otherwise.<br />
allow httpd_t var_run_t:sock_file { write };<br />
<br />
# Only needed for SSH FuseFS, consider commeting out otherwise.<br />
allow httpd_t fusefs_t:dir { add_name create read remove_name rmdir setattr write };<br />
allow httpd_t fusefs_t:file { create getattr ioctl map open read rename unlink write };<br />
<br />
=== redeploy_policy.sh ===<br />
#!/bin/bash<br />
<br />
rm -f eprints.mod eprints.pp <br />
<br />
# Build the policy package (.pp) file from type enforcement (.te) and file contexts (.fc) files.<br />
checkmodule -M -m -o eprints.mod eprints.te<br />
semodule_package -o eprints.pp -m eprints.mod -f eprints.fc<br />
<br />
# Install it.<br />
semodule -i eprints.pp</div>LukeWallin