From a21072b0d1088406e7b6a954115a210e41126839 Mon Sep 17 00:00:00 2001 From: fnecas Date: Wed, 24 Jan 2024 11:21:29 +0100 Subject: [PATCH] feat: adds Docker-hub documentation feat: adds Docker-hub documentation --- .github/workflows/georchestra-gn4.yml | 1 - DOCKER_HUB.md | 52 +++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 DOCKER_HUB.md diff --git a/.github/workflows/georchestra-gn4.yml b/.github/workflows/georchestra-gn4.yml index ee8d54355a..cd29652c9a 100644 --- a/.github/workflows/georchestra-gn4.yml +++ b/.github/workflows/georchestra-gn4.yml @@ -68,4 +68,3 @@ jobs: with: name: geonetwork.war path: web/target/geonetwork.war - diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md new file mode 100644 index 0000000000..59de4a5d1a --- /dev/null +++ b/DOCKER_HUB.md @@ -0,0 +1,52 @@ +# 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/geonetwork/blob/master/DOCKER_HUB.md) + +# What is `georchestra/geonetwork` + +**Geonetwork** is a module for geOrchestra which offers +- a metadata catalog suited to publish information about geospatial (and other) (open and closed) data. + +geOrchestra's Geonetwork is a fork of [GeoNetwork opensource](https://github.com/geonetwork/core-geonetwork). +It implements changes like authentication with CAS, and a few others. + +# 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 geonetwork sub-directory. + +It is recommended to use the official docker composition: https://github.com/georchestra/docker. + +For this specific component, see the section `geonetwork` 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 -Pdocker package docker:build` in [`georchestra`](https://github.com/georchestra/georchestra) 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.