Archive notice: service is no longer used, as there were some API changes and we decided not to maintain this service further.
This repo contains a service that predicts the traffic for hamburg by regularly fetching data from the "Verkehrslage Hamburg" API. Predictions are created by calculating the average value for each hour of the day if possible. Historical data is strored up to 6 weeks.
The easiest way to run priobike-traffic-service is to use the contained docker-compose:
docker-compose up
The service is configured using environment variables. The following variables are available:
WORKER_HOSTThe host of the worker.WORKER_PORTThe port of the worker.WORKER_BASIC_AUTH_USERThe username for the basic auth.WORKER_BASIC_AUTH_PASSThe pwassword for the basic auth.
MANAGER_HOSTNAMEThe host of the worker.MANAGER_PORTThe port of the worker.BASIC_AUTH_USERThe username for the basic auth.BASIC_AUTH_PASSThe pwassword for the basic auth.
We use basic auth such that only the authorized manager can update the worker with the /upload/prediction.json files.
To upload a new prediction.json from the manager to the worker run a PUT request with basic authorization via:
http://{worker_ip}:{port}/upload/{file_path}
- This service can run in two modes: manager and worker. The worker mode is designed to face user traffic and can be scaled horizontally. Messages are synced between the worker and manager containers. See
docker-compose.ymlfor an example setup.
We highly encourage you to open an issue or a pull request. You can also use our repository freely with the MIT license.
Every service runs through testing before it is deployed in our release setup. Read more in our PrioBike deployment readme to understand how specific branches/tags are deployed.
Help us improve this documentation. If you have any problems or unclarities, feel free to open an issue.