Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.77 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.77 KB
Raw

gtfsrt2hfp Build .jar and publish Docker image

Application for producing HFP from GTFS-RT vehicle positions by matching third-party GTFS data to HSL GTFS data

Building

Gradle build system is used

  1. Run tests with ./gradlew test
  2. Run application with ./gradlew run
  3. Build runnable JAR with ./gradlew shadowJar

Usage

docker run -it --rm -v $(pwd)/application.properties:/application.properties hsldevcom/gtfsrt2hfp:develop -f /application.properties

Configuration

Create configuration file, which will be mounted to the Docker container (see above):

gtfs.url.a = https://dev.hsl.fi/gtfs/hsl.zip #HSL GTFS feed
gtfs.url.b = https://minfoapi.matkahuolto.fi/gtfs/067/gtfs.zip #GTFS feed corresponding to the GTFS-RT feed

gtfsRt.url = #GTFS-RT feed URL
gtfsRt.apiKey = #API key for GTFS-RT feed

mqtt.brokerUri = #MQTT broker URI

routeIds = 7280 #Route IDs from HSL GTFS feed for which HFP is produved

hfp.operatorId = 9999 #Operator ID which will be used in HFP messages

Alternatively, environment variables can be used for configuration. See file env.properties in the resources folder.

Versioning

This application uses calendar versioning with the following pattern: YYYYMMDD. New versions can be published by creating a release in GitHub. The Docker image of this application uses develop tag for the latest build of master branch and latest tag for the latest build made from a tagged commit. Specific versions are also available with the same Docker tag as the Git tag of the version.