Skip to content

Commit

Permalink
Merge pull request #314 from VillePihlava/add-docker-documentation
Browse files Browse the repository at this point in the history
Add documentation about docker images
  • Loading branch information
leonardehrenfried authored Dec 19, 2024
2 parents 04746be + 832a5ce commit a52c1e4
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@
</dependencies>
```

## 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
Expand Down

0 comments on commit a52c1e4

Please sign in to comment.