You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docker/README.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,11 @@
3
3
***
4
4
:warning:**THESE IMAGES ARE NOT PRODUCTION READY** The below Docker Compose images/resources were built for development/testing only. Therefore, they may not be fully secured or up-to-date, and should not be used in production.
5
5
6
-
If you wish to run DSpace on Docker in production, we recommend building your own Docker images. You are welcome to borrow ideas/concepts from the below images in doing so. But, the below images should not be used "as is" in any production scenario.
6
+
If you wish to run DSpace-CRIS on Docker in production, we recommend building your own Docker images. You are welcome to borrow ideas/concepts from the below images in doing so. But, the below images should not be used "as is" in any production scenario.
7
7
***
8
8
9
9
## Overview
10
-
The scripts in this directory can be used to start the DSpace User Interface (frontend) in Docker.
10
+
The scripts in this directory can be used to start the DSpace-CRIS User Interface (frontend) in Docker.
11
11
Optionally, the backend (REST API) might also be started in Docker.
12
12
13
13
For additional options/settings in starting the backend (REST API) in Docker, see the Docker Compose
@@ -20,17 +20,17 @@ the Docker compose scripts in this 'docker' folder.
20
20
21
21
### Dockerfile
22
22
23
-
This Dockerfile is used to build a *development* DSpace Angular UI image, published as 'dspace/dspace-angular'
23
+
This Dockerfile is used to build a *development* DSpace-CRIS Angular UI image, published as '4science/dspace-cris-angular'
A default/demo version of this image is built *automatically*.
46
46
47
47
## 'docker' directory
48
48
- docker-compose.yml
49
-
- Starts DSpace Angular with Docker Compose from the current branch. This file assumes that a DSpace REST instance will also be started in Docker.
49
+
- Starts DSpace-CRIS Angular with Docker Compose from the current branch. This file assumes that a DSpace-CRIS REST instance will also be started in Docker.
50
50
- docker-compose-rest.yml
51
-
- Runs a published instance of the DSpace REST API - persists data in Docker volumes
51
+
- Runs a published instance of the DSpace-CRIS REST API - persists data in Docker volumes
52
52
- docker-compose-ci.yml
53
-
- Runs a published instance of the DSpace REST API for CI testing. The database is re-populated from a SQL dump on each startup.
53
+
- Runs a published instance of the DSpace-CRIS REST API for CI testing. The database is re-populated from a SQL dump on each startup.
54
54
- cli.yml
55
-
- Docker compose file that provides a DSpace CLI container to work with a running DSpace REST container.
55
+
- Docker compose file that provides a DSpace-CRIS CLI container to work with a running DSpace-CRIS REST container.
56
56
- cli.assetstore.yml
57
-
- Docker compose file that will download and install data into a DSpace REST assetstore. This script points to a default dataset that will be utilized for CI testing.
57
+
- Docker compose file that will download and install data into a DSpace-CRIS REST assetstore. This script points to a default dataset that will be utilized for CI testing.
58
58
59
59
60
-
## To refresh / pull DSpace images from Dockerhub
60
+
## To refresh / pull DSpace-CRIS images from Dockerhub
61
61
```
62
62
docker compose -f docker/docker-compose.yml pull
63
63
```
64
64
65
-
## To build DSpace images using code in your branch
65
+
## To build DSpace-CRIS images using code in your branch
66
66
```
67
67
docker compose -f docker/docker-compose.yml build
68
68
```
69
69
70
-
## To start DSpace (REST and Angular) from your branch
70
+
## To start DSpace-CRIS (REST and Angular) from your branch
71
71
72
72
This command provides a quick way to start both the frontend & backend from this single codebase
73
73
```
74
-
docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
74
+
docker compose -p c24 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
75
75
```
76
76
77
77
Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
78
78
79
79
80
-
## Run DSpace REST and DSpace Angular from local branches.
80
+
## Run DSpace-CRIS REST and DSpace-CRIS Angular from local branches.
81
81
82
82
This section assumes that you have clones *both* the 'DSpace/DSpace' and 'DSpace/dspace-angular' GitHub
83
83
repositories. When both are available locally, you can spin up both in Docker and have them work together.
@@ -86,59 +86,59 @@ _The system will be started in 2 steps. Each step shares the same docker network
86
86
87
87
From 'DSpace/DSpace' clone (build first as needed):
88
88
```
89
-
docker compose -p d8 up -d
89
+
docker compose -p c24 up -d
90
90
```
91
91
92
92
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).
93
93
94
94
From 'DSpace/dspace-angular' clone (build first as needed)
95
95
```
96
-
docker compose -p d8 -f docker/docker-compose.yml up -d
96
+
docker compose -p c24 -f docker/docker-compose.yml up -d
97
97
```
98
98
99
99
At this point, you should be able to access the UI from http://localhost:4000,
100
100
and the backend at http://localhost:8080/server/
101
101
102
-
## Run DSpace Angular dist build with DSpace Demo site backend
102
+
## Run DSpace-CRIS Angular dist build with DSpace-CRIS Demo site backend
103
103
104
104
This allows you to run the Angular UI in *production* mode, pointing it at the demo or sandbox backend
105
105
(https://demo.dspace.org/server/ or https://sandbox.dspace.org/server/).
## End to end testing of the REST API (runs in GitHub Actions CI).
139
139
_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._
140
140
141
141
This command is only really useful for testing our Continuous Integration process.
142
142
```
143
-
docker compose -p d8ci -f docker/docker-compose-ci.yml up -d
143
+
docker compose -p c24ci -f docker/docker-compose-ci.yml up -d
0 commit comments