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

Adds Docker-hub documentation

.github/workflows/main.yml

@@ -53,6 +53,16 @@ jobs:
         run: |
           docker push georchestra/cas:latest
 
+      - name: "Update Docker Hub Description"
+        if: github.ref == 'refs/heads/master' && github.repository == 'georchestra/georchestra-cas-server' && 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/cas
+          readme-filepath: ./DOCKER_HUB.md
+          short-description: 'Cas module for the geOrchestra SDI'
+
       - name: Publish the docker image (release / tag)
         if: contains(github.ref, 'refs/tags/') && github.repository == 'georchestra/georchestra-cas-server'
         run: |

DOCKER_HUB.md

@@ -0,0 +1,51 @@
+# 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)
+     [https://github.com/georchestra/georchestra-cas-server/issues](https://github.com/georchestra/georchestra-cas-server/issues)
+
+-	**Supported architectures**:   
+     [`amd64`](https://hub.docker.com/r/amd64/docker/)
+
+-	**Source of this description**:  
+     [docs repo's directory](https://github.com/georchestra/georchestra-cas-server/blob/master/DOCKER_HUB.md)
+
+# What is `georchestra/cas`
+
+**CAS** is a module for geOrchestra which offers
+- Single Sign On (SSO) for all geOrchestra webapps with a custom interface
+- Authentication against a LDAP directory
+
+# 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 cas sub-directory.
+
+It is recommended to use the official docker composition: https://github.com/georchestra/docker.
+
+For this specific component, see the section `cas` 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 Dockerfile in `cas` repo. 
+
+# 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 pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.