This article describes how to generate a backup of the UniFi Controller as well as how to restore it. This article does not cover the Auto Backup feature. You may see this article for more information on that subject: UniFi - How to Configure Auto Backup.
NOTES & REQUIREMENTS:
This article is applicable to current UniFi Controller versions. Instructions on backups for older versions can be found at the end of this article. As always, we suggest you update to the newest UniFi Controller software available.
Table of Contents
Creating a UniFi Controller backup is an important practice that could save a network admin a lot of frustration. To ensure a backup is always handy, users should enable the Auto Backup feature. When generating a backup manually, a user can select to save only Controller Settings, which would include the config.properties and system.properties configuration files, maps, and any customized files in a site's hotspot portal folder; or include historical data as well.
Generating a New Backup
Users can generate a new UniFi backup file (
.unf) at any moment by going to Settings > Maintenance > Backup > Click Download Backup button. You can modify the Backup Data Retention to hold historical data (select the days), or to save your Settings only before downloading.
NOTE: The Backup Data Retention should not be confused with the Data Retention section, also under the Maintenance tab that allows users to determine the retention of information of the different time series shown in the Insights and Statistics sections of the Controller.
Restoring a Backup
Method 1: Restoring in the UniFi Controller
To restore a backup you have previously downloaded, log in to the UniFi Controller and follow these steps:
1. Go to Settings > Maintenance > Restore > Click Choose File button.
2. The file will load and you will be asked to confirm you wish to restore that backup.
3. Once you confirm, the backup restoration will begin. This process takes a few minutes, do not disconnect while the Controller is working on this. Once the new backup is restored, the Controller will restart.
Method 2: Restoring in the UniFi Startup Wizard
If beginning a new installation, it will be easier to just use the option of restore from a previous backup as soon as the UniFi Startup Wizard launches, and select your
Method 3: Restoring from the /data Directory
ATTENTION: This method is for older UniFi Controller versions and is not recommended. For security reasons, we suggest to always upgrade to the newest release available. If you still wish to use this method, click on the link below.
Click here to display Method 3: Restoring from the /data Directory.