Getting Started
Welcome to UniFi!
This article is not meant to be a comprehensive list of everything UniFi, but rather a collection of stepping stones to get started in the most informed way possible. After reading this guide, along with the linked related articles, users should take a look at the UniFi User Guide, which will provide descriptions for each section of the UniFi Controller.
Table of Contents
- Methods for Managing a UniFi Network
- Important Accounts and Passwords
- Device Setup
- Set up an Email Service (Forgot Password?)
- Related Articles
Methods for Managing a UniFi Network
Managing a UniFi network can be done on a variety of hosts. Below are the different platforms that are supported by Ubiquiti along with documentation to help you get started with it.
Platforms
- UniFi Cloud Key: UniFi User Guide: UniFi Cloud Key
- On a computer with a supported OS: macOS, Windows and Windows Server and Debian-based Linux: UniFi - How to Install & Upgrade the UniFi Controller Software
- You can also manage the Controller via the mobile app, but the controller will need to be hosted in one of the three options above: UniFi Mobile App (Android & iOS)
- Standalone Mobile App mode, which does not use the UniFi Network Controller, hence there is no hosting necessary. There are some disadvantages to this mode, take a look here: Standalone Management (UAP only)
Important Accounts and Passwords
There will be several different sets of credentials associated with UniFi and the Ubiquiti account. It is important to take note of these during installation. The following article goes in detail about all the accounts, usernames and passwords a UniFi user might encounter. It is a good idea to identify the different sets of credentials before creating them to avoid confusion later. See all about that here: UniFi - Accounts and Passwords for Controller, Cloud Key, and Other Devices
Device Setup
UniFi Devices Generation
For initial device setup, as well as checking setup requirements before you begin, use each product's Quick Start Guide (QSG). For the most complete list of specifications available for each product, check the device's Data Sheet (DS). All products that have individual product pages will have a link at the very bottom of the page to download both the QSG and the DS. In the table below, each product model contains its product page link. For products that don't have individual product pages, the Data Sheet and Quick Start Guide links are provided.
|
Generation 1 Devices |
Generation 2 Devices (AC Wave 1) |
Generation 3 Devices (AC Wave 2) |
|
* End of Life (EoL) and unsupported as of UniFi Network Controller version 5.7. Download here most current Controller version compatible (v5.6.40 LTS).
|
UniFi Switch (US models) |
UniFi Switch (USW models) |
|
|
|
UniFi Routing & Firewall |
|
UniFi Controller Hardware |
Adopting UniFi Devices
UniFi - How to: UniFi Device Adoption
UniFi - How to Adopt a USG into an Existing Network (to be used only when the USG will replace the working, current router in a network).
Upgrading UniFi Devices' Firmware and the UniFi Network Controller Software
It is important to note that there are two updates you will be performing on UniFi. The device firmware, which if you navigate to our Downloads page you will see it is a .tar file for the USGs and a .bin file for all other devices. And the UniFi Network Controller software which will be an .exe, .pkg, or .deb file depending on where you are hosting the controller (Windows, macOS and Debian/Linux or UniFi Cloud Key respectively). So for example, for the UniFi Cloud Key, you will have the need to update it's firmware (.bin file) and its software (.deb file).
UniFi - Changing the Firmware of a UniFi Devices: device firmware upgrade (or downgrade) via UI and SSH. Does not include Cloud Keys.
UniFi - How to Install & Upgrade the UniFi Controller Software: software upgrade on controllers hosted on macOS, Windows and Debian/Linux systems. Does not include Cloud Keys.
UniFi - How to Manage & Upgrade the Cloud Key: firmware and software upgrade via the webUI (controller and UCK management platform).
UniFi - How to Change the Cloud Key's Controller Version via SSH: software upgrade (or downgrade) for Cloud Key hosted controllers via SSH.
Set up an Email Service (Forgot Password?)
Setting up an email service such as SMTP through Gmail can assist in situations where cloud access is not enabled and an admin password has been forgotten. If cloud access has been enabled, the login can be attained through the UniFi Cloud Access Portal (https://unifi.ui.com). This step needs to be completed to use the Forgot Password? option.
UniFi - How To Use a Free Email Service as SMTP Server (Gmail)