Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

unifi_controller

Provisions Ubiquiti's network controller software
Project URLRSS FeedReport issues

7,067 downloads

6,919 latest version

3.4 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.1 (latest)
  • 0.1.0
released Jan 2nd 2017

Start using this module

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

Add this module to your Puppetfile:

mod 'jethrocarr-unifi_controller', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jethrocarr-unifi_controller
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jethrocarr-unifi_controller --version 0.1.1

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

jethrocarr/unifi_controller — version 0.1.1 Jan 2nd 2017

puppet-unifi_controller

Overview

Provisions the Unifi Controller software provided by Ubiquiti for configuring and managing their networking hardware.

Configuration

Currently this module is limited to installed a specific version of the server:

class { '::unifi_controller':
  app_version => '5.3.8', # pin specific version
}

If left unset, app_version will be updated semi-frequently to the latest version offered by Ubiquiti. If this isn't something you'd like, please pin the version either using the syntax above, or by using Hiera.

This module does not configure any kind of firewall, it is strongly recommended that you firewall this system heavily.

You may also wish to change the https port to be something more convenient (eg 443), if you change it from 8443, this module setups a firewall/NAT redirect from 443 to 8443, since the port can't be changed using any built in approach inside Unifi Controller itself. This requires the puppetlabs/firewall module.

Note, since this port change takes place in prerouting, you'll need to allow access to TCP/8443 regardless of what you change the port to in your iptables firewall rules.

Requirements

The currently listed GNU/Linux platforms at the Ubiquiti support page are supported by this module.

There is no RHEL/clone version or any platforms other than x86_64 because Ubiquiti don't provide any software/support for those platforms.

Limitations

Ubiquiti don't make the software available as a proper APT repo, so we can't (easily) do things like check for the latest version - so we currently pin to specific versions.

The downloads of their package come direct from their website, if they change their download methodology or packaging approach, this could break in future.

Contributions

All contributions are welcome via Pull Requests including documentation fixes or compatibility fixes for supporting other distributions (or other operating systems).

License

This module is licensed under the Apache License, Version 2.0 (the "License"). See the LICENSE or http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.