Difference between revisions of "Archives/ARCHIVEID/"

From EPrints Documentation
Jump to: navigation, search
m
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
+
{{dirs}}
 
This is the top level directory for a single repository.
 
This is the top level directory for a single repository.
  
Line 8: Line 8:
 
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents/]]''' - Uploaded documents. Also contains per-record files such as full-text caches, thumbnails and revision history.
 
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents/]]''' - Uploaded documents. Also contains per-record files such as full-text caches, thumbnails and revision history.
 
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html/]]''' - The website for this repository. Do not edit by hand.
 
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html/]]''' - The website for this repository. Do not edit by hand.
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var/]]''' - Files generated by eprints specific to this repository.
+
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var/]]''' - Files generated by eprints specific to this repository
 +
 
 +
As you add bespoke features to your repository, you may need (or if you install [https://bazaar.eprints.org EPrints Bazaar] plugins will have) extra sub-directories in this directory:
 +
* '''bin/''' - For scripts you may need to run against the repository archive (e.g. as a cron job).
 +
* '''cgi/''' - Bespoke CGI scripts that can be accessed from the cgi path of the web interface (e.g. https://eprints.example.org/cgi/).  If you want to override existing CGI script as you require bespoke changes, you will need to copy them to the equivalent location in this directory and edit them here.
 +
* '''ssl/''' - For adding a [[securevhost.conf]] to provide HTTPS Apache configuration for your repository archive.

Latest revision as of 11:22, 28 January 2022

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

This is the top level directory for a single repository.

It would not be called "ARCHIVEID" it would be called a sensible lowercase string to identify this repository.

  • eprints3/archives/ARCHIVEID
    • cfg/ - The repository configuration files.
    • documents/ - Uploaded documents. Also contains per-record files such as full-text caches, thumbnails and revision history.
    • html/ - The website for this repository. Do not edit by hand.
    • var/ - Files generated by eprints specific to this repository

As you add bespoke features to your repository, you may need (or if you install EPrints Bazaar plugins will have) extra sub-directories in this directory:

  • bin/ - For scripts you may need to run against the repository archive (e.g. as a cron job).
  • cgi/ - Bespoke CGI scripts that can be accessed from the cgi path of the web interface (e.g. https://eprints.example.org/cgi/). If you want to override existing CGI script as you require bespoke changes, you will need to copy them to the equivalent location in this directory and edit them here.
  • ssl/ - For adding a securevhost.conf to provide HTTPS Apache configuration for your repository archive.