docker: add usage explanations #4421
Conversation
Explain how to use the docker images. May then be linked to at https://grass.osgeo.org/download/docker/
neteler
added
the
backport to 8.4
|
Question: keep "8.4." also in |
| ```bash | ||
| docker run -it --rm -e DISPLAY=$DISPLAY \ | ||
| -v /tmp/.X11-unix:/tmp/.X11-unix \ | ||
| osgeo/grass-gis:releasebranch_8_4-ubuntu_wxgui grass | ||
| ``` |
There was a problem hiding this comment.
Is it clear that it won't work for windows (when not running through a WSL)?
There was a problem hiding this comment.
We may add Windows usage instructions (I'd rely on others to suggest them).
| ```bash | ||
| docker run -it --rm -v "$(pwd):/data" osgeo/grass-gis:releasebranch_8_4-alpine grass | ||
| ``` |
There was a problem hiding this comment.
Won't work with Windows cmd.exe, might work with powershell (pwsh).
docker/README.md
Outdated
| # GRASS GIS docker | ||
|
|
||
| ## GRASS GIS docker matrix | ||
| ## GRASS GIS 8.4 (current) Docker installation and usage |
There was a problem hiding this comment.
Is there a way to not have to change this too when changing versions?
There was a problem hiding this comment.
Indeed, including a version anywhere (including the code examples below) slows the release process (here specifically the branching) adding time which at this point a human needs to spend.
| **Running:** | ||
|
|
||
| ```bash | ||
| docker run -it --rm osgeo/grass-gis:releasebranch_8_4-debian grass -c EPSG:4326 /tmp/grassproject | ||
| ``` |
There was a problem hiding this comment.
This is the same for every image except for the tag. Too much stuff to read and maintain. Is there an example how other projects are addressing that?
There was a problem hiding this comment.
| @@ -25,4 +24,119 @@ the table above): | |||
| docker pull osgeo/grass-gis:<tag> | |||
| ``` | |||
|
|
|||
| ## Provided images | |||
There was a problem hiding this comment.
Why to have a list of images here? They are on the Docker hub and the website. This looks like user-facing doc, which is exactly what Docker hub and website are trying to cover, no?
There was a problem hiding this comment.
Honestly, I did not remember that it is also in the main README. I simply looked next to Docker.
Sure: I tried to implement your suggestion: OSGeo/grass-website#470 (comment) Rationale: the web site (https://grass.osgeo.org/download/docker/) does not contain any usage info. My goal is to be less nerdy and lower the barrier to using our docker images. |
I would reduce it there and point to this README. |
Explain how to use the docker images.
Rationale: the web site (https://grass.osgeo.org/download/docker/) does not contain any usage info (see also OSGeo/grass-website#470). My goal is to be less nerdy and lower the barrier to using our docker images.