Skip to content

Commit 62ea381

Browse files
committed
Update references to DSpace version
All READMEs should point to the latest release (currently DSpace 9).
1 parent 8503172 commit 62ea381

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ Please be aware that, as a Java web application, DSpace requires a database (Pos
3939
and a servlet container (usually Tomcat) in order to function.
4040
More information about these and all other prerequisites can be found in the Installation instructions above.
4141

42-
## Running DSpace 8 in Docker
42+
## Running DSpace 9 in Docker
4343

4444
NOTE: At this time, we do not have production-ready Docker images for DSpace.
4545
That said, we do have quick-start Docker Compose scripts for development or testing purposes.
4646

47-
See [Running DSpace 8 with Docker Compose](dspace/src/main/docker-compose/README.md)
47+
See [Running DSpace 9 with Docker Compose](dspace/src/main/docker-compose/README.md)
4848

4949
## Contributing
5050

dspace/src/main/docker-compose/README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ docker compose -f docker-compose.yml -f docker-compose-cli.yml build --build-arg
7272
```
7373
Default is Java 11, but other LTS releases (e.g. 17) are also supported.
7474

75-
## Run DSpace 8 REST from your current branch
75+
## Run DSpace 9 REST from your current branch
7676
```
77-
docker compose -p d8 up -d
77+
docker compose -p d9 up -d
7878
```
7979

80-
## Run DSpace 8 REST and Angular from your branch
80+
## Run DSpace 9 REST and Angular from your branch
8181

8282
```
83-
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml up -d
83+
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml up -d
8484
```
8585
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.
8686

@@ -90,18 +90,18 @@ NOTE: This starts the UI in development mode. It will take a few minutes to see
9090

9191
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).
9292

93-
## Run DSpace 8 REST with a IIIF Image Server from your branch
93+
## Run DSpace 9 REST with a IIIF Image Server from your branch
9494
*Only useful for testing IIIF support in a development environment*
9595

9696
This command starts our `dspace-iiif` container alongside the REST API.
9797
That container provides a [Cantaloupe image server](https://cantaloupe-project.github.io/),
9898
which can be used when IIIF support is enabled in DSpace (`iiif.enabled=true`).
9999

100100
```
101-
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-iiif.yml up -d
101+
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-iiif.yml up -d
102102
```
103103

104-
## Run DSpace 8 REST and Shibboleth SP (in Apache) from your branch
104+
## Run DSpace 9 REST and Shibboleth SP (in Apache) from your branch
105105
*Only useful for testing Shibboleth in a development environment*
106106

107107
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
136136
3. Build the Shibboleth container (if you haven't built or pulled it before):
137137
```
138138
cd [dspace-src]
139-
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml build
139+
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml build
140140
```
141141

142142
4. Start all containers, passing your public hostname as the `DSPACE_HOSTNAME` environment variable:
143143
```
144-
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
144+
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
145145
```
146146
NOTE: For Windows you MUST either set the environment variable separately, or use the 'env' command provided with Git/Cygwin
147147
(you may already have this command if you are running Git for Windows). See https://superuser.com/a/1079563
148148
```
149-
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
149+
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
150150
```
151151

152152
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
174174
```
175175
* Spin up the `dspace-angular` container alongside the others, e.g.
176176
```
177-
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
177+
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
178178
```
179-
## Run DSpace 8 REST and Matomo from your branch
179+
## Run DSpace 9 REST and Matomo from your branch
180180
181181
_Only useful for testing Matomo in a development environment_
182182
@@ -219,12 +219,12 @@ Prerequisites
219219

220220
Create an admin account. By default, the dspace-cli container runs the dspace command.
221221
```
222-
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
222+
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
223223
```
224224
225225
Download a Zip file of AIP content and ingest test data
226226
```
227-
docker compose -p d8 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.ingest.yml run --rm dspace-cli
227+
docker compose -p d9 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.ingest.yml run --rm dspace-cli
228228
```
229229
230230
### Ingest Entities Test Data
@@ -238,12 +238,12 @@ Prerequisites
238238
239239
Start DSpace REST with a postgres database dump downloaded from the internet.
240240
```
241-
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml up -d
241+
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml up -d
242242
```
243243
244244
Download an assetstore from a tar file on the internet.
245245
```
246-
docker compose -p d8 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.assetstore.yml run dspace-cli
246+
docker compose -p d9 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.assetstore.yml run dspace-cli
247247
```
248248
249249
## Modify DSpace Configuration in Docker
@@ -257,20 +257,20 @@ Many DSpace configuration settings will reload automatically (after a few second
257257
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:
258258
259259
```
260-
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli [command] [parameters]
260+
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli [command] [parameters]
261261
```
262262
263263
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:
264264
265265
```
266-
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
266+
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
267267
```
268268
269269
Similarly, you can see the value of any DSpace configuration (in local.cfg or dspace.cfg) by running:
270270
271271
```
272272
# Output the value of `dspace.ui.url` from running Docker instance
273-
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli dsprop -p dspace.ui.url
273+
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli dsprop -p dspace.ui.url
274274
```
275275
276276
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
279279
# Run the "./dspace database clean" command from the "dspace" container
280280
# Before doing so, it sets "db.cleanDisabled=false".
281281
# WARNING: This will delete all your data. It's just an example of how to do so.
282-
docker compose -p d8 exec -e "db__P__cleanDisabled=false" dspace /dspace/bin/dspace database clean
282+
docker compose -p d9 exec -e "db__P__cleanDisabled=false" dspace /dspace/bin/dspace database clean
283283
```
284284
285285
## 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
297297
1. First, you must start up the older PostgreSQL image (to dump your existing data to a `*.sql` file)
298298
```
299299
# This command assumes you are using the process described above to start all your containers
300-
docker compose -p d8 up -d
300+
docker compose -p d9 up -d
301301
```
302302
* If you've already accidentally updated to the new PostgreSQL image, you have a few options:
303303
* 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
306306
# This command will rebuild using PostgreSQL v11 & tag it locally as "latest"
307307
docker build --build-arg POSTGRES_VERSION=11 -t dspace/dspace-postgres-pgcrypto:latest ./dspace/src/main/docker/dspace-postgres-pgcrypto/
308308
# Then restart container with that image
309-
docker compose -p d8 up -d
309+
docker compose -p d9 up -d
310310
```
311311
2. Dump your entire "dspace" database out of the old "dspacedb" container to a local file named `pgdump.sql`
312312
```
@@ -329,12 +329,12 @@ Here's how to fix those issues by migrating your old Postgres data to the new ve
329329
3. Now, stop all existing containers. This shuts down the old version of PostgreSQL
330330
```
331331
# This command assumes you are using the process described above to start/stop all your containers
332-
docker compose -p d8 down
332+
docker compose -p d9 down
333333
```
334334
4. Delete the `pgdata` volume. WARNING: This deletes all your old PostgreSQL data. Make sure you have that `pgdump.sql` file FIRST!
335335
```
336-
# Assumes you are using `-p d8` which prefixes all volumes with `d8_`
337-
docker volume rm d8_pgdata
336+
# Assumes you are using `-p d9` which prefixes all volumes with `d9_`
337+
docker volume rm d9_pgdata
338338
```
339339
5. Now, pull down the latest PostgreSQL image with the NEW version of PostgreSQL.
340340
```
@@ -345,12 +345,12 @@ using the local `./pgdump.sql` file. IMPORTANT: If you renamed that "pgdump.sql"
345345
then you MUST change the name/directory in the `db.restore.yml` script.
346346
```
347347
# Restore database from "./pgdump.sql" (this path is hardcoded in db.restore.yml)
348-
docker compose -p d8 -f docker-compose.yml -f dspace/src/main/docker-compose/db.restore.yml up -d
348+
docker compose -p d9 -f docker-compose.yml -f dspace/src/main/docker-compose/db.restore.yml up -d
349349
```
350350
7. Finally, reindex all database contents into Solr (just to be sure Solr indexes are current).
351351
```
352352
# Run "./dspace index-discovery -b" using our CLI image
353-
docker compose -p d8 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
353+
docker compose -p d9 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
354354
```
355355
At this point in time, all your old database data should be migrated to the new Postgres
356356
and running at http://localhost:8080/server/

0 commit comments

Comments
 (0)