A script that installs the UniFi Controller LTS version software on pfSense and other FreeBSD systems
The objective of this project is to develop and maintain a script that installs Ubiquiti's UniFi Controller software on FreeBSD-based systems, particularly the pfSense firewall.
The project provides an rc script to start and stop the UniFi controller, and an installation script to automatically download and install everything, including the rc script.
This project uses the latest branch from Ubiquiti rather than the LTS branch.
Because the UniFi Controller software is proprietary, it cannot be built from source and cannot be included directly in a package. To work around this, we can download the UniFi controller software directly from Ubiquiti during the installation process.
Because Ubiquiti does not provide a standard way to fetch the software (not even a "latest" symlink), we cannot identify the appropriate version to download from Ubiquiti programmatically. It will be up to the package maintainers to keep the package up to date with the latest version of the software available from Ubiquiti.
This project itself is licensed according to the two-clause BSD license.
The UniFi Controller software is licensed as-is with no warranty, according to the README included with the software.
Ubiquiti has indicated via email that acceptance of the EULA on the web site is not required before downloading the software.
At the very least, backup your configuration before proceeding.
Be sure to track Ubiquiti's release notes for information on the changes and what to expect. Updates, even minor ones, sometimes involve database upgrades that can take some time. Features come and go, and behaviors change. Proceed with caution.
If you are still on 3.2, you should know by now that upgrading will be no small task, as the current software is many generations ahead of you. Proceed with caution.
To install the controller software and the rc script:
- Log in to the pfSense command line shell as root.
- Run this one-line command, which downloads the install script from Github and executes it with sh:
fetch -o - https://git.io/fNmKR | sh -s
The install script will install dependencies, download the UniFi controller software, make some adjustments, and start the UniFi controller.
The git.io link above should point to https://raw.githubusercontent.com/pistacchione/unifi-pfsense/master/install-unifi/install-unifi.sh
To start and stop the controller, use the service command from the command line.
-
To start the controller:
service unifi.sh startThe UniFi controller takes a few minutes to start. The 'start' command exits immediately while the startup continues in the background.
-
To stop the controller:
service unifi.sh stopThe the stop command takes a while to execute, and then the shutdown continues for several minutes in the background. The rc script will wait until the command received and the shutdown is finished. The idea is to hold up system shutdown until the UniFi controller has a chance to exit cleanly.
The main area of concern is keeping up with Ubiquiti's updates. I don't know of a way to automatically grab the URL to the current version; UBNT posts updates only to their blog and their forums, and they don't seem to have a link alias to the current release. That means we have to commit an update directly to the install.sh script with every release.
If you're aware of an update before I am:
- Create a branch from master, named for the version you are about to test.
- Update the URL in install.sh to the latest version.
- Test it on your pfSense system.
- Optional, but ideal: test it on a fresh pfSense system, as in a VM.
- If it checks out, submit a pull request from your branch. This helps bring my attention to the update and lets me know that you have tested the new version.
I will then test on my own systems and merge the PR.
Other enhancements are most welcome. Much of the script's most intelligent behavior is the work of contributors, including the package dependency resolution and the java version spoofing. This project would not be alive without these efforts. I am excited by this support, and I can't wait to see what else develops.
Potential areas of improvement include but are not limited to:
- Error handling
- Automatic latest-version detection
- More robust backup and restore
- LTS/Latest branch selection options and defaults. Command line options? Prompts?
- What else?
Of course. That's why it's on github.
This project may never reach its original goal of becoming a pfSense package. The packaging scheme for pfSense has changed. Doing this as a pfSense package requires doing it as a FreeBSD package first. Doing it as a FreeBSD package means we may as well make it portable to other FreeBSD systems. All of this changes how this would be implemented. Some of the concepts we can borrow, but it's substantially new work. Moreover, because the requirements of the UniFi controller deviate from what's strictly available in the FreeBSD package repos, I'm not even sure it's possible.
As a helper script for installing the UniFi controller, this tool remains effective and robust, which is great. I see no reason not to continue development here.
It is also less pfsense-specific than originally imagined. If you're here to run UniFi on your NAS, welcome!
With all this in mind, the future of this project is clearly as an installation tool, and I envision enhancements to it as such. So let's just make it a smart and capable installer for UniFi Controller on FreeBSD-type systems.