hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 01:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update references to DSpace version

Browse Source 
All READMEs should point to the latest release (currently DSpace 9).
This commit is contained in:
Alan Orth
2025-06-27 13:31:38 +03:00
parent 850317213a
commit 62ea3815ae
2 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -39,12 +39,12 @@ Please be aware that, as a Java web application, DSpace requires a database (Pos
and a servlet container (usually Tomcat) in order to function.
More information about these and all other prerequisites can be found in the Installation instructions above.
## Running DSpace 8 in Docker
## Running DSpace 9 in Docker
NOTE: At this time, we do not have production-ready Docker images for DSpace.
That said, we do have quick-start Docker Compose scripts for development or testing purposes.
See [Running DSpace 8 with Docker Compose](dspace/src/main/docker-compose/README.md)
See [Running DSpace 9 with Docker Compose](dspace/src/main/docker-compose/README.md)
## Contributing

54
dspace/src/main/docker-compose/README.md
View File

@@ -72,15 +72,15 @@ docker compose -f docker-compose.yml -f docker-compose-cli.yml build --build-arg
```
Default is Java 11, but other LTS releases (e.g. 17) are also supported.
## Run DSpace 8 REST from your current branch
## Run DSpace 9 REST from your current branch
```
docker compose -p d8 up -d
docker compose -p d9 up -d
```
## Run DSpace 8 REST and Angular from your branch
## Run DSpace 9 REST and Angular from your branch
```
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml up -d
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml up -d
```
NOTE: This starts the UI in development mode. It will take a few minutes to see the UI as the Angular code needs to be compiled.
@@ -90,7 +90,7 @@ NOTE: This starts the UI in development mode. It will take a few minutes to see
See documentation in [DSpace User Interface Docker instructions](https://github.com/DSpace/dspace-angular/blob/main/docker/README.md#run-dspace-rest-and-dspace-angular-from-local-branches).
## Run DSpace 8 REST with a IIIF Image Server from your branch
## Run DSpace 9 REST with a IIIF Image Server from your branch
*Only useful for testing IIIF support in a development environment*
This command starts our `dspace-iiif` container alongside the REST API.
@@ -98,10 +98,10 @@ That container provides a [Cantaloupe image server](https://cantaloupe-project.g
which can be used when IIIF support is enabled in DSpace (`iiif.enabled=true`).
```
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-iiif.yml up -d
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-iiif.yml up -d
```
## Run DSpace 8 REST and Shibboleth SP (in Apache) from your branch
## Run DSpace 9 REST and Shibboleth SP (in Apache) from your branch
*Only useful for testing Shibboleth in a development environment*
This Shibboleth container uses https://samltest.id/ as an IdP (see `../docker/dspace-shibboleth/`).
@@ -136,17 +136,17 @@ The remainder of these instructions assume you are using ngrok (though other pro
3. Build the Shibboleth container (if you haven't built or pulled it before):
```
cd [dspace-src]
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml build
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml build
```
4. Start all containers, passing your public hostname as the `DSPACE_HOSTNAME` environment variable:
```
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
```
NOTE: For Windows you MUST either set the environment variable separately, or use the 'env' command provided with Git/Cygwin
(you may already have this command if you are running Git for Windows). See https://superuser.com/a/1079563
```
env DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
env DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
```
5. Finally, for https://samltest.id/, you need to upload your Shibboleth Metadata for the site to "trust" you.
@@ -174,9 +174,9 @@ The remainder of these instructions assume you are using ngrok (though other pro
```
* Spin up the `dspace-angular` container alongside the others, e.g.
```
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
```
## Run DSpace 8 REST and Matomo from your branch
## Run DSpace 9 REST and Matomo from your branch
_Only useful for testing Matomo in a development environment_
@@ -219,12 +219,12 @@ Prerequisites
Create an admin account. By default, the dspace-cli container runs the dspace command.
```
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
```
Download a Zip file of AIP content and ingest test data
```
docker compose -p d8 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.ingest.yml run --rm dspace-cli
docker compose -p d9 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.ingest.yml run --rm dspace-cli
```
### Ingest Entities Test Data
@@ -238,12 +238,12 @@ Prerequisites
Start DSpace REST with a postgres database dump downloaded from the internet.
```
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml up -d
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml up -d
```
Download an assetstore from a tar file on the internet.
```
docker compose -p d8 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.assetstore.yml run dspace-cli
docker compose -p d9 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.assetstore.yml run dspace-cli
```
## Modify DSpace Configuration in Docker
@@ -257,20 +257,20 @@ Many DSpace configuration settings will reload automatically (after a few second
While the Docker containers are running, you can use the DSpace CLI image to run any DSpace commandline script (i.e. any command that normally can be run by `[dspace]/bin/dspace`). The general format is:
```
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli [command] [parameters]
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli [command] [parameters]
```
So, for example, to reindex all content in Discovery, normally you'd run `./dspace index-discovery -b` from commandline. Using our DSpace CLI image, that command becomes:
```
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
```
Similarly, you can see the value of any DSpace configuration (in local.cfg or dspace.cfg) by running:
```
# Output the value of `dspace.ui.url` from running Docker instance
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli dsprop -p dspace.ui.url
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli dsprop -p dspace.ui.url
```
NOTE: It is also possible to run CLI scripts directly on the "dspace" container (where the backend runs)
@@ -279,7 +279,7 @@ This can be useful if you want to pass environment variables which override DSpa
# Run the "./dspace database clean" command from the "dspace" container
# Before doing so, it sets "db.cleanDisabled=false".
# WARNING: This will delete all your data. It's just an example of how to do so.
docker compose -p d8 exec -e "db__P__cleanDisabled=false" dspace /dspace/bin/dspace database clean
docker compose -p d9 exec -e "db__P__cleanDisabled=false" dspace /dspace/bin/dspace database clean
```
## Upgrading PostgreSQL in Docker
@@ -297,7 +297,7 @@ Here's how to fix those issues by migrating your old Postgres data to the new ve
1. First, you must start up the older PostgreSQL image (to dump your existing data to a `*.sql` file)
```
# This command assumes you are using the process described above to start all your containers
docker compose -p d8 up -d
docker compose -p d9 up -d
```
* If you've already accidentally updated to the new PostgreSQL image, you have a few options:
* Pull down an older version of the image from Dockerhub (using a tag)
@@ -306,7 +306,7 @@ Here's how to fix those issues by migrating your old Postgres data to the new ve
# This command will rebuild using PostgreSQL v11 & tag it locally as "latest"
docker build --build-arg POSTGRES_VERSION=11 -t dspace/dspace-postgres-pgcrypto:latest ./dspace/src/main/docker/dspace-postgres-pgcrypto/
# Then restart container with that image
docker compose -p d8 up -d
docker compose -p d9 up -d
```
2. Dump your entire "dspace" database out of the old "dspacedb" container to a local file named `pgdump.sql`
```
@@ -329,12 +329,12 @@ Here's how to fix those issues by migrating your old Postgres data to the new ve
3. Now, stop all existing containers. This shuts down the old version of PostgreSQL
```
# This command assumes you are using the process described above to start/stop all your containers
docker compose -p d8 down
docker compose -p d9 down
```
4. Delete the `pgdata` volume. WARNING: This deletes all your old PostgreSQL data. Make sure you have that `pgdump.sql` file FIRST!
```
# Assumes you are using `-p d8` which prefixes all volumes with `d8_`
docker volume rm d8_pgdata
# Assumes you are using `-p d9` which prefixes all volumes with `d9_`
docker volume rm d9_pgdata
```
5. Now, pull down the latest PostgreSQL image with the NEW version of PostgreSQL.
```
@@ -345,12 +345,12 @@ using the local `./pgdump.sql` file. IMPORTANT: If you renamed that "pgdump.sql"
then you MUST change the name/directory in the `db.restore.yml` script.
```
# Restore database from "./pgdump.sql" (this path is hardcoded in db.restore.yml)
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/db.restore.yml up -d
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/db.restore.yml up -d
```
7. Finally, reindex all database contents into Solr (just to be sure Solr indexes are current).
```
# Run "./dspace index-discovery -b" using our CLI image
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
```
At this point in time, all your old database data should be migrated to the new Postgres
and running at http://localhost:8080/server/