|
1 | | -# Docker Compose files |
2 | | - |
3 | | -*** |
4 | | -:warning: **NOT PRODUCTION READY** The below Docker Compose resources are not guaranteed "production ready" at this time. They have been built for development/testing only. Therefore, DSpace Docker images may not be fully secured or up-to-date. While you are welcome to base your own images on these DSpace images/resources, these should not be used "as is" in any production scenario. |
5 | | -*** |
6 | | - |
7 | | -## 'Dockerfile' in root directory |
8 | | -This Dockerfile is used to build a *development* DSpace 7 Angular UI image, published as 'dspace/dspace-angular' |
9 | | - |
10 | | -``` |
11 | | -docker build -t dspace/dspace-angular:dspace-7_x . |
12 | | -``` |
13 | | - |
14 | | -This image is built *automatically* after each commit is made to the `main` branch. |
15 | | - |
16 | | -Admins to our DockerHub repo can manually publish with the following command. |
17 | | -``` |
18 | | -docker push dspace/dspace-angular:dspace-7_x |
19 | | -``` |
20 | | - |
21 | | -## docker directory |
22 | | -- docker-compose.yml |
23 | | - - Starts DSpace Angular with Docker Compose from the current branch. This file assumes that a DSpace 7 REST instance will also be started in Docker. |
24 | | -- docker-compose-rest.yml |
25 | | - - Runs a published instance of the DSpace 7 REST API - persists data in Docker volumes |
26 | | -- docker-compose-ci.yml |
27 | | - - Runs a published instance of the DSpace 7 REST API for CI testing. The database is re-populated from a SQL dump on each startup. |
28 | | -- cli.yml |
29 | | - - Docker compose file that provides a DSpace CLI container to work with a running DSpace REST container. |
30 | | -- cli.assetstore.yml |
31 | | - - 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. |
32 | | - |
33 | | - |
34 | | -## To refresh / pull DSpace images from Dockerhub |
35 | | -``` |
36 | | -docker-compose -f docker/docker-compose.yml pull |
37 | | -``` |
38 | | - |
39 | | -## To build DSpace images using code in your branch |
40 | | -``` |
41 | | -docker-compose -f docker/docker-compose.yml build |
42 | | -``` |
43 | | - |
44 | | -## To start DSpace (REST and Angular) from your branch |
45 | | - |
46 | | -``` |
47 | | -docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d |
48 | | -``` |
49 | | - |
50 | | -## Run DSpace REST and DSpace Angular from local branches. |
51 | | -_The system will be started in 2 steps. Each step shares the same docker network._ |
52 | | - |
53 | | -From DSpace/DSpace (build as needed) |
54 | | -``` |
55 | | -docker-compose -p d7 up -d |
56 | | -``` |
57 | | - |
58 | | -From DSpace/DSpace-angular |
59 | | -``` |
60 | | -docker-compose -p d7 -f docker/docker-compose.yml up -d |
61 | | -``` |
62 | | - |
63 | | -## Ingest test data from AIPDIR |
64 | | - |
65 | | -Create an administrator |
66 | | -``` |
67 | | -docker-compose -p d7 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en |
68 | | -``` |
69 | | - |
70 | | -Load content from AIP files |
71 | | -``` |
72 | | -docker-compose -p d7 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli |
73 | | -``` |
74 | | - |
75 | | -## Alternative Ingest - Use Entities dataset |
76 | | -_Delete your docker volumes or use a unique project (-p) name_ |
77 | | - |
78 | | -Start DSpace with Database Content from a database dump |
79 | | -``` |
80 | | -docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d |
81 | | -``` |
82 | | - |
83 | | -Load assetstore content and trigger a re-index of the repository |
84 | | -``` |
85 | | -docker-compose -p d7 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli |
86 | | -``` |
87 | | - |
88 | | -## End to end testing of the rest api (runs in travis). |
89 | | -_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._ |
90 | | - |
91 | | -``` |
92 | | -docker-compose -p d7ci -f docker/docker-compose-travis.yml up -d |
93 | | -``` |
| 1 | +# Docker Compose files |
| 2 | + |
| 3 | +*** |
| 4 | +:warning: **NOT PRODUCTION READY** The below Docker Compose resources are not guaranteed "production ready" at this time. They have been built for development/testing only. Therefore, DSpace Docker images may not be fully secured or up-to-date. While you are welcome to base your own images on these DSpace images/resources, these should not be used "as is" in any production scenario. |
| 5 | +*** |
| 6 | + |
| 7 | +## 'Dockerfile' in root directory |
| 8 | +This Dockerfile is used to build a *development* DSpace 7 Angular UI image, published as 'dspace/dspace-angular' |
| 9 | + |
| 10 | +``` |
| 11 | +docker build -t dspace/dspace-angular:dspace-7_x . |
| 12 | +``` |
| 13 | + |
| 14 | +This image is built *automatically* after each commit is made to the `main` branch. |
| 15 | + |
| 16 | +Admins to our DockerHub repo can manually publish with the following command. |
| 17 | +``` |
| 18 | +docker push dspace/dspace-angular:dspace-7_x |
| 19 | +``` |
| 20 | + |
| 21 | +## docker directory |
| 22 | +- docker-compose.yml |
| 23 | + - Starts DSpace Angular with Docker Compose from the current branch. This file assumes that a DSpace 7 REST instance will also be started in Docker. |
| 24 | +- docker-compose-rest.yml |
| 25 | + - Runs a published instance of the DSpace 7 REST API - persists data in Docker volumes |
| 26 | +- docker-compose-ci.yml |
| 27 | + - Runs a published instance of the DSpace 7 REST API for CI testing. The database is re-populated from a SQL dump on each startup. |
| 28 | +- cli.yml |
| 29 | + - Docker compose file that provides a DSpace CLI container to work with a running DSpace REST container. |
| 30 | +- cli.assetstore.yml |
| 31 | + - 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. |
| 32 | + |
| 33 | + |
| 34 | +## To refresh / pull DSpace images from Dockerhub |
| 35 | +``` |
| 36 | +docker-compose -f docker/docker-compose.yml pull |
| 37 | +``` |
| 38 | + |
| 39 | +## To build DSpace images using code in your branch |
| 40 | +``` |
| 41 | +docker-compose -f docker/docker-compose.yml build |
| 42 | +``` |
| 43 | + |
| 44 | +## To start DSpace (REST and Angular) from your branch |
| 45 | + |
| 46 | +``` |
| 47 | +docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d |
| 48 | +``` |
| 49 | + |
| 50 | +## Run DSpace REST and DSpace Angular from local branches. |
| 51 | +_The system will be started in 2 steps. Each step shares the same docker network._ |
| 52 | + |
| 53 | +From DSpace/DSpace (build as needed) |
| 54 | +``` |
| 55 | +docker-compose -p d7 up -d |
| 56 | +``` |
| 57 | + |
| 58 | +From DSpace/DSpace-angular |
| 59 | +``` |
| 60 | +docker-compose -p d7 -f docker/docker-compose.yml up -d |
| 61 | +``` |
| 62 | + |
| 63 | +## Ingest test data from AIPDIR |
| 64 | + |
| 65 | +Create an administrator |
| 66 | +``` |
| 67 | +docker-compose -p d7 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en |
| 68 | +``` |
| 69 | + |
| 70 | +Load content from AIP files |
| 71 | +``` |
| 72 | +docker-compose -p d7 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli |
| 73 | +``` |
| 74 | + |
| 75 | +## Alternative Ingest - Use Entities dataset |
| 76 | +_Delete your docker volumes or use a unique project (-p) name_ |
| 77 | + |
| 78 | +Start DSpace with Database Content from a database dump |
| 79 | +``` |
| 80 | +docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d |
| 81 | +``` |
| 82 | + |
| 83 | +Load assetstore content and trigger a re-index of the repository |
| 84 | +``` |
| 85 | +docker-compose -p d7 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli |
| 86 | +``` |
| 87 | + |
| 88 | +## End to end testing of the rest api (runs in travis). |
| 89 | +_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._ |
| 90 | + |
| 91 | +``` |
| 92 | +docker-compose -p d7ci -f docker/docker-compose-travis.yml up -d |
| 93 | +``` |
0 commit comments