From a65a8c2f57faabb27b30f7778b13e190bc0bc2bf Mon Sep 17 00:00:00 2001 From: fnecas Date: Wed, 24 Jan 2024 10:06:18 +0100 Subject: [PATCH 1/4] feat: adds Docker-hub documentation --- .github/workflows/main.yml | 10 ++++++++ DOCKER_HUB.md | 50 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 DOCKER_HUB.md diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index f3ab40f..d1a2405 100644 --- a/.github/workflows/main.yml +++ b/.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 geOrchestra SDI' + - name: Publish the docker image (release / tag) if: contains(github.ref, 'refs/tags/') && github.repository == 'georchestra/georchestra-cas-server' run: | diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md new file mode 100644 index 0000000..bd75bb4 --- /dev/null +++ b/DOCKER_HUB.md @@ -0,0 +1,50 @@ +# 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 `analytics/` directory](https://github.com/georchestra/georchestra/blob/master/analytics/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 analytics sub-directory. + +It is recommended to use the official docker composition: https://github.com/georchestra/docker. + +For this specific component, see the section `analytics` 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 docker:build -Pdocker` in `georchestra` repo `analytics/` folder. + +# 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 49df6c340baaee6cb8ead09884bf8efcb484e280 Mon Sep 17 00:00:00 2001 From: fnecas Date: Wed, 24 Jan 2024 10:11:34 +0100 Subject: [PATCH 2/4] feat: update docs --- DOCKER_HUB.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index bd75bb4..f470897 100644 --- a/DOCKER_HUB.md +++ b/DOCKER_HUB.md @@ -14,12 +14,13 @@ - **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 `analytics/` directory](https://github.com/georchestra/georchestra/blob/master/analytics/DOCKER_HUB.md) + [docs repo's directory](https://github.com/georchestra/georchestra-cas-server/blob/master/DOCKER_HUB.md) # What is `georchestra/cas` @@ -29,15 +30,15 @@ # 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 analytics sub-directory. +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 `analytics` in the [`georchestra/docker/docker-compose.yml`](https://github.com/georchestra/docker/blob/master/docker-compose.yml) file. +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 build using maven : `../mvnw package docker:build -Pdocker` in `georchestra` repo `analytics/` folder. +This image is build using Dockerfile in `cas` repo. # License From ac5d3d9698dc2a13225d470f537f170cba25ecb7 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Thu, 25 Jan 2024 16:57:39 +0100 Subject: [PATCH 3/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 f470897..c524f75 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 @@ -48,4 +48,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 4e6d3494df63aa052c266d06bb643e075f56ecb1 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Thu, 8 Feb 2024 10:49:20 +0100 Subject: [PATCH 4/4] docs: update with recommendations --- .github/workflows/main.yml | 2 +- DOCKER_HUB.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d1a2405..07ca5db 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -61,7 +61,7 @@ jobs: password: ${{ secrets.DOCKER_HUB_PASSWORD }} repository: georchestra/cas readme-filepath: ./DOCKER_HUB.md - short-description: 'Cas module for geOrchestra SDI' + 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' diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index c524f75..c68931b 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 @@ -38,7 +38,7 @@ For this specific component, see the section `cas` in the [`georchestra/docker/d ## Where is it built -This image is build using Dockerfile in `cas` repo. +This image is built using Dockerfile in `cas` repo. # License