Contribute to the DSpace Development Fund

The newly established DSpace Development Fund supports the development of new features prioritized by DSpace Governance. For a list of planned features see the fund wiki page.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »



Installation Overview

As of version 7 (and above), the DSpace application is split into a "frontend" (User Interface) and a "backend" (Server API).  Most institutions will want to install BOTH.  However, you can decide whether to run them on the same machine or separate machines.

  • The DSpace Frontend consists of a User Interface built on Angular.io.  It cannot be run alone, as it requires a valid DSpace Backend to function.  The frontend provides all user-facing functionality
  • The DSpace Backend consists of a Server API ("server" webapp), built on Spring Boot.  It can be run standalone, however it has no user interface.  The backend provides all machine-based interfaces, including the REST API, OAI-PMH, SWORD (v1 and v2) and RDF.

Installing the Frontend (User Interface)

Work in progress (Feedback welcome)

These installation instructions are a work-in-progress.  They do NOT yet include production-ready installation scenarios for running the (Angular) frontend via production tools like PM2 or Passenger.  Feedback or improvements are welcome.

Frontend Requirements

UNIX-like OS or Microsoft Windows

  • UNIX-like OS (Linux, HP/UX, Mac OSX, etc.) : Many distributions of Linux/Unix come with some of the dependencies below pre-installed or easily installed via updates.  You should consult your particular distribution's documentation or local system administrators to determine what is already available.
  • Microsoft Windows:  While DSpace can be run on Windows servers, most institutions tend to run it on a UNIX-like OS.  However, we've added notes

Node.js (v10.x or v12.x)

  • Node.js can be found at https://nodejs.org/.  We recommend running a Long Term Support (LTS) version (latest is 12.x).  Non-LTS versions are not recommended.
  • Node.js is a Javascript runtime that also provides npm (Node Package Manager). It is used to both build and run the frontend.

Yarn (v1.x)

DSpace 7.x Backend (see below)

  • The DSpace Frontend cannot function without an installed DSpace Backend.  Follow the instructions below.

Frontend Installation

At this time, installation requires checking out the codebase via Git.  In later Beta releases, we will provide prepackaged downloads.

# clone the repo
git clone https://github.com/DSpace/dspace-angular.git

# change directory to our repo
cd dspace-angular

# Checkout the "preview" release branch
git checkout preview

# install the local dependencies
yarn install

# start the server
yarn start

Installing the Backend (Server API)

  • No labels

All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license, unless otherwise noted.