From 832a5ce74b88a72b85284f368550798149abc267 Mon Sep 17 00:00:00 2001 From: Ville Pihlava Date: Thu, 19 Dec 2024 14:22:31 +0200 Subject: [PATCH] Add documentation about docker images. --- docs/index.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/index.md b/docs/index.md index f30d3357..07dac498 100644 --- a/docs/index.md +++ b/docs/index.md @@ -45,6 +45,21 @@ ``` +## Docker images + +There are automatically generated docker images available at https://registry.hub.docker.com/u/opentransitsoftwarefoundation. +Contributions to image-specific documentation are welcome. + +### `onebusaway-gtfs-transformer-cli` + +See [the full documentation](./onebusaway-gtfs-transformer-cli.md) for more configuration options. + +For example, assuming that all the following files are in the `/path/to/local/data/directory` directory, to run the `remove-matching-route.rule` rule against `gtfs-data.zip` to generate `gtfs-data-out.zip` you can use: +```bash +docker run -v /path/to/local/data/directory:/data --rm opentransitsoftwarefoundation/onebusaway-gtfs-transformer-cli:4.4.0 --transform=/data/remove-matching-route.rule /data/gtfs-data.zip /data/gtfs-data-out.zip +``` +The `gtfs-data-out.zip` file will be in the `/path/to/local/data/directory` directory. + ## Example Code * Basic Reading