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
+39-7Lines changed: 39 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,20 @@
6
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.
7
7
***
8
8
9
-
## 'Dockerfile' in root directory
9
+
## Overview
10
+
The scripts in this directory can be used to start the DSpace User Interface (frontend) in Docker.
11
+
Optionally, the backend (REST API) might also be started in Docker.
12
+
13
+
For additional options/settings in starting the backend (REST API) in Docker, see the Docker Compose
14
+
documentation for the backend: https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/README.md
15
+
16
+
## Root directory
17
+
18
+
The root directory of this project contains all the Dockerfiles which may be referenced by
19
+
the Docker compose scripts in this 'docker' folder.
20
+
21
+
### Dockerfile
22
+
10
23
This Dockerfile is used to build a *development* DSpace 7 Angular UI image, published as 'dspace/dspace-angular'
11
24
12
25
```
@@ -20,6 +33,8 @@ Admins to our DockerHub repo can manually publish with the following command.
20
33
docker push dspace/dspace-angular:dspace-7_x
21
34
```
22
35
36
+
### Dockerfile.dist
37
+
23
38
The `Dockerfile.dist` is used to generate a *production* build and runtime environment.
## To start DSpace (REST and Angular) from your branch
56
71
72
+
This command provides a quick way to start both the frontend & backend from this single codebase
57
73
```
58
74
docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
59
75
```
60
76
77
+
Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
78
+
79
+
61
80
## Run DSpace REST and DSpace Angular from local branches.
81
+
82
+
This section assumes that you have clones *both* the 'DSpace/DSpace' and 'DSpace/dspace-angular' GitHub
83
+
repositories. When both are available locally, you can spin up both in Docker and have them work together.
84
+
62
85
_The system will be started in 2 steps. Each step shares the same docker network._
63
86
64
-
From DSpace/DSpace(build as needed)
87
+
From 'DSpace/DSpace' clone (build first as needed):
65
88
```
66
89
docker-compose -p d7 up -d
67
90
```
68
91
69
-
From DSpace/DSpace-angular
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
+
94
+
From 'DSpace/dspace-angular' clone (build first as needed)
70
95
```
71
96
docker-compose -p d7 -f docker/docker-compose.yml up -d
72
97
```
73
98
99
+
At this point, you should be able to access the UI from http://localhost:4000,
100
+
and the backend at http://localhost:8080/server/
101
+
74
102
## Run DSpace Angular dist build with DSpace Demo site backend
75
103
104
+
This allows you to run the Angular UI in *production* mode, pointing it at the demo backend
@@ -104,9 +135,10 @@ Load assetstore content and trigger a re-index of the repository
104
135
docker-compose -p d7 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
105
136
```
106
137
107
-
## End to end testing of the rest api (runs in travis).
108
-
_In this instance, only the REST api runs in Docker using the Entities dataset. Travis will perform CI testing of Angular using Node to drive the tests._
138
+
## End to end testing of the REST API (runs in GitHub Actions CI).
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._
109
140
141
+
This command is only really useful for testing our Continuous Integration process.
110
142
```
111
-
docker-compose -p d7ci -f docker/docker-compose-travis.yml up -d
143
+
docker-compose -p d7ci -f docker/docker-compose-ci.yml up -d
0 commit comments