Difference between revisions of "Manual"
(Added link to setting up HTTPS using Let's Encrypt) |
(Added link to glossary moved links for user and admin menus. Removed plugin types unlikely to be added to.) |
||
| (27 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
__NOTOC__ | __NOTOC__ | ||
See the [[Main Page]] for other areas of this wiki. | See the [[Main Page]] for other areas of this wiki. | ||
| Line 5: | Line 4: | ||
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]] | * [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]] | ||
| + | <table cellpadding="10"><tr><td width="33%" valign="top"> | ||
| + | = Releases = | ||
| + | {{releasenotes}} | ||
| + | ''See also the note on [[EPrints Version Numbering]]'' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | = Download = | |
{{Download}} | {{Download}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | = Installation = | ||
* [[Recommended Platforms]] | * [[Recommended Platforms]] | ||
* [[Required software]] | * [[Required software]] | ||
* Install Guides | * Install Guides | ||
| − | ** [[Installing | + | ** [[Installing EPrints on RHEL/Fedora/CentOS]] |
| − | ** | + | *** Primarily RedHat Enterprise Linux (RHEL) and CentOS 7 and 8. |
| − | ** | + | *** Guides for installing from RPM package and from source. |
| − | ** [[ | + | ** [[Installing EPrints on Debian/Ubuntu]] |
| − | ** [[ | + | *** Primarily Ubuntu 18.04 LTS and 20.04 LTS. |
| − | + | *** Guides for installing from Deb package and from source. | |
| − | ** [[ | + | * [[Installation|Generic EPrints installation instructions]] |
| − | ** [[ | + | * [[How to use EPrints with HTTPS]] |
| − | * [[ | + | ** [[Setting up HTTPS using Let's Encrypt]] |
| + | ** [[HTTPS-only and HSTS]] | ||
| + | * [[Installing EPrints using Docker]] | ||
| − | + | = Post Installation = | |
* [[Getting Started with EPrints 3]] | * [[Getting Started with EPrints 3]] | ||
| − | |||
| − | |||
| − | |||
| − | + | = Maintenance = | |
* [[Backups]] | * [[Backups]] | ||
* [[Generate Scripts]] | * [[Generate Scripts]] | ||
| Line 60: | Line 40: | ||
* [[Automating your maintenance]] | * [[Automating your maintenance]] | ||
* [[Troubleshooting]] | * [[Troubleshooting]] | ||
| + | </td> | ||
| − | + | <td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;"> | |
| − | =Training Materials= | + | = Training Materials = |
* [[:Category:Training Video|EPrints Training Course]] | * [[:Category:Training Video|EPrints Training Course]] | ||
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services. | * [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services. | ||
| + | |||
= 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 ...'' |
| − | |||
* [[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 89: | Line 69: | ||
* [[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.'' |
| − | + | * [[SWORD]] - ''how to configure the SWORD protocol on EPrints.'' | |
| − | * [[SWORD]] - '' | + | * [[Custom handlers]] - ''how to add a custom handler for intergration with third-party applications.'' |
| − | * [[ | ||
= 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... | ||
| Line 107: | Line 85: | ||
* [[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 115: | Line 93: | ||
= Technical Reference = | = Technical Reference = | ||
| − | + | * [[EPrints Directory Structure]] - How code and configuation files are organised. | |
| − | * [[EPrints Directory Structure]] - | + | * [[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 142: | Line 121: | ||
** The [[Request Object]] | ** The [[Request Object]] | ||
* [[:Category:Plugins|Plugins]] | * [[:Category:Plugins|Plugins]] | ||
| − | + | ** [[Create Export Plugins|Export]] | |
| − | ** [[Create Export Plugins|Export | + | ** Import |
| − | ** | + | ** [[Screen Plugins|Screen]] |
| − | ** [[Screen Plugins]] | ||
| − | |||
* [[Autocompletion]] | * [[Autocompletion]] | ||
** [[Understanding IDs in Workflow Forms]] | ** [[Understanding IDs in Workflow Forms]] | ||
Revision as of 07:38, 6 March 2022
See the Main Page for other areas of this wiki.
ReleasesRelease Notes 3.4 | 3.4.1 | 3.4.2 | 3.4.3 | 3.4.4 | 3.4.5 3.3 | 3.3.5 | 3.3.6 | 3.3.7 | 3.3.8 | 3.3.9 | 3.3.10 | 3.3.11 | 3.3.13 | 3.3.14 | 3.3.15 | 3.3.16 3.2.0 | 3.2.1 | 3.2.2 | 3.2.3 | 3.2.4 | 3.2.5 | 3.2.6 | 3.2.7 | 3.2.8 | 3.2.9 See also the note on EPrints Version Numbering
Download
Installation
Post InstallationMaintenance |
Training Materials
How-to Guides
How to contributeThere'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
|
