Versions Compared

Old Version 5

changes.mady.by.user Carolyn Sullivan

Saved on

compared with

New Version 6

changes.mady.by.user Carolyn Sullivan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Minor edits to wording

...

  1. Install Git Bash & verify the installation by running "git version" from Command Prompt or Powershell
  2. No need to authenticate with Github credentials.


Installing Backend

3-step process (details in table below): 

  1. Cloning the GitHub repository
  2. Getting the DSPace DSpace Backend images from the Docker Registry
  3. Starting the Docker Backend Containers

...

ActionsCommand linePurposeSoftware
Clone the backend codebase


Code Block
# Run from command-line where ever you want the "DSpace" directory of code to be created.
gh repo clone DSpace/DSpace
 
# Once downloaded, change into that directory
cd DSpace


Before cloning carefully select your parent folder.

Getting all the files needed to run DSpace Backend.

This downloads all the code from https://github.com/DSpace/DSpace into a local directory named "DSpace".

Git


Start Docker Desktop

If it is not already running, start Docker Desktop on your machine. It MUST be running for any "docker-compose" or "docker" commands to work.

    1. On Windows, if Docker Desktop is running, you'll see the Docker whale logo in your taskbar's notification area.
Docker
Pull down the latest backend images


Code Block
# This command should be run from the "DSpace" code directory
docker-compose -f docker-compose.yml -f docker-compose-cli.yml pull


Pull down the latest backend images from DockerHub. This downloads all the prebuilt Docker images so you don't need to rebuild them locally.Docker commande command line

Start the Docker DSpace Backend Containers (& automatically install our Entities Test Data)



Code Block
# First start the backend with the test data
docker-compose -p d7 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml up -d

# [OPTIONNAL] Run "logs -f" to watch the logs for everything to start up.  
docker-compose -p d7 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml logs -f
# (Click Ctrl+C to exit logs view)


This command create creates the 3 Docker containers for the Backend (dspacedb for the database ; dspacesolr for the solr indexes ; dspace for the backend server ; angular for the frontend UI) and then start starts them up. 

Warning: dspacebd is the only Docker container that is not started automatiqualy automatically (the 2 two others, dspacesolr and dspace, are)


The backend will be started with the test data and can may take a few minutes. It should be completed before moving to the next action.

# Wait a few minutes until http://localhost:8080/server/ responds.



Docker commande command line
Download, install and reindex the test data assestore (of files)


Code Block
# Finally, download the test data assestore (of files) and install it, reindexing all content
docker-compose -p d7 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.assetstore.yml run dspace-cli



Docker commande line

Check system is up and running


DONE!

At this point, you should be able to go to http://localhost:8080/server/ and see a backend similar to https://api7.dspace.org/server/

    1. You should also see some test data in that backend. For example, clicking on the "collections" endpoint should return some Collections: http://localhost:8080/server/#http://localhost:8080/server/api/core/collections


Web browser (http://localhost:8080/server/ )

The Hal Browser page is displayed

...