@@ -26,7 +26,7 @@ You should see the containers being built and the services start.
...
@@ -26,7 +26,7 @@ You should see the containers being built and the services start.
There are 2 `docker-compose` files provided in the repository, which build the containers running the services as shown above
There are 2 `docker-compose` files provided in the repository, which build the containers running the services as shown above
*[docker-compose.yml](https://gitlab.ruhr-uni-bochum.de/FDM/rdm-system/rdms/-/blob/master/docker-compose.yml) is the main docker-compose file. It builds all the core servcies required to run the application
*[docker-compose.yml](https://gitlab.ruhr-uni-bochum.de/FDM/rdm-system/rdms/-/blob/master/docker-compose.yml) is the main docker-compose file. It builds all the core servcies required to run the application
*[docker-compose.override.yml](https://gitlab.ruhr-uni-bochum.de/FDM/rdm-system/rdms/-/blob/master/docker-compose.override.yml) is used along with the main [docker-compose.yml](https://gitlab.ruhr-uni-bochum.de/FDM/rdm-system/rdms/-/blob/master/docker-compose.yml) file in development, mainly to expose ports for the various services.
*[docker-compose.override.yml](https://gitlab.ruhr-uni-bochum.de/FDM/rdm-system/rdms/-/blob/master/docker-compose.override.yml) is used along with the main [docker-compose.yml](https://gitlab.ruhr-uni-bochum.de/FDM/rdm-system/rdms/-/blob/master/docker-compose.yml) file, mainly to expose ports for the various services.
### Containers running in docker
### Containers running in docker
...
@@ -113,9 +113,11 @@ local rdms_solr
...
@@ -113,9 +113,11 @@ local rdms_solr
These will persist when the system is brought down and rebuilt. Deleting them will require importers etc. to run again.
These will persist when the system is brought down and rebuilt. Deleting them will require importers etc. to run again.
## Running in development or test
## Running RDMS
When running in development and test environment, prepare your .env file using .env.template.development as the template. You need to use `docker-compose -f docker-compose.yml -f docker-compose.override.yml`. This will use the docker-compose.yml file and the docker-compose.override.yml file.
When running in development and test environment, prepare your .env file using .env.template.development as the template.
You need to use `docker-compose -f docker-compose.yml -f docker-compose.override.yml`. This will use the docker-compose.yml file and the docker-compose.override.yml file.
* fcrepo container will run the fedora service, which will be available in port 8080 at http://localhost:8080/fcrepo/rest
* fcrepo container will run the fedora service, which will be available in port 8080 at http://localhost:8080/fcrepo/rest
* Solr container will run the Solr service, which will be available in port 8983 at http://localhost:8983
* Solr container will run the Solr service, which will be available in port 8983 at http://localhost:8983
* The web container runs the materials data repository service, which will be available in port 3000 at http://localhost:3000
* The web container runs the materials data repository service, which will be available in port 3000 at http://localhost:3000
...
@@ -134,7 +136,7 @@ Static asset build is only run in `production` environment to speed up container
...
@@ -134,7 +136,7 @@ Static asset build is only run in `production` environment to speed up container
hd run web yarn install
hd run web yarn install
```
```
For production envionment the assets precompile may fail. If rdms comes up with an error page this might have happed. Precompile the assets within the web container:
For production environment the assets precompile may fail. If rdms comes up with an error page this might have happened. Precompile the assets within the web container:
