docs: add docker instructions #842
Conversation
|
So I actually tried to add a badge for the Docker image workflow (the latest was successfully executed according to https://github.com/MobilityData/gtfs-validator/actions/runs/684309427), but in this PR the badge seems to indicate the contrary. See: I tried using the branch or events parameters, but no success. @barbeau @maximearmstrong have you experienced that before? Should I use another mechanism to get this badge in a correct state? Also could this be caused by the fact that I am working on a branch and it would be automatically fixed when this branch is merged to |
There was a problem hiding this comment.
Thanks @lionel-nj! Looks good generally, although I'm having issues with the sharing files part - not sure if that's a problem on my end.
Also could this be caused by the fact that I am working on a branch and it would be automatically fixed when this branch is merged to master ?
Possibly - I would say let's merge it and see if it's still showing as "fail", and open another issue if so.
| ### Run it | ||
|
|
||
| To run the Docker image in a new container: | ||
| `docker run -v /myDirectory:/theContainerDirectory -it ghcr.io/mobilitydata/gtfs-validator:v2.0.0` |
There was a problem hiding this comment.
This doesn't seem to work for me on Windows 10 :(. I tried:
docker run -v /git-projects/gtfs-validator/output:/output -it ghcr.io/mobilitydata/gtfs-validator:v2.0.0
With this, I can execute the validator and pull GTFS files from a URL, but I can't see the GTFS zip file that's on my desktop in Docker, and I can't see the validator output on my desktop. Any idea why this wouldn't work?
There was a problem hiding this comment.
/git-projects/gtfs-validator/output:/output this would only give you access to what's inside /git-projects/gtfs-validator/output on your local machine, from output in the Docker container.
To see what's on your desktop from output (in the container), you would have to replace /git-projects/gtfs-validator/output by the/path/to/your/desktop/.
There was a problem hiding this comment.
The /git-projects/gtfs-validator/output path is on my local computer. And I'm trying to use the folder output within the Docker container.
My understanding is that with:
docker run -v /git-projects/gtfs-validator/output:/output -it ghcr.io/mobilitydata/gtfs-validator:v2.0.0
If I put gtfs.zip in my local computer folder /git-projects/gtfs-validator/output, then within the container I should be able to do:
cd output
ls
...and it should show gtfs.zip within that folder.
Similarly, if I run the validator within the container and write results.json to the container output folder, then I should be able to see that file locally on my computer at /git-projects/gtfs-validator/output.
Is the above correct, or am I understanding this wrong?
There was a problem hiding this comment.
Is the above correct, or am I understanding this wrong?
Correct!
There was a problem hiding this comment.
Ah - it looks like on Windows I have to provide the drive letter too - so while the above didn't work, this does:
docker run -v c:/git-projects/gtfs-validator/output:/output -it ghcr.io/mobilitydata/gtfs-validator:v2.0.0
Does it work on your machine with a drive letter too? If so I'd recommend updating the example to include a drive letter so it works out-of-the-box for Windows users.
There was a problem hiding this comment.
Does it work on your machine with a drive letter too?
Unfortunately no. Will update the docs as suggested. Thanks @barbeau.
Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
…dator into lionel-nj-patch-1
Investigating this, I just asked @maximearmstrong if he was able to do so.
👍🏾 |
Summary:
This PR adds documentation to run the validator using a Docker environment.
Please make sure these boxes are checked before submitting your pull request - thanks!
[ ] Run the unit tests withgradle testto make sure you didn't break anything[ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)