Skip to content

Commit 369d3e0

Browse files
committed
[DSC-2193] Update version references
1 parent 874add6 commit 369d3e0

File tree

7 files changed

+31
-31
lines changed

7 files changed

+31
-31
lines changed

docker-compose-cli.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
networks:
1010
# Default to using network named 'dspacenet' from docker-compose.yml.
11-
# Its full name will be prepended with the project name (e.g. "-p dcris24" means it will be named "dcris24_dspacenet")
11+
# Its full name will be prepended with the project name (e.g. "-p dcris25" means it will be named "dcris25_dspacenet")
1212
default:
1313
name: ${COMPOSE_PROJECT_NAME}_dspacenet
1414
external: true

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ services:
106106
# Initialize all DSpace Solr cores then start Solr:
107107
# * First, run precreate-core to create the core (if it doesn't yet exist). If exists already, this is a no-op
108108
# * Second, copy configsets to this core:
109-
# Updates to Solr configs require the container to be rebuilt/restarted: `docker compose -p dcris24 up -d --build dspacesolr`
109+
# Updates to Solr configs require the container to be rebuilt/restarted: `docker compose -p dcris25 up -d --build dspacesolr`
110110
entrypoint:
111111
- /bin/bash
112112
- '-c'

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

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@ Default is Java 11, but other LTS releases (e.g. 17) are also supported.
7070

7171
## Run DSpace-CRIS 2024_02_x REST from your current branch
7272
```
73-
docker compose -p dcris24 up -d
73+
docker compose -p dcris25 up -d
7474
```
7575

7676
## Run DSpace-CRIS 2024_02_x REST and Angular from your branch
7777

7878
```
79-
docker compose -p dcris24 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml up -d
79+
docker compose -p dcris25 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-angular.yml up -d
8080
```
8181
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.
8282

@@ -94,7 +94,7 @@ That container provides a [Cantaloupe image server](https://cantaloupe-project.g
9494
which can be used when IIIF support is enabled in DSpace-CRIS (`iiif.enabled=true`).
9595

9696
```
97-
docker compose -p dcris24 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-iiif.yml up -d
97+
docker compose -p dcris25 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-iiif.yml up -d
9898
```
9999

100100
## Run DSpace-CRIS 2024_02_x REST and Shibboleth SP (in Apache) from your branch
@@ -132,17 +132,17 @@ The remainder of these instructions assume you are using ngrok (though other pro
132132
3. Build the Shibboleth container (if you haven't built or pulled it before):
133133
```
134134
cd [dspace-src]
135-
docker compose -p dcris24 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml build
135+
docker compose -p dcris25 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml build
136136
```
137137

138138
4. Start all containers, passing your public hostname as the `DSPACE_HOSTNAME` environment variable:
139139
```
140-
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p dcris24 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
140+
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p dcris25 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
141141
```
142142
NOTE: For Windows you MUST either set the environment variable separately, or use the 'env' command provided with Git/Cygwin
143143
(you may already have this command if you are running Git for Windows). See https://superuser.com/a/1079563
144144
```
145-
env DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p dcris24 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
145+
env DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p dcris25 -f docker-compose.yml -f dspace/src/main/docker-compose/docker-compose-shibboleth.yml up -d
146146
```
147147

148148
5. Finally, for https://samltest.id/, you need to upload your Shibboleth Metadata for the site to "trust" you.
@@ -170,7 +170,7 @@ The remainder of these instructions assume you are using ngrok (though other pro
170170
```
171171
* Spin up the `dspace-angular` container alongside the others, e.g.
172172
```
173-
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p dcris24 -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
173+
DSPACE_HOSTNAME=[subdomain].ngrok.io docker compose -p dcris25 -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
174174
```
175175
176176
## Sample Test Data
@@ -185,12 +185,12 @@ Prerequisites
185185
186186
Create an admin account. By default, the dspace-cli container runs the dspace command.
187187
```
188-
docker compose -p dcris24 -f docker-compose-cli.yml run --rm dspace-cli create-administrator -e [email protected] -f admin -l user -p admin -c en
188+
docker compose -p dcris25 -f docker-compose-cli.yml run --rm dspace-cli create-administrator -e [email protected] -f admin -l user -p admin -c en
189189
```
190190
191191
Download a Zip file of AIP content and ingest test data
192192
```
193-
docker compose -p dcris24 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.ingest.yml run --rm dspace-cli
193+
docker compose -p dcris25 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.ingest.yml run --rm dspace-cli
194194
```
195195
196196
### Ingest Entities Test Data
@@ -204,39 +204,39 @@ Prerequisites
204204
205205
Start DSpace-CRIS REST with a postgres database dump downloaded from the internet.
206206
```
207-
docker compose -p dcris24 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml up -d
207+
docker compose -p dcris25 -f docker-compose.yml -f dspace/src/main/docker-compose/db.entities.yml up -d
208208
```
209209
210210
Download an assetstore from a tar file on the internet.
211211
```
212-
docker compose -p dcris24 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.assetstore.yml run dspace-cli
212+
docker compose -p dcris25 -f docker-compose-cli.yml -f dspace/src/main/docker-compose/cli.assetstore.yml run dspace-cli
213213
```
214214
215215
## Modify DSpace-CRIS Configuration in Docker
216216
While your Docker containers are running, you may directly modify any configurations under
217217
`[dspace-src]/dspace/config/`. Those config changes will be synced to the container.
218218
(This works because our `docker-compose.yml` mounts the `[src]/dspace/config` directory from the host into the running Docker instance.)
219219
220-
Many DSpace-CRIS configuration settings will reload automatically (after a few seconds). However, configurations which are cached by DSpace-CRIS (or by Spring Boot) may require you to quickly reboot the Docker containers by running `docker compose -p dcris24 down` followed by `docker compose -p dcris24 up -d`.
220+
Many DSpace-CRIS configuration settings will reload automatically (after a few seconds). However, configurations which are cached by DSpace-CRIS (or by Spring Boot) may require you to quickly reboot the Docker containers by running `docker compose -p dcris25 down` followed by `docker compose -p dcris25 up -d`.
221221
222222
## Running DSpace-CRIS CLI scripts in Docker
223223
While the Docker containers are running, you can use the DSpace-CRIS CLI image to run any DSpace-CRIS commandline script (i.e. any command that normally can be run by `[dspace]/bin/dspace`). The general format is:
224224
225225
```
226-
docker compose -p dcris24 -f docker-compose-cli.yml run --rm dspace-cli [command] [parameters]
226+
docker compose -p dcris25 -f docker-compose-cli.yml run --rm dspace-cli [command] [parameters]
227227
```
228228
229229
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:
230230
231231
```
232-
docker compose -p dcris24 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
232+
docker compose -p dcris25 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
233233
```
234234
235235
Similarly, you can see the value of any DSpace configuration (in local.cfg or dspace.cfg) by running:
236236
237237
```
238238
# Output the value of `dspace.ui.url` from running Docker instance
239-
docker compose -p dcris24 -f docker-compose-cli.yml run --rm dspace-cli dsprop -p dspace.ui.url
239+
docker compose -p dcris25 -f docker-compose-cli.yml run --rm dspace-cli dsprop -p dspace.ui.url
240240
```
241241
242242
NOTE: It is also possible to run CLI scripts directly on the "dspace" container (where the backend runs)
@@ -245,7 +245,7 @@ This can be useful if you want to pass environment variables which override DSpa
245245
# Run the "./dspace database clean" command from the "dspace" container
246246
# Before doing so, it sets "db.cleanDisabled=false".
247247
# WARNING: This will delete all your data. It's just an example of how to do so.
248-
docker compose -p dcris24 exec -e "db__P__cleanDisabled=false" dspace /dspace/bin/dspace database clean
248+
docker compose -p dcris25 exec -e "db__P__cleanDisabled=false" dspace /dspace/bin/dspace database clean
249249
```
250250
251251
## Upgrading PostgreSQL in Docker
@@ -263,7 +263,7 @@ Here's how to fix those issues by migrating your old Postgres data to the new ve
263263
1. First, you must start up the older PostgreSQL image (to dump your existing data to a `*.sql` file)
264264
```
265265
# This command assumes you are using the process described above to start all your containers
266-
docker compose -p dcris24 up -d
266+
docker compose -p dcris25 up -d
267267
```
268268
* If you've already accidentally updated to the new PostgreSQL image, you have a few options:
269269
* Pull down an older version of the image from Dockerhub (using a tag)
@@ -272,7 +272,7 @@ Here's how to fix those issues by migrating your old Postgres data to the new ve
272272
# This command will rebuild using PostgreSQL v11 & tag it locally as "latest"
273273
docker build --build-arg POSTGRES_VERSION=11 -t dspace/dspace-postgres-pgcrypto:latest ./dspace/src/main/docker/dspace-postgres-pgcrypto/
274274
# Then restart container with that image
275-
docker compose -p dcris24 up -d
275+
docker compose -p dcris25 up -d
276276
```
277277
2. Dump your entire "dspace" database out of the old "dspacedb" container to a local file named `pgdump.sql`
278278
```
@@ -295,12 +295,12 @@ Here's how to fix those issues by migrating your old Postgres data to the new ve
295295
3. Now, stop all existing containers. This shuts down the old version of PostgreSQL
296296
```
297297
# This command assumes you are using the process described above to start/stop all your containers
298-
docker compose -p dcris24 down
298+
docker compose -p dcris25 down
299299
```
300300
4. Delete the `pgdata` volume. WARNING: This deletes all your old PostgreSQL data. Make sure you have that `pgdump.sql` file FIRST!
301301
```
302-
# Assumes you are using `-p dcris24` which prefixes all volumes with `dcris24_`
303-
docker volume rm dcris24_pgdata
302+
# Assumes you are using `-p dcris25` which prefixes all volumes with `dcris25_`
303+
docker volume rm dcris25_pgdata
304304
```
305305
5. Now, pull down the latest PostgreSQL image with the NEW version of PostgreSQL.
306306
```
@@ -311,12 +311,12 @@ using the local `./pgdump.sql` file. IMPORTANT: If you renamed that "pgdump.sql"
311311
then you MUST change the name/directory in the `db.restore.yml` script.
312312
```
313313
# Restore database from "./pgdump.sql" (this path is hardcoded in db.restore.yml)
314-
docker compose -p dcris24 -f docker-compose.yml -f dspace/src/main/docker-compose/db.restore.yml up -d
314+
docker compose -p dcris25 -f docker-compose.yml -f dspace/src/main/docker-compose/db.restore.yml up -d
315315
```
316316
7. Finally, reindex all database contents into Solr (just to be sure Solr indexes are current).
317317
```
318318
# Run "./dspace index-discovery -b" using our CLI image
319-
docker compose -p dcris24 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
319+
docker compose -p dcris25 -f docker-compose-cli.yml run --rm dspace-cli index-discovery -b
320320
```
321321
At this point in time, all your old database data should be migrated to the new Postgres
322322
and running at http://localhost:8080/server/

dspace/src/main/docker-compose/docker-compose-angular.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
networks:
1010
# Default to using network named 'dspacenet' from docker-compose.yml.
11-
# Its full name will be prepended with the project name (e.g. "-p dcris24" means it will be named "dcris24_dspacenet")
11+
# Its full name will be prepended with the project name (e.g. "-p dcris25" means it will be named "dcris25_dspacenet")
1212
default:
1313
name: ${COMPOSE_PROJECT_NAME}_dspacenet
1414
external: true

dspace/src/main/docker-compose/docker-compose-iiif.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#
1313
networks:
1414
# Default to using network named 'dspacenet' from docker-compose.yml.
15-
# Its full name will be prepended with the project name (e.g. "-p dcris24" means it will be named "dcris24_dspacenet")
15+
# Its full name will be prepended with the project name (e.g. "-p dcris25" means it will be named "dcris25_dspacenet")
1616
default:
1717
name: ${COMPOSE_PROJECT_NAME}_dspacenet
1818
external: true

dspace/src/main/docker-compose/docker-compose-shibboleth.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#
1313
networks:
1414
# Default to using network named 'dspacenet' from docker-compose.yml.
15-
# Its full name will be prepended with the project name (e.g. "-p dcris24" means it will be named "dcris24_dspacenet")
15+
# Its full name will be prepended with the project name (e.g. "-p dcris25" means it will be named "dcris25_dspacenet")
1616
default:
1717
name: ${COMPOSE_PROJECT_NAME}_dspacenet
1818
external: true

dspace/src/main/docker/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,21 +152,21 @@ docker push 4science/dspace-cris-solr:latest
152152

153153
You can then run it using the docker-compose file:
154154
```bash
155-
docker compose -p dcris24 up -d dspacesolr
155+
docker compose -p dcris25 up -d dspacesolr
156156
```
157157

158158
Alternatively, you can use the `docker compose` tool directly to just build and/or run Solr:
159159

160160
```bash
161161
docker compose build dspacesolr
162-
docker compose -p dcris24 up -d dspacesolr
162+
docker compose -p dcris25 up -d dspacesolr
163163
```
164164

165165
If you're making iterative changes to the DSpace-CRIS Solr configsets you'll need to rebuild /
166166
restart the `dspacesolr` container for the changes to be deployed. From DSpace-CRIS root:
167167

168168
```bash
169-
docker compose -p dcris24 up --detach --build dspacesolr
169+
docker compose -p dcris25 up --detach --build dspacesolr
170170
```
171171

172172
## ./test/ folder

0 commit comments

Comments
 (0)