DSpace 7.1 Installation

DSpace7.1 Install

DSpace 7.1 Installation


For this Preview release, we offer three different ways to install / run DSpace 7 locally.  The route you choose may depend on exactly what you'd like to try out.  Choose ONE of the following:

Install via Docker (Recommended for most)- This is the easiest/quickest way to get everything running locally (no matter your technical skills).  We even have a script to automatically load some test data and test accounts into your Docker instance.

Install the User Interface only, while using the demo REST API backend - This is the easiest way to try out just the User Interface locally.  Keep in mind, by default, the User Interface will be installed to use our DSpace 7 REST API Demo as a backend.  Therefore, you will be interacting with the content on that demo site and will need to use the login information for the demo site (see above)

Install both the User Interface and REST API locally (bring your own test content).  This is a fully manual local installation. Keep in mind this installation process is may still change slightly before the final 7.0 release.


Install via Docker

Running DSpace 7 via Docker allows you to quickly & easily install and start up all the "parts" of DSpace (database, Solr index, REST API, user interface) without having to install them all yourself.  This will work on any operating system (Windows 10, Mac OS, or Linux). 

Install the User Interface only

Running only the DSpace 7 user interface can be done quickly & easily on any operating system (Windows, Mac OS, or Linux).  By default, the installed user interface will use the DSpace 7 REST API Demo (https://dspace7.4science.cloud/dspace-spring-rest/) as its backend.  This means that you will immediately see test data (from that demo site) and be able to interact with it.  However, you will need to authenticate using the REST API Demo account. Any changes you make will also obviously appear on that shared REST API Demo site.


First, you will need to install the necessary prerequisites.

Git is required.  If you do not already have it installed (try running git version at your command line), you can install it via https://git-scm.com/downloads (or via your local package manager tools for Linux or Mac OS)

Node.js (v8.x or above) is required. Installing the latest LTS (Long Term Support) version, currently 10.x, is perfectly fine.

NPM (v5.x or above) is required.  Don't worry, this gets installed with Node.js though, so you don't need to do anything extra here.

Yarn (v1.x or above) package manage.  Just install the latest stable version (currently 1.16.x).

Then, download our "dspace-angular" application (which is the DSpace 7 user interface) and run it.  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
 
# Checkout the "preview" release branch
git checkout preview
 
# install the local dependencies
yarn install
 
# start the server
yarn start


After a few minutes, the user interface will be running on your local machine.  Again, it will be accessing the REST API Demo site, so a stable internet connection is required.

User Interface: http://localhost:3000/

REST API (remote demo site): https://dspace7.4science.cloud/dspace-spring-rest/

Admin Login: [email protected], Password: dspace

Submitter Login: [email protected], Password: dspace

Objects/Pages of interest (within the test data):

Journal Example represents a journal with journal volumes, issues and articles, as detailed in the Configurable Entities Design.

Publications Example contains publications which contain a combination of plain-text authors and related author entities. It also contains relations to Research Projects and Organizational Units, as detailed in the Configurable Entities design. Navigating to e.g. a Person will reveal their relations to Publications, Research Projects and Organizational Units.

Submission/Workflow functionality can be tested using one of the collections in this community where the workflow is enabled. You can use the accounts mentioned above to perform the submission and workflow steps. The admin account can perform the submission and all workflow steps as well.

Once logged in, MyDSpace functionality is found in the user menu (upper right).  Submissions can be started from that page, or via the "New → Item" admin menu (if logged in as an Admin)

One you are done testing, you can stop the locally running DSpace 7 user interface via Ctrl+C


Install both the User Interface and REST API locally

This installation process describes manually installing both the frontend (User Interface) and backend (REST API) of DSpace 7 on a local machine. The frontend and backend need not be installed on the same machine.

Keep in mind the installation process here may change prior to DSpace 7.0 final. This should be considered an early version of the installation process.

First, install the User Interface and ensure it is successfully running against the REST API Demo site.  See the instructions under Install the User Interface only (above).  Remember, you can choose to install this on the same machine as the REST API, or on an entirely different machine.

Then, install the REST API.  The REST API installation process is very similar to the installation process for DSpace 6 or below (so if you are familiar with installing DSpace already, this will be familiar to you).

Required Prerequisites for the DSpace 7 REST API are listed at Installing DSpace#PrerequisiteSoftware.  These include:

Java JDK 8 (OpenJDK or Oracle). OpenJDK is recommended. (Note: Java 7 is no longer supported.)

Apache Maven 3.3.x or above.

Apache Ant 1.8 or above.

Relational Database. Either PostgreSQL 9.4 (or above) or Oracle 10g (or above)

Servlet Engine. Apache Tomcat 8 (or above) is recommended.

Apache Solr 7.2.1 or above.  (NOTE: This is a new requirement for DSpace 7. You MUST install Solr separately from DSpace as it is no longer provided out-of-the-box.)

Installation is very similar to that of DSpace 6.x.  Draft installation instructions for the DSpace 7 REST API are available at Installing DSpace#Installation

Pay close attention to a new installation step (#11 in that list).  Because Solr is now a separate install, you need to copy the DSpace Solr core configurations into your Apache Solr installation location.

If you have an existing test/demo version of DSpace 6.x locally, you can optionally choose to upgrade it to the DSpace 7 Preview Release.  DO NOT DO THIS IN PRODUCTION AS THE UPGRADE IS EXPERIMENTAL AT THIS TIME.

Keep in mind, your old UI changes will not be upgraded as the XMLUI and JSPUI no longer exist in DSpace 7.  Therefore, only your data (in your database and assetstore) will be upgraded.

To upgrade your data, Install the DSpace 7 REST API (as noted above) on top of a copy of your existing DSpace 6.x test/demo instance. We highly recommend doing this upgrade on a copy of your DSpace 6.x instance, as you cannot "undo" it. (NOTE: Make sure you are running a valid version of all prerequisites, and have installed Solr separately) 

You will also need to perform step #11 in the Installation instructions (see above) in order to configure your Apache Solr installation properly.

After you start up the DSpace 7 REST API, you will need to reindex all your content by running:  [dspace]/bin/dspace index-discovery -b 

NOTE: At this time we are NOT yet able to upgrade DSpace 6.x (or below) Solr statistics.  A procedure for that upgrade will be coming in the future.

Once it is running locally, your REST API should be available at: http://localhost:8080/spring-rest

This assumes you are running Tomcat on port 8080 (which is its default port)

Once both the User Interface and REST API are installed, you will need to point your locally running User Interface at your REST API

In the locally installed dspace-angular project folder, modify the [dspace-angular]/config/environment.default.js configuration to point at your local REST API.  The below settings assume your REST API is available at http://localhost:8080/spring-rest 


// The REST API server settings.
rest: {
ssl: false,
host: 'localhost',
port: 8080,
// NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
nameSpace: '/spring-rest/api'
}

Alternatively, if you want, you can copy the "environment.default.js" to a new file called "environment.prod.js" and modify that new file.

After the update is made, restart your User Interface by running: yarn start

At this point your local UI should be using your local REST API

User Interface: http://localhost:3000/

REST API: https://localhost:8080/spring-rest/

Admin Login:  You can create one on the REST API server by running [dspace]/bin/dspace create-administrator from the command-line (this same command was used in DSpace 6.x)