Merge pull request #740 from georchestra/docs/docker-hub

Adds Docker-hub documentation

.github/workflows/cadastrapp.yml

@@ -88,6 +88,16 @@ jobs:
       run: |
         docker push georchestra/cadastrapp:${{ steps.version.outputs.VERSION }}
 
+    - name: "Update Docker Hub Description for Cadastrapp"
+      if: github.ref == 'refs/heads/master' && github.repository == 'georchestra/cadastrapp' && 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/cadastrapp
+        readme-filepath: ./DOCKER_HUB.md
+        short-description: 'Cadastrapp module for the geOrchestra SDI'
+
     - name: "Publish binary in artifactory"
       run: ./mvn deploy
       continue-on-error: true

DOCKER_HUB.md

@@ -0,0 +1,58 @@
+# 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`
+
+# 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/cadastrapp/blob/master/DOCKER_HUB.md)
+
+# What is `georchestra/cadastrapp`
+
+**Cadastrapp** is the tool for consulting cadastral data provided by the French Directorate General of Public Finances (DGFiP) for geOrchestra 
+
+# 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 cadstrapp/ sub-directory.
+
+It is recommended to use the official docker composition: https://github.com/georchestra/docker.
+
+Example : 
+```
+  cadastrapp:
+    image: georchestra/cadastrapp:latest
+    environment:
+      XMX: 512m
+      JAVA_OPTIONS: -Duser.language=fr -Duser.country=FR
+      CADASTRAPP_JDBC_URL: jdbc:postgresql://database:5432/cadastrapp
+      CADASTRAPP_JDBC_USER: cadastrapp
+      CADASTRAPP_JDBC_PASSWORD: cadastrapp
+```
+
+## Where is it built
+
+This image is built using maven : `mvn package docker:build -pl cadastrapp -Pdocker` in the repo https://github.com/georchestra/cadastrapp/.
+
+# 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.

README.md

@@ -2,7 +2,7 @@
 
 ## À propos de Cadastrapp
 
-Cadastrapp est l’outil de consultation des données cadastrales fournies par la Direction Générale des Finances Publiques (DGFiP) pour geOrchestra geOrchestra. Il est composé d’un module serveur qui est une API d’accès aux données de la matrice foncière et d'un greffon pour le visualiseur de geOrchestra. L’API peut être utilisée par n’importe quelle application client sous réserve de passer par le système d’authentification de [geOrchestra](https://www.georchestra.org).
+Cadastrapp est l’outil de consultation des données cadastrales fournies par la Direction Générale des Finances Publiques (DGFiP) pour geOrchestra. Il est composé d’un module serveur qui est une API d’accès aux données de la matrice foncière et d'un greffon pour le visualiseur de geOrchestra. L’API peut être utilisée par n’importe quelle application client sous réserve de passer par le système d’authentification de [geOrchestra](https://www.georchestra.org).
 
 ## Organisation