Commits

Pierre Lasou authored and github-actions[bot] committed 1baa5cec26a
Update Docker Angular README.md

Change the docker-compose syntax to V2 syntax docker compose (cherry picked from commit 5e3d0fbdef64531d135177962a97bff04368714e)
No tags

docker/README.md

Modified
52 52 - docker-compose-ci.yml
53 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.
54 54 - cli.yml
55 55 - Docker compose file that provides a DSpace CLI container to work with a running DSpace REST container.
56 56 - cli.assetstore.yml
57 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.
58 58
59 59
60 60 ## To refresh / pull DSpace images from Dockerhub
61 61 ```
62 -docker-compose -f docker/docker-compose.yml pull
62 +docker compose -f docker/docker-compose.yml pull
63 63 ```
64 64
65 65 ## To build DSpace images using code in your branch
66 66 ```
67 -docker-compose -f docker/docker-compose.yml build
67 +docker compose -f docker/docker-compose.yml build
68 68 ```
69 69
70 70 ## To start DSpace (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 d8 -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 80 ## Run DSpace REST and DSpace 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.
84 84
85 85 _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 d8 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 d8 -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 102 ## Run DSpace Angular dist build with DSpace 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/).
106 106
107 107 ```
108 -docker-compose -f docker/docker-compose-dist.yml pull
109 -docker-compose -f docker/docker-compose-dist.yml build
110 -docker-compose -p d8 -f docker/docker-compose-dist.yml up -d
108 +docker compose -f docker/docker-compose-dist.yml pull
109 +docker compose -f docker/docker-compose-dist.yml build
110 +docker compose -p d8 -f docker/docker-compose-dist.yml up -d
111 111 ```
112 112
113 113 ## Ingest test data from AIPDIR
114 114
115 115 Create an administrator
116 116 ```
117 -docker-compose -p d8 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
117 +docker compose -p d8 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
118 118 ```
119 119
120 120 Load content from AIP files
121 121 ```
122 -docker-compose -p d8 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
122 +docker compose -p d8 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
123 123 ```
124 124
125 125 ## Alternative Ingest - Use Entities dataset
126 126 _Delete your docker volumes or use a unique project (-p) name_
127 127
128 128 Start DSpace with Database Content from a database dump
129 129 ```
130 -docker-compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
130 +docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
131 131 ```
132 132
133 133 Load assetstore content and trigger a re-index of the repository
134 134 ```
135 -docker-compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
135 +docker compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
136 136 ```
137 137
138 138 ## 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 d8ci -f docker/docker-compose-ci.yml up -d
144 144 ```

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut