Skip to content

Commit

Permalink
Merge pull request DSpace#3158 from pilasou/pilasou-docker-compose-sy…
Browse files Browse the repository at this point in the history
…ntax-change

Docker compose syntax changes
  • Loading branch information
tdonohue authored Jul 3, 2024
2 parents 6695cf4 + da8a73b commit c3a26ea
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
26 changes: 13 additions & 13 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,19 @@ A default/demo version of this image is built *automatically*.

## To refresh / pull DSpace images from Dockerhub
```
docker-compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml pull
```

## To build DSpace images using code in your branch
```
docker-compose -f docker/docker-compose.yml build
docker compose -f docker/docker-compose.yml build
```

## To start DSpace (REST and Angular) from your branch

This command provides a quick way to start both the frontend & backend from this single codebase
```
docker-compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
```

Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
Expand All @@ -86,14 +86,14 @@ _The system will be started in 2 steps. Each step shares the same docker network

From 'DSpace/DSpace' clone (build first as needed):
```
docker-compose -p d8 up -d
docker compose -p d8 up -d
```

NOTE: More detailed instructions on starting the backend via Docker can be found in the [Docker Compose instructions for the Backend](https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/README.md).

From 'DSpace/dspace-angular' clone (build first as needed)
```
docker-compose -p d8 -f docker/docker-compose.yml up -d
docker compose -p d8 -f docker/docker-compose.yml up -d
```

At this point, you should be able to access the UI from http://localhost:4000,
Expand All @@ -105,40 +105,40 @@ This allows you to run the Angular UI in *production* mode, pointing it at the d
(https://demo.dspace.org/server/ or https://sandbox.dspace.org/server/).

```
docker-compose -f docker/docker-compose-dist.yml pull
docker-compose -f docker/docker-compose-dist.yml build
docker-compose -p d8 -f docker/docker-compose-dist.yml up -d
docker compose -f docker/docker-compose-dist.yml pull
docker compose -f docker/docker-compose-dist.yml build
docker compose -p d8 -f docker/docker-compose-dist.yml up -d
```

## Ingest test data from AIPDIR

Create an administrator
```
docker-compose -p d8 -f docker/cli.yml run --rm dspace-cli create-administrator -e [email protected] -f admin -l user -p admin -c en
docker compose -p d8 -f docker/cli.yml run --rm dspace-cli create-administrator -e [email protected] -f admin -l user -p admin -c en
```

Load content from AIP files
```
docker-compose -p d8 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
docker compose -p d8 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
```

## Alternative Ingest - Use Entities dataset
_Delete your docker volumes or use a unique project (-p) name_

Start DSpace with Database Content from a database dump
```
docker-compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
```

Load assetstore content and trigger a re-index of the repository
```
docker-compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
docker compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
```

## End to end testing of the REST API (runs in GitHub Actions CI).
_In this instance, only the REST api runs in Docker using the Entities dataset. GitHub Actions will perform CI testing of Angular using Node to drive the tests. See `.github/workflows/build.yml` for more details._

This command is only really useful for testing our Continuous Integration process.
```
docker-compose -p d8ci -f docker/docker-compose-ci.yml up -d
docker compose -p d8ci -f docker/docker-compose-ci.yml up -d
```
2 changes: 1 addition & 1 deletion docker/docker-compose-rest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ services:
# * First, run precreate-core to create the core (if it doesn't yet exist). If exists already, this is a no-op
# * Second, copy configsets to this core:
# Updates to Solr configs require the container to be rebuilt/restarted:
# `docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d --build dspacesolr`
# `docker compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d --build dspacesolr`
entrypoint:
- /bin/bash
- '-c'
Expand Down

0 comments on commit c3a26ea

Please sign in to comment.