farmOS-aggregator icon indicating copy to clipboard operation
farmOS-aggregator copied to clipboard

A microservice application for aggregating data from multiple farmOS instances.

farmOS-aggregator

Licence Release pipeline status Docker Last commit Chat

farmOS-aggregator is a microservice application for interacting with multiple farmOS instances. The application provides a GUI for registering farmOS instances with the Aggregator and a REST API for interacting with farmOS instances. Depending on how an Aggregator is configured, farmOS admins will authorize access to only a subset of their farm's data.

farmOS-aggregator is built with:

  • FastAPI for the REST API
  • farmOS.py client library for querying farmOS instances

For more information on farmOS, visit farmOS.org.

Documentation

  • Using the farmOS-aggregator: docs/using-farmos-aggregator.md
  • Configuring a farmOS-aggregator: docs/configuration.md
  • Deploying a farmOS-aggregator: docs/deployment.md
  • API Documentation: docs/api.md
  • Development: docs/development.md

FAQ

What are the motivations for creating farmOS-Aggregator?

Does this make all of my farmOS data available to the public?

No.

I have awesome farm data stored in my farmOS server! Are there any Aggregators that I can share my data with?

MAINTAINERS

  • Paul Weidner (paul121) - https://github.com/paul121

This project has been sponsored by: