Skip to content

Latest commit

 

History

History
127 lines (88 loc) · 6.56 KB

README.md

File metadata and controls

127 lines (88 loc) · 6.56 KB
Raw

OneBusAway Docker Images

Official Docker images GitHub Actions Workflow Status

This repository contains scripts and configuration for building version 2 of the OneBusAway Application Suite for use with Docker.

Deploying to a cloud provider?

Check out our onebusaway-deployment repository, which features OpenTofu (Terraform) IaC configuration for deploying OneBusAway to AWS, Azure, Google Cloud Platform, Render, Kubernetes, and other platforms.

Deploy to Render

Render is an easy-to-use Platform-as-a-Service (PaaS) provider. You can host OneBusAway on Render by either manually configuring it or by clicking the button below.

Deploy to Render

Running in Kubernetes

Learn more about running OBA in Kubernetes in the dedicated README.

Running locally

To build bundles and run the webapp server with your own GTFS feed, use the Docker Compose services in this repository.

Building the app server

The app server and bundle builder use Maven artifacts from GitHub's Maven package registry, which unfortunately requires authentication. This is provided in the form of a pair of environment variables that must be supplied when building the app server image:

docker compose build oba_app

Building bundles

To build a bundle, use the oba_bundler service:

GTFS_URL=https://www.soundtransit.org/GTFS-rail/40_gtfs.zip \
docker compose up oba_bundler

This process will create all necessary bundle files and metadata, and all will be accessible in your local repo's ./bundle directory.

When the GTFS_URL is unspecified, oba_bundler will download and use the GTFS data for Davis, CA's Unitrans service. This can be used with the bin/validate.sh script to verify that the stack is working correctly.

docker compose up oba_bundler

Running the OneBusAway server

Once you have built an OBA bundle inside ./bundle, you can run the OBA server and make it accessible on your host machine with:

docker compose up oba_app

You will then have two web apps available:

When done using this web server, you can use the shell-standard ^C to exit out and turn it off. If issues persist across runs, you can try using docker compose down -v and then docker compose up oba_app to refresh the Docker containers and services.

Inspecting the database

The Docker Compose database service should remain up after a call of docker compose up oba_app. Otherwise, you can always invoke it using docker compose up oba_database.

A database port is open to your host machine, so you can connect to it programmatically using mysql:

mysql -u oba_user -p -h localhost:3306

Deployment

Published Images

You can find the latest published Docker images on Docker Hub:

  • onebusaway-bundle-builder - This image is built from the bundler directory and contains the functionality needed to create a transit data bundle from a GTFS feed.
  • onebusaway-api-webapp - This image is built from the oba directory and contains the functionality needed to run the OBA API webapp.

Deployment Parameters

  • Database
    • JDBC_URL - The JDBC connection URL for your MySQL or PostgreSQL database.
    • JDBC_DRIVER - The JDBC driver class name: com.mysql.cj.jdbc.Driver or org.postgresql.Driver
    • JDBC_USER - The username for your database.
    • JDBC_PASSWORD - The password for your database.
  • GTFS (Optional, required only when using oba_app independently)
    • GTFS_URL - The URL to the GTFS feed you want to use.
  • GTFS-RT Support (Optional)
    • TZ - The timezone for the server. Ensure that the server's timezone matches the timezone specified in your static GTFS agency.txt file. The timezone format is the IANA standard, and a full list of timezones can be found on Wikipedia.
    • ALERTS_URL - Service Alerts URL for GTFS-RT.
    • TRIP_UPDATES_URL - Trip Updates URL for GTFS-RT.
    • VEHICLE_POSITIONS_URL - Vehicle Positions URL for GTFS-RT.
    • REFRESH_INTERVAL - Refresh interval in seconds. Usually 10-30.
    • AGENCY_ID - Your GTFS-RT agency ID. Ostensibly the same as your GTFS agency ID.
    • Authentication (Optional)
      • Example: Specifying FEED_API_KEY = X-API-KEY and FEED_API_VALUE = 12345 will result in X-API-KEY: 12345 being passed on every call to your GTFS-RT URLs.
      • FEED_API_KEY - If your GTFS-RT API requires you to pass an authentication header, you can represent the key portion of it by specifying this value.
      • FEED_API_VALUE - If your GTFS-RT API requires you to pass an authentication header, you can represent the value portion of it by specifying this value.

The GTFS-RT related variables will be handled by the oba/bootstrap.sh script, which will set the config files for the OBA API webapp. If you want to use your own config files, you could set USER_CONFIGURED=1 in the oba_app service in docker-compose.yml to skip bootstrap.sh and write your config file in the container.

  oba_app:
    container_name: oba_app
    depends_on:
      - oba_database
    build:
      context: ./oba
    environment:
      # database configs are read from environment variables
      - JDBC_URL=jdbc:mysql://oba_database:3306/oba_database
      - JDBC_USER=oba_user
      - JDBC_PASSWORD=oba_password
      # change this to your GTFS url
      - GTFS_URL=https://unitrans.ucdavis.edu/media/gtfs/Unitrans_GTFS.zip
      # skip bootstrap.sh and use user-configured config files
      - USER_CONFIGURED=1