The OneBusAway Application Suite Java CI with Maven Join the OneBusAway chat

A project of the non-profit Open Transit Software Foundation!

The OneBusAway application suite's primary function is to share real-time public transit information with riders across a variety of interfaces:

Watch the YouTube video for more information.

Getting Started

Here are the high-level steps you'll need to take to launch the OneBusAway mobile apps in your area:

  1. Get your schedule transit data in the GTFS format
  2. Have an AVL system that produces arrival estimates (Note: we're working removing this requirement - contact us if you're interested. Alternatively, you may be able to use other open-source projects, such as The Transit Clock, to go directly from raw vehicle locations to arrival times that are shared via GTFS-realtime and SIRI - this would replace Steps 2 and 3.)
  3. Implement a GTFS-realtime or SIRI real-time data feed (We also support other formats)
  4. Set up a OneBusAway server
  5. Do some quality-control testing of arrival times
  6. Request to be added as a OneBusAway region

See the multi-region page for more details.

Setting up a OneBusAway server

There are two options for setting up your own OneBusAway instance:

Development Instructions with Docker

docker compose up builder

# Now, open another window or tab and continue running commands:

# acquaint yourself with the make options
bin/make --help 

# build the project
bin/make

# now you have built all of the OBA artifacts, which can be found in the `/root/.m2/repository` directory.

# enter the docker container and look around
bin/shell 
ls /root/.m2/repository # this runs inside the docker container

# exit the docker container
exit 

# Build a data bundle, which will power the OBA server:
bin/build_bundle

# Finally, copy all of the built WAR resources into /usr/local/tomcat
bin/copy_and_relaunch

# wait a few seconds for everything to spin up...

Finally, verify that everything works as expected!

GTFS Data

By default, the development server is configured to use static and real-time data from the Seattle area transit agency, King County Metro.

Change your Data Source, Step by Step

  1. Delete the contents of ./docker_app_server/bundle (i.e. run the command rm -rf ./docker_app_server/bundle/*)
  2. Update the GTFS_URL value in docker-compose.yml (See Static Data Changes for more)
  3. Update the contents of ./docker_app_server/config/onebusaway-transit-data-federation-webapp-data-sources.xml as described in Realtime Data Changes
  4. In a separate terminal, launch the builder service: docker compose up builder
  5. From the root of the repository run the following commands:
  1. If necessary, restart the builder service: Ctrl+C and then docker compose up builder

Static Data Changes

./docker-compose.yml:

Realtime Data Changes

In the file ./docker_app_server/config/onebusaway-transit-data-federation-webapp-data-sources.xml, change the following properties:

Note: if the GTFS-RT feeds require a header-supplied API key, also modify the headersMap property thusly:

<property name="headersMap">
  <map>
    <entry key="{API KEY PROPERTY NAME}" value="{API KEY PROPERTY VALUE}" />
  </map>
</property>

for example:

<bean class="org.onebusaway.transit_data_federation.impl.realtime.gtfs_realtime.GtfsRealtimeSource">
    <property
      name="tripUpdatesUrl"
      value="https://gtfsbridge.spokanetransit.com/realtime/TripUpdate/TripUpdates.pb"
    />
    <property
      name="vehiclePositionsUrl"
      value="https://gtfsbridge.spokanetransit.com/realtime/vehicle/VehiclePositions.pb"
    />
    <property
      name="alertsUrl"
      value="https://gtfsbridge.spokanetransit.com/realtime/Alert/Alerts.pb"
    />
    <property name="refreshInterval" value="30" />
    <property name="agencyId" value="STA" />
    <property name="headersMap">
      <map>
          <entry key="X-API-KEY" value="12345" />
      </map>
    </property>
</bean>

Debugging

VSCode

  1. Make sure that you have completed all of the earlier steps and that this endpoint loads in your browser: http://localhost:8080/onebusaway-api-webapp/api/where/config.json?key=test
  2. Install these extensions:
  1. Set breakpoints in the code file that you want to debug. If you're just getting started, we recommend that you set a breakpoint in onebusaway-api-webapp/src/main/java/org/onebusaway/api/actions/api/where/ConfigAction.java in the index() method.
  2. Open the Run and Debug tab in VSCode, make sure that the debug target dropdown lists Debug (Attach).
  3. Click the Start Debugging button.
  4. Open your web browser and navigate to the API action where you have set a breakpoint. If you have set a breakpoint in ConfigAction.java, navigate to http://localhost:8080/onebusaway-api-webapp/api/where/config.json?key=test

Deploy OneBusAway

Deployments

OneBusAway is used in a number of places:

Check out the full list on the OneBusAway Deployments page. Check out the main project page at http://onebusaway.org.

Download

Build and Deploy OBA Artifacts to Maven Central

  1. Set up your environment, including GPG
  2. Run the command mvn deploy -DskipTests
  3. Upload the Zip file at ./target/central-publishing/central-bundle.zip to Maven Central's publishing page.
    • The Zip file is about 600MB in size. Be sure to have a fast, reliable connection.

Open questions and issues:

Developer Information

Contact Info

There are lots of ways to get in touch with us.