Page History

UNIX-like OS or Microsoft Windows

• UNIX-like operating system (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 operating system.

Node.js (

v16.x or

v18.x)

• Node.js can be found at https://nodejs.org/.  It may be available through your Linux distribution's package manager.  We recommend running a Long Term Support (LTS) version (even numbered releases).  Non-LTS versions (odd numbered releases) 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.
• NOTE: Node v12 v14 also will should work. However, that version is now nearing end-of-life. We recommend updating to Node 14 16 or 1618.

Yarn (v1.x)

• Yarn v1.x is available at https://classic.yarnpkg.com/.  It can usually be install via NPM (or through your Linux distribution's package manager).  We do NOT currently support Yarn v2.

  Code Block
  # You may need to run this command using "sudo" if you don't have proper privileges npm install --global yarn

  
  

• Yarn is used to build the frontend.

PM2 (or another Process Manager for Node.js apps) (optional, but recommended for Production)

• In Production scenarios, we highly recommend starting/stopping the User Interface using a Node.js process manager. There are several available, but our current favorite is PM2.  The rest of this installation guide assumes you are using PM2.

• PM2 is very easily installed via NPM

  Code Block
  # You may need to run this command using "sudo" if you don't have proper privileges npm install --global pm2

  
  

DSpace 7.x Backend (see above)

• The DSpace User Interface (Frontend) cannot function without an installed DSpace Backend.  Follow the instructions above.
• The Frontend and Backend do not need to be installed on the same machine/server.  They may be installed on separate machines as long as the two machines can connect to one another via HTTP or HTTPS.