Page History
...
- New Angular UI that is modern, responsive, and built using a Bootstrap theme for easy customization. See demo site at https://demo7demo.dspace.org/
- A completely redesigned REST API that is self-documenting and human browsable. See demo site at https://api7demo.dspace.org/server/
- Redesigned submissions and workflows featuring a one page submission process with a drag-and-drop interface and newly redesigned MyDSpace.
- Configurable entities, an optional new item type inspired by the DSpace-CRIS project that allows for complex linked relationships between items. DSpace 7 will include the option to implement this feature for two use cases popular with the DSpace community:
- Journal Hierarchy: create and link objects for a Journal, Volume, Issue, Article, and Author
- Faculty & Organizational Units: a lightweight, CRIS-like option to represent Projects, Faculty, Department/Unit, Publication, etc.
- A deep-dive into Configurable Entities can be found in the DSpace 7 Configurable Entities early documentation (Google Doc)
- Configurable entities help to better align DSpace with Next Generation Repository recommendations related to Identifiers as well as alignment with OpenAIRE v4.
...
- DSpace 7 User Interface Demo: https://demo7demo.dspace.org/ (Login: dspacedemo+admin@gmail.com , Password: dspace)
- DSpace 7 REST API Demo: https://api7demo.dspace.org/server/ (Login: dspacedemo+admin@gmail.com , Password: dspace)
- REST Contract / Documentation is available at: https://github.com/DSpace/RestContract/blob/master/README.md#readme
Keep in mind, our User Interface Demo uses the REST API Demo as the backend. So, any content created (by anyone) will immediately appear in both locations.
...
- Install via Docker (Recommended if you just want to try it out quickly for dev/test environments) - 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 (Required for Production). This is a fully local installation. The UI and REST API need not be installed on the same server.
Install via Docker
Warninginfo | |||
---|---|---|---|
| |||
The below instructions provide a quick way to start up both the User Interface and REST API in a Docker environment. However, if you are already familiar with Docker or plan to use it more heavily, you may wish to also review our detailed Docker Compose instructions for both the frontend (User Interface) and backend (REST API)The Docker resources/images provided by the DSpace community are built for development/testing only. Therefore, they may not be fully secured or up-to-date, and should not be used in production. |
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). OS, or Linux). Keep in mind, this setup will REQUIRE at least 6GB of memory allocated for Docker. However, 8GB is recommended, if you have it available.
- First, install the necessary prerequisites: Docker and Git
- On Windows 10:
- Install Docker Desktop for Windows
- Install Git Bash & verify the installation by running "
git version
" from Command Prompt or Powershell
- On Mac OS:
- Install Docker Desktop for Mac
- Git may already be installed. Run "
git version
" from your terminal to see if it's available. If Git is not yet installed, you will be prompted to install developer tools. If that approach doesn't work, Git may also be downloaded.
- On Linux:
- Install Docker Engine for your Linux OS
- Git may already be installed. Run "
git version
" to check for it. If it is not installed, install Git using your package manager (e.g.sudo apt-get install git
)
- On Windows 10:
- Next, using Git, download (clone) the DSpace Angular UI codebase & move into that codebase directory
Code Block # Download the UI codebase git clone https://github.com/DSpace/dspace-angular.git # Move into the created codebase directory cd dspace-angular # Switch to the 7.x maintenance branch (latest 7.x code) git checkout dspace-7_x
- Using the Docker instructions in that codebase, start up both the DSpace 7 REST API and Angular UI via Docker
First, pull down the latest version of the Docker images (both frontend and backend):
Code Block docker compose -f docker/docker-compose.yml -f docker/docker-compose-composerest.yml pull
Optionally, you can choose to locally rebuild the Angular UI (This is only needed, if you want to try out local changes/customizations to that Angular UI. Otherwise, if you just want to run the default Angular UI, you can skip this step entirely.):
Code Block docker- compose -f docker/docker-compose.yml build
Finally, start up both the Angular UI and REST API via Docker:
Code Block docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
If you'd like to monitor the startup process, you can "tail" the logs using "logs -f":
Code Block docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml logs -f
- If anything goes wrong, occasionally a simple restart of the images will resolve it. Just do a "down" followed by an "up -d" again:
Code Block # Shut down everything docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml down # Restart everything docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
- At this point, you should be able to see a completely empty DSpace 7 site. You may now choose to either add test/demo content (see step #5 below) and/or add an initial Administrator account (see step #6 below).
- User Interface: http://localhost:4000/
- REST API: http://localhost:8080/server/
- Next, optionally, you can add test data to your Docker instance. We have two sets of test data available depending on what you want to test out. CHOOSE ONE.
[Option #1: Use AIP test data] We have a set of AIP (Archival Information Package) data which was exported from a DSpace 6.x instance. This test data is good to get a quick feel for the changes in DSpace 7 compared to DSpace 6. It's also the easiest to quickly import as we have an ingest script written for Docker using the "dspace-cli" container. Just run:
Code Block # If you don't have an Admin created with the email "test@test.edu", create it. The AIP ingest runs as that user by default. docker- compose -p d7 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en # This second command will import a batch of test/sample AIPs (see "cli.ingest.yml" for more info) docker- compose -p d7 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
- [Option #2: Use a database dump of Entities test data] Alternatively, if you'd like to instead test the new Configurable Entities features, we have a separate database dump which provides Entity test data. (This test data is not yet available in AIP format). Here's how you'd switch your Docker instance to using the Configurable Entities test data
First, you unfortunately need to completely shut down any running volumes and remove them. We will be replacing them with a database dump of Entity test data.
Code Block # Shut down the running containers docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml down # Remove ALL existing volumes docker volume rm $(docker volume ls -q) # NOTE: If you don't want to remove all volumes, you can also remove the volumes in two steps # First, list all volumes, and look for any that have a name starting with "d7". There likely will be 4. docker volume ls # Then, delete each volume (by name) one by one. docker volume rm [volume-name]
Now, let's recreate those containers with the Configurable Entities test data included:
Code Block # NOTE: the `db.entities.yml` here will startup a database image with Entities test data included (from a database dump) docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d # Optionally watch the logs of that command to make sure everything starts back up properly docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml logs -f # Finally, once started, also load up the Entities test "assetstore" (files) & trigger a reindex docker- compose -p d7 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
Finally, in order to have an initial login, let's create an initial Administrator account using the "dspace-cli" container:
Code Block # This example creates an Admin user with email "test@test.edu" and password "admin". # (You may have already created this user above, before loading AIP test data. If so, you can skip this) docker- compose -p d7 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
- After a few minutes, you should have a full local installation of DSpace 7 Preview (with test data).
- User Interface: http://localhost:4000/
- REST API: http://localhost:8080/server/
- Admin Login: (whatever login you setup via the "dspace-cli" command above)
- 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).
Once you are done testing, you can stop Docker and clean up the data (deleting the volumes).
Code Block # Shut down the running containers docker- compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml down # Remove all volumes, images, etc (This removes all the existing data and images) docker system prune --volumes
...
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://api7demo.dspace.org/server/) 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 (v12.x , v14.x or v16.x) is required.
- 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) package manage. Just install the latest stable version of 1.x
- Git is required. If you do not already have it installed (try running
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
Code Block # clone the repo git clone https://github.com/DSpace/dspace-angular.git # change directory to our repo cd dspace-angular # Switch to the 7.x maintenance branch (latest 7.x code) git checkout dspace-7_x # 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:4000/
- REST API (remote demo site): https://api7demo.dspace.org/server/
- Admin Login: dspacedemo+admin@gmail.com, Password: dspace
- Submitter Login: dspacedemo+submit@gmail.com, 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
...