Added documentation for dockerhub images

Makefile

@@ -4,6 +4,12 @@ all: build
 
 clean:
 
+release-deps:
+	pip3 install -r ./dockerhub/requirements.txt
+
+release: release-deps
+	python3 ./dockerhub/release.py
+
 build:
 	docker-compose build
 	docker-compose up

dockerhub/_header.md

@@ -11,7 +11,7 @@
 
 # Supported tags and respective `Dockerfile` links
 
-* [`latest`](https://hub.docker.com/repository/docker/dbrepo/metadata-db/tags?page=1&ordering=last_updated&name=latest)
+* [`latest`](https://hub.docker.com/repository/docker/dbrepo/REPOSITORY/tags?page=1&ordering=last_updated&name=latest)
 
 # Quick reference (cont.)
 

dockerhub/client/Dockerhub.py

@@ -27,7 +27,7 @@ class Dockerhub:
 
 
     def modify_description(self, repository):
-        header = self.__read__(self.workpath + "/_header.md")
+        header = self.__read__(self.workpath + "/_header.md").replace('REPOSITORY', repository)
         body = self.__read__(self.workpath + "/fda-" + repository + ".md")
         response = rq.patch(self.baseurl + "/v2/repositories/" + self.username + "/" + repository + "/", headers=self.headers,
             json={

dockerhub/fda-analyse-service.md

+# How to use this image
+
+```console
+$ docker run -v /var/run/docker.sock:/var/run/docker.sock -v /tmp:/tmp -p 5000:5000
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:5000/swagger-ui/
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:5000/api-analyze.json

dockerhub/fda-authentication-service.md

+# How to use this image
+
+```console
+$ docker run -p 9097:9097 -e SPRING_PROFILES_ACTIVE=docker
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:9097/swagger-ui/index.html
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:9097/v3/api-docs/
+
+* **OpenAPI `.yaml`**:
+
+  http://localhost:9097/v3/api-docs.yaml

dockerhub/fda-broker-service.md

+# How to use this image
+
+```console
+$ docker run -v ./fda-broker-service-data:/var/lib/rabbitmq/ -p 9098:9098 -p 5672:5672 -p 15672:15672
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:9098/swagger-ui/index.html
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:9098/v3/api-docs/
+
+* **OpenAPI `.yaml`**:
+
+  http://localhost:9098/v3/api-docs.yaml
+
+## RabbitMQ Endpoints
+
+* **Management**:
+
+  http://localhost:15672/

dockerhub/fda-container-service.md

+# How to use this image
+
+```console
+$ docker run -p 9091:9091 -v /var/run/docker.sock:/var/run/docker.sock -e SPRING_PROFILES_ACTIVE=docker
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:9091/swagger-ui/index.html
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:9091/v3/api-docs/
+
+* **OpenAPI `.yaml`**:
+
+  http://localhost:9091/v3/api-docs.yaml

dockerhub/fda-database-service.md

+# How to use this image
+
+```console
+$ docker run -p 9092:9092 -v /var/run/docker.sock:/var/run/docker.sock -e SPRING_PROFILES_ACTIVE=docker
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:9092/swagger-ui/index.html
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:9092/v3/api-docs/
+
+* **OpenAPI `.yaml`**:
+
+  http://localhost:9092/v3/api-docs.yaml

dockerhub/fda-gateway-service.md

+# How to use this image
+
+```console
+$ docker run -p 9095:9095 -e SPRING_PROFILES_ACTIVE=docker
+```

dockerhub/fda-identifier-service.md

+# How to use this image
+
+```console
+$ docker run -p 9096:9096 -e SPRING_PROFILES_ACTIVE=docker
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:9096/swagger-ui/index.html
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:9096/v3/api-docs/
+
+* **OpenAPI `.yaml`**:
+
+  http://localhost:9096/v3/api-docs.yaml

dockerhub/fda-query-service.md

+# How to use this image
+
+```console
+$ docker run -p 9093:9093 -e SPRING_PROFILES_ACTIVE=docker
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:9093/swagger-ui/index.html
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:9093/v3/api-docs/
+
+* **OpenAPI `.yaml`**:
+
+  http://localhost:9093/v3/api-docs.yaml

dockerhub/fda-search-service.md

+# How to use this image
+
+```console
+$ docker run -p 9200:9200 -p 9600:9600 -e discovery.type=single-node -e "ES_JAVA_OPTS=-Xms512m -Xmx512m" -e logger.level=WARN
+```
+
+## ElasticSearch Endpoints
+
+* **Database Index**:
+
+  http://localhost:9000/databaseindex

dockerhub/fda-table-service.md

+# How to use this image
+
+```console
+$ docker run -v /var/run/docker.sock:/var/run/docker.sock -v /tmp:/tmp -p 9094:9094 -e SPRING_PROFILES_ACTIVE=docker
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:9094/swagger-ui/index.html
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:9094/v3/api-docs/
+
+* **OpenAPI `.yaml`**:
+
+  http://localhost:9094/v3/api-docs.yaml

dockerhub/fda-ui.md

+# How to use this image
+
+```console
+$ docker run -v /tmp:/tmp -p 3000:3000 -e HOST=0.0.0.0 -e API=http://fda-gateway-service:9095
+```
+
+## Graphical Endpoints
+
+* **FAIR Portal**:
+
+  http://localhost:3000/
+
+## Middleware Endpoints
+
+* **HTTP API**:
+  
+  http://localhost:3000/api/

dockerhub/fda-units-service.md

+# How to use this image
+
+```console
+$ docker run -p 5010:5010 -e SPRING_PROFILES_ACTIVE=docker
+```
+
+## Swagger Endpoints
+
+* **OpenAPI**:
+
+  http://localhost:5010/swagger-ui/
+
+* **OpenAPI `.json`**:
+  
+  http://localhost:5010/api-analyze.json

dockerhub/release.py

+#!/bin/env python3
+from client.Dockerhub import Dockerhub
+
+dockerhub = Dockerhub()
+
+if __name__ == "__main__":
+    for component in ["analyse-service", "authentication-service", "broker-service", "container-service",
+                      "database-service", "discovery-service", "gateway-service", "identifier-service",
+                      "metadata-db", "query-service", "search-service", "table-service", "ui", "units-service"]:
+        response = dockerhub.modify_description(component)
+        print(response)
\ No newline at end of file

dockerhub/response.py

-from client.Dockerhub import Dockerhub
-
-dockerhub = Dockerhub()
-
-for component in ["discovery-service", "metadata-db"]:
-    response = dockerhub.modify_description(component)
-    print(response)

docs/getting-started.md

@@ -25,39 +25,54 @@ For this small, local, test deployment any modern hardware would suffice, we rec
 
 ### Software
 
-=== "Linux"
+Install [:fontawesome-brands-docker: Docker Engine](https://docs.docker.com/engine/install/) for your OS.
 
-    Install [Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) for Linux
+## Deployment
+
+We currently maintain 14 images on [Dockerhub](https://hub.docker.com/u/dbrepo).
 
-=== "Windows"
+=== ":fontawesome-brands-linux: Linux"
 
-    Install [Docker Desktop](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe) for Windows
+    Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml)
     
-=== "macOS"
+    ```console
+    wget https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml
+    ```
 
-    Install [Docker Desktop](https://desktop.docker.com/mac/main/amd64/Docker.dmg) for macOS
+    Start the services
+
+    ```console
+    docker-compose up -d
+    ```
+
+=== ":fontawesome-brands-windows: Windows"
 
-## Deployment
 
     Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml)
-file and deploy the system using your command line.
     
-=== "Linux"
+    ```console
+    curl.exe -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml
+    ```
+
+    Start the services
 
     ```console
-    docker-compose up
+    docker-compose up -d
     ```
 
-=== "Windows"
+=== ":fontawesome-brands-apple: macOS"
+
+
+    Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml)
     
     ```console
-    docker-compose up
+    wget https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml
     ```
 
-=== "macOS"
+    Start the services
 
     ```console
-    docker-compose up
+    docker-compose up -d
     ```
 
 The system is auto-configured for a small, local, test deployment. You only need to start all containers by executing:

docs/index.md

@@ -22,19 +22,8 @@ We present a database repository system that allows researchers to ingest data i
 through common interfaces, provides efficient access to arbitrary subsets of data even when the underlying data store is
 evolving, allows reproducing of query results and supports findable-, accessible-, interoperable- and reusable data.
 
-![Preview image for the teaser video explaining the use-cases and benefits of using the database repository](/images/preview.png)
-{ #teaser-preview }
-
-<video id="teaser-video" autoplay class="hidden" preload="none" controls poster="/images/preview.png">
-  <source src="/videos/teaser.mp4" type="video/mp4">
-  Your browser does not support the video tag.
-</video>
-
-[Play Video](javascript:play();){ .action-button .md-button .md-button--secondary }
-
 ## More Information
 
-- This documentation can be downloaded as [PDF](/pdf/documentation.pdf)
 - Public demonstration instance [https://dbrepo.ossdip.at](https://dbrepo.ossdip.at)
 - Join our [mailing list](https://lists.univie.ac.at/mailman/listinfo/fairdata_dbrepo) to receive bi-monthly updates
   about the progress, new features and events!
@@ -50,12 +39,3 @@ video {
   display: none;
 }
 </style>
-<script>
-var preview = document.getElementById('teaser-preview'); 
-var video = document.getElementById('teaser-video');    
-function play() {
-  preview.classList.add('hidden');
-  video.classList.remove('hidden');
-  video.play();
-}
-</script>