Forge Home

mfi

Module to manage the mFi controller

9,498 downloads

9,498 latest version

2.2 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.0 (latest)
released Aug 13th 2014

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'jasper-mfi', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jasper-mfi
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jasper-mfi --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

jasper/mfi — version 0.1.0 Aug 13th 2014

mfi

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with mfi
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This module manages the mFi home automation software which is a standalone Tomcat application meant to be used a desktop application. This module only works for the unix package.

Usage

There is generally little to configure, aside from the HTTP(s) ports:

  • unifi_http_port defaults to 6080
  • unifi_shutdown_port defaults to6081
  • unifi_https_port defaults to6443
  • portal_http_port defaults to6880
  • portal_https_port defaults to6843

Proxy

One may want to operate a proxy in front of mFi, such as nginx. This is documented on my blog.

Reference

Limitations

Currently only tested on OpenBSD with an uncommitted port for mfi. Please submit a pull request to add support for other platforms.

Copyright

2014 Jasper Lievisse Adriaanse jasper@humppa.nl Released under the terms of the MIT license, please see LICENSE

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request