Manual

See the Main Page for other areas of this wiki.

Introduction

• Introduction
• How to Get Help/Support
• History

Installation and First Steps

Download

• EPrints 3.4 series (latest release)
  • Read this before upgrading your archive from 3.3 to 3.4
  • Upgrading between EPrints 3.4 versions
  • Download
  • Development
• EPrints 3.3 series (legacy supported release)
  • Read this before upgrading your archive from 3.2 to 3.3
  • Download
  • February 2021 security patch for EPrints 3.3.16
  • Legacy development

Installing EPrints From Source (.tar.gz)

• Recommended Platforms
• Required software
• Install Guides
  • Installing Eprints 3 on Fedora Core 7 (also applicable to FC6)
  • Installing EPrints 3 on RedHat Enterprise 4
  • Installing EPrints 3 on OS X
  • Installing EPrints 3 on Ubuntu 6.10
  • Installing EPrints 3 on Debian
  • Installing EPrints 3 on Debian/Ubuntu - The Quicker Way
  • Installing EPrints on various platforms.
• Installing EPrints 3 with an https server

Installing EPrints From Binary

• Installing EPrints 3 via Redhat RPM
• Installing EPrints 3 via Fedora RPM
• Installing EPrints 3 via apt (Debian/Ubuntu)

Post Installation

• Upgrading from an earlier version of EPrints3
• Migrating from EPrints 2.3

Getting Started

• Getting Started

• Maintenance
  • Backups
  • Generate Scripts
  • Alerts
  • Log Files
  • Automating your maintenance

• Troubleshooting

How-to Guides

What is a how-to?

• Orientation (Start here)
  • 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...
  • Migrated from EPrints 2? - this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...
• 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, the next level - how to completely change the interface to your own design
• OAI
• Adding new views
• Workflow
• Deposit Types
  • Removing types
• Metadata
• Subjects (fold in with Organisation Hierarchy under "controled vocabularies")
• Organisation Hierarchy - how to put your own organisation's Hierarchy into EPrints 3
• Searches
• Autocompletion and Authority Files (Romeo Autocomplete) - add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...
• 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)...
• Change Deposit Status in Bulk - move a large number of deposits from inbox to archive
• more

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.

• Plugins
• Scripts
• Themes
• Translations
• Other neighbourly things to do
• Extension Packages

Misc

• Preservation Support in GNU EPrints 3
• i18n

Technical Reference

• EPrints Directory Structure - will be linked somewhere better, later.

• Metadata - configuring metadata fields.
• Repository Configuration
• XML Configuration Files
  • EPScript - documentation for the EP3 Scripting language (for use in citations and workflow files).
  • EPrints Control Format - the structure used to embed EPScript in an XML configuration file.
  • Citation Format
  • Workflow Format - the structure of the EP3 workflow files
  • Phrase Format
  • Template Format
  • XPAGE Format
• XML Export Format
• EPrints data structure
  • of the software
  • of the database (relating the dataobjects to each other using eprints fields)
• Data Objects and data sets
  • The EPrint Object
  • The User Object
  • The Document Object
  • The Subject Object
  • The Saved Search Object
  • The History Object
  • The Access Object
  • The Request Object
• Plugins
  • Import
  • Export Plugins
  • Components
  • Screen
  • Convert
• Autocompletion
  • Understanding IDs in Workflow Forms
• API
• Dynamic Template System