Kegbot Project Docs#

Welcome to the Kegbot Project documentation index. This is the place where the official documentation for each Kegbot component lives.

For a more general overview, please head over to the Kegbot Project Home Page.

Documentation Index#

Kegbot Server Documentation: Documentation for Kegbot Server, the brains of any Kegbot system. A great place to start if you’re just building a Kegbot.
Kegboard Documentation: Information about building, flashing, and using Kegboard, our open source keg monitor firmware. Kegboard reads flow meters and reports sensor data to Kegbot Server.

Getting Help#

Kegbot is a community-supported project, built and maintained by volunteers.

For help and pointers, the best place to start is The Kegbot Discussion Forum, where you can also search and browse previous discussions.

Contributing#

We’d love your help and contributions! Please visit the Developers Forum for the latest information.

Legal#

Unless otherwise noted, all Kegbot project code and assets are licensed under the MIT License, which has the following terms:

Copyright 2003-2022 The Kegbot Project Contributors <info@kegbot.org>

Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

In addition to being our project name, “Kegbot” is a trademark. Please don’t use it for other projects without our permission.