Git Product home page Git Product logo

fermentrack's Introduction

Fermentrack

Fermentrack Logo

Documentation Status

A replacement web interface for BrewPi

Fermentrack is an application designed to manage and log fermentation temperatures and specific gravity. It acts as a complete replacement for the web interface used by BrewPi written in Python using the Django web framework. It also can track Tilt Hydrometers and iSpindel specific gravity sensors - both alongside BrewPi controllers as well as by themselves.

Fermentrack is Python-based, does not require PHP5, and works with Raspbian Buster or later including on Raspberry Pi 3 B+. Fermentrack is intended to be installed on a fresh installation of Raspbian (or another Debian-based OS for x86/x64 installations) and will conflict with brewpi-www if installed on the same device.

Want to see it in action? See videos of key Fermentrack features on YouTube!

Included with Fermentrack

  • Fermentrack - Django-based fermentation tracking and control interface. Replaces brewpi-www. Licensed under MIT license.
  • brewpi-script - Installed alongside Fermentrack to control BrewPi controllers. Licensed under GPL v3.
  • nginx - A reverse proxy/webserver. Licensed under 2-Clause BSD-like license.
  • redis - A key/value store. Licensed under the three clause BSD license.
  • postgresql - A database server. Licensed under the Postgresql license.

New Features

One of the key reasons to write Fermentrack was to incorporate features that are missing in the official BrewPi web interface. The following are just some of the features that have been added:

  • Native multi-chamber support
  • Cleaner, more intuitive controller setup
  • Integrated support for ESP8266- and ESP32-based controllers
  • Official support for "legacy" controllers
  • Native support (including mDNS autodetection) for WiFi controllers
  • Integrated specific gravity sensor support, including for Tilt Hydrometers and iSpindel devices

A full table of controllers/expected hardware availability is available in the documentation.

Installation & Documentation

Full documentation for Fermentrack (including complete installation instructions) is available at https://docs.fermentrack.com/.

Quick Installation Instructions

  1. Set up your Raspberry Pi (Install Raspbian, enable SSH)
  2. Log into your Raspberry Pi via the terminal or SSH and run curl -L install.fermentrack.com | sudo bash
  3. Wait for the installation to complete (can take ~45 mins) and log into Fermentrack

Requirements

Fermentrack is designed to be run as part of a Docker compose stack and should be able to run on most armv7/armv8/x86/x64-based systems that are capable of running docker-compose. Most users, however, will install Fermentrack on a Raspberry Pi.

For Raspberry Pi-based Installs:

  • Raspberry Pi 2 B, 3, 4, 400, or later /w Internet Connection
  • 2GB of free space available
  • Fresh Raspberry Pi OS (Raspbian) install (Buster or later) preferred

For x86/x64-based Installs:

  • Debian-based systems preferred (e.g. Ubuntu, Debian, etc)
  • 2GB of free space available

fermentrack's People

Contributors

thorrak avatar stone avatar mp-se avatar vanosg avatar carjed avatar corbinstreehouse avatar huggableshark avatar rixth avatar johndoyle avatar nzkyle avatar akang6 avatar calandryll avatar garzlok avatar jjok avatar mtrepanier avatar speshak avatar reddishtg avatar zacharybussey avatar dependabot[bot] avatar lbussy avatar stix77 avatar uslackr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.