From ac8e9892272af3d91fd74749c368d2dab0d13da2 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Wed, 7 Feb 2024 13:40:04 +0100 Subject: [PATCH 1/2] docs: add docker hub documentation --- .github/workflows/cadastrapp.yml | 10 ++++++ DOCKER_HUB.md | 58 ++++++++++++++++++++++++++++++++ README.md | 2 +- 3 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 DOCKER_HUB.md diff --git a/.github/workflows/cadastrapp.yml b/.github/workflows/cadastrapp.yml index 8392ef2a..f51fbec7 100644 --- a/.github/workflows/cadastrapp.yml +++ b/.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 geOrchestra SDI' + - name: "Publish binary in artifactory" run: ./mvn deploy continue-on-error: true diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md new file mode 100644 index 00000000..53a75ddf --- /dev/null +++ b/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`, `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/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 build 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 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. \ No newline at end of file diff --git a/README.md b/README.md index 61e3adb5..fc9fe4a8 100644 --- a/README.md +++ b/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 From 57497828df614a6889a7a8ca41de13f20b23f582 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Thu, 8 Feb 2024 10:43:23 +0100 Subject: [PATCH 2/2] docs: update with recommendations --- .github/workflows/cadastrapp.yml | 2 +- DOCKER_HUB.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/cadastrapp.yml b/.github/workflows/cadastrapp.yml index f51fbec7..5971cd83 100644 --- a/.github/workflows/cadastrapp.yml +++ b/.github/workflows/cadastrapp.yml @@ -96,7 +96,7 @@ jobs: password: ${{ secrets.DOCKER_HUB_PASSWORD }} repository: georchestra/cadastrapp readme-filepath: ./DOCKER_HUB.md - short-description: 'Cadastrapp module for geOrchestra SDI' + short-description: 'Cadastrapp module for the geOrchestra SDI' - name: "Publish binary in artifactory" run: ./mvn deploy diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index 53a75ddf..0cbeece5 100644 --- a/DOCKER_HUB.md +++ b/DOCKER_HUB.md @@ -4,11 +4,11 @@ [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 + 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` +- `latest` # Quick reference @@ -45,7 +45,7 @@ Example : ## Where is it built -This image is build using maven : `mvn package docker:build -pl cadastrapp -Pdocker` in the repo https://github.com/georchestra/cadastrapp/. +This image is built using maven : `mvn package docker:build -pl cadastrapp -Pdocker` in the repo https://github.com/georchestra/cadastrapp/. # License @@ -55,4 +55,4 @@ As with all Docker images, these likely also contain other software which may be [//]: # (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. \ No newline at end of file +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. \ No newline at end of file