Home

Welcome to the DSpace wiki!

Contents:

• Users
• Developers
• Installation
• List of guides

Users

If you are interested in using dspace, check out the part of wiki for users.

Developers

Check out Developing frontend and Developing-backend and Developing dev-5

About the composition of this project

Dspace consists of several parts. First of all it is

• Dspace backend (this repo)
• Dspace frontend

Both of those parts have installation and usage manual in this wiki in Installation

Then there is Python REST API. It can be used for data import to running dspace, tests and in general any interaction with running DSpace instance. It uses DSpace Python REST Client Library created for Vanilla DSpace.

Extensive instructions are written in README of that project. However, short instructions for import follow:

• update const.py and import_db_const.py with proper paths, passwords etc.
• manually copy assetstore folder into new dspace installation under <docker-installation-folder>\assetstore (usually /dspace/assetstore).
• use docker build -t dspace_import . && docker run --name dspacedataimport dspace_import to run data pump.

Tasks that could be used in smoke tests:

This list is basically a filtered version of https://wiki.lyrasis.org/display/DSDOC7x/Command+Line+Operations#CommandLineOperations-Generaluse

All commands are used as first argument of ./dspace script, e.g. ./dspace checker

Good candidates:

• checker: Run the checksum checker
• cleanup: Remove deleted bitstreams from the assetstore
• create-administrator: Create a DSpace administrator account (see Installing DSpace)
• curate: Perform curation tasks on DSpace objects
• database: Perform various tasks / checks of the DSpace database
• dsprop: View the value of a DSpace property from any configuration file (see [Configuration Reference]- (https://wiki.lyrasis.org/display/DSDOC7x/Configuration+Reference))
• dsrun: Run a (DSpace) Java class directly (used mainly for test purposes)
• export: Export items or collections
• filter-media: Perform the media filtering to extract full text from documents and to create thumbnails
• generate-sitemaps: Generate search engine and html sitemaps (see Search Engine Optimization)
• harvest: Manage the OAI-PMH harvesting of external collections (see OAI harvesting docs)
• import: Import items into DSpace (see Importing and Exporting Items via Simple Archive Format)
• index-discovery: Update Discovery (Solr) search and browse Index
• itemupdate: Item update tool for altering metadata and bitstream content in items (see Updating Items via Simple Archive Format)
• make-handle-config: Run the handle server simple setup command
• metadata-export: Export metadata for batch editing
• metadata-import: Import metadata after batch editing
• oai: OAI script manager process-cleaner: Delete old Processes from the system
• registry-loader: Load entries into a registry (see Metadata and Bitstream Format Registries)
• structure-builder: Build DSpace community and collection structure (see Exporting and Importing Community and Collection Hierarchy)
• update-handle-prefix: Update handle records and metadata when moving from one Handle prefix to another
• user: Create, List, Update, Delete EPerson (user) records
• validate-date: Test date-time format rules
• version: Show DSpace version and other troubleshooting information

Can be used but not relevant for us:

• classpath: Calculate and display the DSpace classpath
• index-authority: import authorities and keep SOLR authority index up to date
• sub-daily: Send daily subscription notices
• rdfizer: tool to convert contents to RDF

Hard to use in dev environment:

• bitstore-migrate: Migrate all files (bitstreams) from one assetstore (bitstore) to another
• checker-emailer: Send emails related to the checksum checker
• community-filiator: Tool to manage community and sub-community relationships
• migrate-embargo: Embargo manager tool used to migrate old version of Embargo to the new one included in dspace3
• embargo-lifter: Pre DSpace 3.0 embargo manager tool used to check, list and lift embargoes
• read : execute a stream of commands from a file or pipe
• test-email: Test the DSpace email server settings are OK

Undecided:

• doi-organiser: Transmit information about DOIs to the registration agency.
• packager: Execute a packager