Merge pull request #99 from georchestra/docker-hub-description

Adds Docker-hub documentation

.github/workflows/docker.yml

@@ -50,6 +50,16 @@ jobs:
       if: github.ref != 'refs/heads/main' && github.repository == 'georchestra/georchestra-gateway'
       run: docker push georchestra/gateway:${{ steps.version.outputs.VERSION }}
 
+    - name: "Update Gateway Docker Hub Description"
+      if: github.ref == 'refs/heads/main' && github.repository == 'georchestra/georchestra-gateway' && github.actor != 'dependabot[bot]' && github.event_name != 'pull_request'
+      uses: peter-evans/dockerhub-description@v3
+      with:
+        username: ${{ secrets.DOCKER_HUB_USERNAME }}
+        password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+        repository: georchestra/gateway
+        readme-filepath: ./DOCKER_HUB.md
+        short-description: 'Gateway module for the geOrchestra SDI'
+
     - name: "Push image attached to commit id to docker.io"
       if: github.ref == 'refs/heads/main' && github.repository == 'georchestra/georchestra-gateway'
       run: |

DOCKER_HUB.md

@@ -0,0 +1,60 @@
+# Quick reference
+
+-    **Maintained by**:  
+      [georchestra.org](https://www.georchestra.org/)
+
+-    **Where to get help**:  
+     the [geOrchestra Github repo](https://github.com/georchestra/georchestra), [IRC chat](https://kiwiirc.com/nextclient/irc.libera.chat/georchestra), Stack Overflow
+
+# Featured tags
+
+- `latest`, `23.0.x`
+
+# Quick reference
+
+-	**Where to file issues**:  
+     [https://github.com/georchestra/georchestra/issues](https://github.com/georchestra/georchestra/issues)
+
+-	**Supported architectures**:   
+     [`amd64`](https://hub.docker.com/r/amd64/docker/)
+
+-	**Source of this description**:  
+     [docs repo's directory](https://github.com/georchestra/georchestra-gateway/blob/master/DOCKER_HUB.md)
+
+# What is `georchestra/gateway`
+
+**Gateway** is a module for geOrchestra which offers
+- OAuth2 and OpenID Connect authentication and authorization
+- LDAP authentication and authorization
+- HTTP/2
+- Websockets
+
+# How to use this image
+
+As for every other geOrchestra webapp, its configuration resides in the data directory ([datadir](https://github.com/georchestra/datadir)), typically something like /etc/georchestra, where it expects to find a gateway sub-directory.
+
+It is recommended to use the official docker composition: https://github.com/georchestra/docker.
+
+For this specific component, see the section `gateway` in the [`georchestra/docker/docker-compose.yml`](https://github.com/georchestra/docker/blob/master/docker-compose.yml) file.
+
+## Where is it built
+
+This image is built using maven : `./mvnw package -f gateway/ -Pdocker` in repo folder.
+
+Make can also be used : `make docker`.
+
+## Running tests
+
+Tests are run using maven : `./mvnw verify -pl :georchestra-gateway -ntp` in repo folder.
+
+Make can also be used : `make test`.
+
+# License
+
+View [license information](https://www.georchestra.org/software.html) for the software contained in this image.
+
+As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
+
+[//]: # (Some additional license information which was able to be auto-detected might be found in [the `repo-info` repository's georchestra/ directory]().)
+
+As for any docker image, it is the user's responsibility to ensure that usages of this image comply with any relevant licenses for all software contained within.