Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docker-hub documentation #693

Merged
merged 3 commits into from
Feb 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/mapstore.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,13 @@ jobs:
if: contains(github.ref, 'refs/tags/') && github.repository == 'georchestra/mapstore2-georchestra' && github.event_name == 'push'
run: |
docker push georchestra/mapstore:${{ steps.version.outputs.VERSION }}

- name: "Update Docker Hub Description"
if: github.ref == 'refs/heads/master' && github.repository == 'georchestra/mapstore2-georchestra' && 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/mapstore
readme-filepath: ./DOCKER_HUB.md
short-description: 'Mapstore module for geOrchestra SDI'
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), [Matrix chat](https://matrix.to/#/#georchestra:libera.chat), Stack Overflow
Gaetanbrl marked this conversation as resolved.
Show resolved Hide resolved

# Featured tags

- `latest`, `2022.02.02-geOrchestra`

# Quick reference

- **Where to file issues**:
[https://github.com/georchestra/georchestra/issues](https://github.com/georchestra/georchestra/issues)
[https://github.com/geosolutions-it/MapStore2/issues](https://github.com/geosolutions-it/MapStore2/issues)

- **Supported architectures**:
[`amd64`](https://hub.docker.com/r/amd64/docker/)

- **Source of this description**:
[docs repo's directory](https://github.com/georchestra/mapstore2-georchestra/blob/master/DOCKER_HUB.md)

# What is `georchestra/mapstore`

**Mapstore** is a module for geOrchestra which offers
- an highly modular Open Source WebGIS framework to create, manage and securely share maps and mashups.



# 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 mapstore sub-directory.

It is recommended to use the official docker composition: https://github.com/georchestra/docker.

For this specific component, see the section `mapstore` 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 Dockerfile in `georchestra/georchestra-mapstore` 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.
Loading