Skip to content

Commit

Permalink
Merge pull request #285 from georchestra/docker-hub-documentation
Browse files Browse the repository at this point in the history
Adds Docker-hub documentation
  • Loading branch information
f-necas authored Jan 26, 2024
2 parents 8419cfa + 2551831 commit 8d583be
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions DOCKER_HUB.md
Original file line number Diff line number Diff line change
@@ -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), [IRC chat](https://kiwiirc.com/nextclient/irc.libera.chat/georchestra), Stack Overflow

# Featured tags

- `latest`, `23.0.x`, `4.2.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.

0 comments on commit 8d583be

Please sign in to comment.