Difference between revisions of "Manual"

From EPrints Documentation
Jump to: navigation, search
(Using EPrints in the Cloud)
(Technical Reference)
 
(53 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Rubbish]]
 
 
__NOTOC__
 
__NOTOC__
 
See the [[Main Page]] for other areas of this wiki.
 
See the [[Main Page]] for other areas of this wiki.
  
 
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]  
 
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]  
* New Features and upgrade notes: [[New Features in EPrints 3.1|3.1]], [[New Features in EPrints 3.2|3.2]], [[New Features in EPrints 3.2.1|3.2.1]]
 
* (see also the note on [[EPrints Version Numbering]])
 
  
<table cellpadding="10"><tr><td width="33%" valign="top">
+
<table cellpadding="10"><tr><td width="33%" valign="top">  
 +
= Releases =
 +
{{releasenotes}}
 +
''See also the note on [[EPrints Version Numbering]]''
  
= Installation and First Steps =
 
  
* [[Quick Server Install Guide (Debian / Ubuntu Server)]]
+
= Download =
 
 
== Download ==
 
 
{{Download}}
 
{{Download}}
  
== Installing EPrints From Binary ==
 
* [[Installing EPrints 3 via Redhat RPM]]
 
* [[Installing EPrints 3 via Fedora RPM]]
 
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]
 
 
== Using EPrints in the Cloud ==
 
* [[EPrints EC2]] - Running both a vanilla and training repository!
 
 
== Using the Live CD ==
 
* [[EPrints Live CD Help]]
 
* [[Building the Live CD]]
 
 
== Installing EPrints From Source (.tar.gz) ==
 
  
 +
= Installation =
 
* [[Recommended Platforms]]
 
* [[Recommended Platforms]]
 
* [[Required software]]
 
* [[Required software]]
 
* Install Guides
 
* Install Guides
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)
+
** [[Installing EPrints on RHEL/Fedora/CentOS]]
** [[Installing EPrints 3 on RedHat Enterprise 4]]
+
*** Primarily RedHat Enterprise Linux (RHEL) and CentOS 7 and 8.
** [[Installing EPrints 3 on OS X]]
+
*** Guides for installing from RPM package and from source.
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]
+
** [[Installing EPrints on Debian/Ubuntu]]
** [[Installing EPrints 3 on Ubuntu 6.10]]
+
*** Primarily Ubuntu 18.04 LTS and 20.04 LTS.
** [[Installing EPrints 3 on Debian]]
+
*** Guides for installing from Deb package and from source.
** [[Installing in a chroot Debian/Ubuntu]]
+
* [[Installation|Generic EPrints installation instructions]]
** [[:Category:Installation|Installing]] EPrints on various platforms.
+
* [[How to use EPrints with HTTPS]]
* [[Https3 | Installing EPrints 3 with an https server]]
+
** [[Setting up HTTPS using Let's Encrypt]]
 +
** [[HTTPS-only and HSTS]]
 +
* [[Installing EPrints using Docker]]
  
==Post Installation==
+
= Post Installation =
 +
* [[Getting Started with EPrints 3]]
  
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]
+
= Maintenance =
* [[Migration|Migrating from EPrints 2.3]]
+
* [[Backups]]
 +
* [[Generate Scripts]]
 +
* [[Alerts]]
 +
* [[Log Files]]
 +
* [[Automating your maintenance]]
 +
* [[Troubleshooting]]
 +
* [[Apache Hardening]]
 +
</td>
  
==Getting Started==
+
<td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">
* [[Getting Started with EPrints 3|Getting Started]]
 
  
* Maintenance
+
= Training Materials =
** [[Backups]]
+
* [[:Category:Training Video|EPrints Training Course]]
** [[Generate Scripts]]
+
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
** [[Alerts]]
 
** [[Log Files]]
 
** [[Automating your maintenance]]
 
  
* [[Troubleshooting]]
 
</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">
 
  
 
= How-to Guides =
 
= How-to Guides =
 
 
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]
 
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]
  
* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span>
+
* [[:Category:Howto|Orientation/Overview]] <span style="color: #f94; font-size: 130%">(Start here)</span>
** [[Configuration orientation|New to EPrints 3?]]  - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''
+
** [[Configuration orientation|New to EPrints 3?]]  - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape ...''
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...''  
 
 
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding
 
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding
 
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''
 
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''
Line 83: Line 70:
 
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
 
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
 
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
 
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive
+
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive.''
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.
+
* [[SWORD]] - ''how to configure the SWORD protocol on EPrints.''
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.
+
* [[Custom handlers]] - ''how to add a custom handler for intergration with third-party applications.''
* [[:Category:Howto|more ...]]
+
* [[User Deposit Agreement]] - ''How to add a user deposit agreement to the workflow.''
 +
* [[ORCID]]
 +
** [[Import From ORCID]]
 +
* Javascript
 +
** [[Include Javascript in the workflow]]
 +
* DKIM email verification
 +
** [[How to configure DKIM email verification (using sendmail on Rocky9)]]
  
 
= How to contribute =
 
= How to contribute =
 
 
There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...
 
There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...
  
 
Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.
 
Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.
  
 +
* [[:Category:Documentation Needed| Create some of the missing documentation]]
 
* [[Contribute: Plugins | Plugins]]
 
* [[Contribute: Plugins | Plugins]]
 
* [[Contribute: Scripts | Scripts]]
 
* [[Contribute: Scripts | Scripts]]
Line 100: Line 93:
 
* [[Contribute: Other | Other neighbourly things to do]]
 
* [[Contribute: Other | Other neighbourly things to do]]
 
* [[Extension Packages]]
 
* [[Extension Packages]]
 +
  
 
= Misc =
 
= Misc =
 
 
* [[Preservation Support]] in EPrints 3
 
* [[Preservation Support]] in EPrints 3
 
* [[:Category:Languages|Language support and translations]]
 
* [[:Category:Languages|Language support and translations]]
Line 108: Line 101:
  
 
= Technical Reference =
 
= Technical Reference =
 
+
* [[EPrints Directory Structure]] - How code and configuation files are organised.
* [[EPrints Directory Structure]] - will be linked somewhere better, later.
+
* [[EPrints Glossary]] - A listing of terminology used within EPrints.
 
+
* [[User Menu]] - Explaining the menu options available to an EPrints user.
 +
* [[Admin|Admin Menu]] - Explaining the tools available to a repository administrator.
 
* [[Metadata]] - configuring metadata fields.
 
* [[Metadata]] - configuring metadata fields.
 
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
 
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
Line 134: Line 128:
 
** The [[Access Object]]
 
** The [[Access Object]]
 
** The [[Request Object]]
 
** The [[Request Object]]
* Plugins
+
* [[:Category:Plugins|Plugins]]
** Import
+
** [[Create Export Plugins|Export]]
** [[Export Plugins]]
+
** Import
** Components
+
** [[Screen Plugins|Screen]]
** [[Screen Plugins]]
 
** Convert
 
 
* [[Autocompletion]]
 
* [[Autocompletion]]
 
** [[Understanding IDs in Workflow Forms]]
 
** [[Understanding IDs in Workflow Forms]]
 
* [[API]]
 
* [[API]]
 
* [[Dynamic Template System]]
 
* [[Dynamic Template System]]
 +
* [[Config Options by File]]
 +
* [[Triggers|Trigger functions]]
 +
 +
= The EPrints Bazaar =
 +
* [[:Category:EPrints_Bazaar|The EPrints Bazaar]] (Start Here)
 
* The [[EPM Specification]]
 
* The [[EPM Specification]]
 +
* [[:Category:Bazaar_Package|Bazaar Packages]]
 +
 
</td></tr></table>
 
</td></tr></table>

Latest revision as of 17:26, 25 July 2024

See the Main Page for other areas of this wiki.

Releases

See also the note on EPrints Version Numbering


Download


Installation

Post Installation

Maintenance

Training Materials


How-to Guides

What is a how-to?

How to contribute

There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...

Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.


Misc

Technical Reference

The EPrints Bazaar