From e7580992a22a73648754af0e0921a4916d7a96ab Mon Sep 17 00:00:00 2001 From: fnecas Date: Wed, 24 Jan 2024 10:44:25 +0100 Subject: [PATCH 1/4] feat: adds Docker-hub documentation --- .github/workflows/docker.yml | 10 +++++++ DOCKER_HUB.md | 54 ++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 DOCKER_HUB.md diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index c9af34d5..1170c106 100644 --- a/.github/workflows/docker.yml +++ b/.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 geOrchestra SDI' + - name: "Push image attached to commit id to docker.io" if: github.ref == 'refs/heads/main' && github.repository == 'georchestra/georchestra-gateway' run: | diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md new file mode 100644 index 00000000..8e14e5ce --- /dev/null +++ b/DOCKER_HUB.md @@ -0,0 +1,54 @@ +# Quick reference + +- **Maintained by**: + [georchestra.org](https://www.georchestra.org/) + +- **Where to get help**: + the [Georchestra Github repo](https://github.com/georchestra/georchestra), [Matrix chat](https://matrix.to/#/#georchestra:libera.chat), 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 build using maven : `./mvnw package -f gateway/ -Pdocker` in repo folder. + +Make can also be used : `make docker`. + +# 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 From 5847e79273d81f02c5b646132adb2ee8895473f1 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Thu, 25 Jan 2024 16:58:11 +0100 Subject: [PATCH 2/4] Update DOCKER_HUB.md --- DOCKER_HUB.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index 8e14e5ce..2f48d4d4 100644 --- a/DOCKER_HUB.md +++ b/DOCKER_HUB.md @@ -4,7 +4,7 @@ [georchestra.org](https://www.georchestra.org/) - **Where to get help**: - the [Georchestra Github repo](https://github.com/georchestra/georchestra), [Matrix chat](https://matrix.to/#/#georchestra:libera.chat), 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 @@ -51,4 +51,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 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. From fb029a78a50096c07f23935e1c278d91ff2b69b6 Mon Sep 17 00:00:00 2001 From: Emmanuel Durin Date: Mon, 29 Jan 2024 12:30:04 +0100 Subject: [PATCH 3/4] Update DOCKER_HUB.md about tests --- DOCKER_HUB.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index 2f48d4d4..50d0d796 100644 --- a/DOCKER_HUB.md +++ b/DOCKER_HUB.md @@ -43,6 +43,12 @@ This image is build using maven : `./mvnw package -f gateway/ -Pdocker` in repo 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. From 5aadaaff4253e8788f475e45390395b150710874 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Thu, 8 Feb 2024 10:51:23 +0100 Subject: [PATCH 4/4] docs: update with recommendations --- .github/workflows/docker.yml | 2 +- DOCKER_HUB.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 1170c106..019682ff 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -58,7 +58,7 @@ jobs: password: ${{ secrets.DOCKER_HUB_PASSWORD }} repository: georchestra/gateway readme-filepath: ./DOCKER_HUB.md - short-description: 'Gateway module for geOrchestra SDI' + 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' diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index 50d0d796..ee58a80a 100644 --- a/DOCKER_HUB.md +++ b/DOCKER_HUB.md @@ -4,7 +4,7 @@ [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 @@ -39,7 +39,7 @@ For this specific component, see the section `gateway` in the [`georchestra/dock ## Where is it built -This image is build using maven : `./mvnw package -f gateway/ -Pdocker` in repo folder. +This image is built using maven : `./mvnw package -f gateway/ -Pdocker` in repo folder. Make can also be used : `make docker`. @@ -57,4 +57,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. +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.