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.

Sign up for GitHub

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 documentation about docker images #314

Merged
merged 1 commit into from
Dec 19, 2024
Merged

Add documentation about docker images #314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/index.md
View file
Open in desktop
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
Loading