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.
We recommend installing the Backend first, as the Frontend requires a valid Backend to run properly.
These installation instructions are a work-in-progress and based heavily on the DSpace 6.x installation instructions. Feedback or improvements are welcome. |
UNIX-like OS or Microsoft Windows
Java JDK 11 (OpenJDK or Oracle JDK)
Apache Maven 3.3.x or above (Java build tool)Maven is necessary in the first stage of the build process to assemble the installation package for your DSpace instance. It gives you the flexibility to customize DSpace using the existing Maven projects found in the [dspace-source]/dspace/modules directory or by adding in your own Maven project to build the installation package for DSpace, and apply any custom interface "overlay" changes. Maven can be downloaded from http://maven.apache.org/download.html Configuring a Maven ProxyYou can configure a proxy to use for some or all of your HTTP requests in Maven. The username and password are only required if your proxy requires basic authentication (note that later releases may support storing your passwords in a secured keystore‚ in the meantime, please ensure your settings.xml file (usually ${user.home}/.m2/settings.xml) is secured with permissions appropriate for your operating system). Example:
Apache Ant 1.8 or later (Java build tool)Apache Ant is required for the second stage of the build process (deploying/installing the application). First, Maven is used to construct the installer ( Ant can be downloaded from the following location: http://ant.apache.org Relational Database (PostgreSQL or Oracle)PostgreSQL v11 (with pgcrypto installed)
Oracle 10g or later
Apache Solr 7.2.1 or later (full-text index/search service)Solr can be obtained at the Apache Software Foundation site for Lucene and Solr. You may wish to read portions of the quick-start tutorial to make yourself familiar with Solr's layout and operation. Unpack a Solr .tgz or .zip archive in a place where you keep software that is not handled by your operating system's package management tools, and arrange to have it running whenever DSpace is running. You should ensure that Solr's index directories will have plenty of room to grow. You should also ensure that port 8983 is not in use by something else, or configure Solr to use a different port. If you are looking for a good place to put Solr, consider It is not necessary to dedicate a Solr instance to DSpace, if you already have one and want to use it. Simply copy DSpace's cores to a place where they will be discovered by Solr. See below. Git (code version control)Currently, there is a known bug in DSpace where a third-party Maven Module expects For the time being, you can work around this problem by installing Git locally: https://git-scm.com/downloads |
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. |
UNIX-like OS or Microsoft Windows
Node.js (v10.x or v12.x)
Yarn (v1.x)
DSpace 7.x Backend (see above)
|
At this time, installation requires checking out the codebase via Git. In later Beta releases, we will provide prepackaged downloads. |
Download our "dspace-angular" application (which is the DSpace 7 user interface) using Git. All you should need to do is the steps in the "Quick Start" at: https://github.com/DSpace/dspace-angular/#quick-start
# clone the repo git clone https://github.com/DSpace/dspace-angular.git # change directory to our repo cd dspace-angular # install the local dependencies yarn install |
[dspace-angular]/config/environment.default.js
configuration file, pointing it at your installed DSpace Backend. For example:// This example is valid if your Backend is running at http://localhost:8080/server/ rest: { ssl: false, host: 'localhost', port: 8080, // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript nameSpace: '/server/api' } |
Start the application
# build and start the application yarn start |