UniFi Controller on a Synology

I've been using Ubiquiti's UniFi wireless access points for a few years around home. Until now I've only used the UniFi Controller application on an as-need basis (when setting the configuration or installing updates). But having the Synology DS1621xs on hand gives me an opportunity to try out its Docker support and in particular being able to run UniFi Controller continuously in a Docker container on the Synology.

I say 'UniFi Controller' but I gather that as of version 6.2 they've renamed it to 'UniFi Network Application'. Same software, just an updated name.

Installing Docker on the Synology

1. Open the Package Center
2. Select All Packages and scroll down to the Third-party section

3. In the 'Docker' package click Install

   

4. When installation has completed, the button changes to Open. Click on it to open the Docker UI.
5. The first time you open Docker a welcome screen message is displayed. Select Don't show this again and close the message.
6. Docker is now running on your Synology

Installing UniFi Controller

1. Select the Registry page.

   

2. In the search bar enter unifi and click Search.

3. Double-click on the jacobalberty/unifi image.

   

4. You now need to select a tag. Review the options to understand what the different tag values mean. (Choose latest to go with the latest stable version).
5. The image is now being downloaded.
6. Go to the Image page.
7. When the download has completed, the Launch button will be enabled. Click on Launch.

8. If desired, you can customise the Container Name.

   

9. Select Enable resource limitation.
10. Click on Advanced Settings.

11. Select Enable auto-restart.

    

12. Select Volume tab and click Add Folder.
13. Select the docker folder and then click on Create Folder.
14. Enter unifi and click OK.
15. Click Select.

16. In the Mount path column, enter /unifi. (See Volumes for volumes used by this image).

    

17. Select Network tab and select use the same network as Docker Host.

    

18. It is recommended to not run this image as root. Go to the Environment tab.
19. Change the value of RUNAS_UID0 to false.

20. As we will be binding to a port > 1024, we can also set the value of BIND_PRIV to false.

    

21. Click Apply.
22. Click Next.

23. Review the Summary details, then if they look correct click Apply.

    

24. Select the Container page.

25. You can see the UniFi image is now running in a container.

    

If you have the Synology Firewall enabled, you will need to allow access to the application, the port needs to be opened in the Synology Firewall. In my case because I hadn't exposed the Synology directly to the Internet, the firewall was disabled. I figured it was probably a good idea to enable the firewall.

From the Ports documentation there are a number of TCP and UDP ports to select.

1. Go to the Synology main menu and select Control Panel.
2. Select Advanced Mode and click on Security.

3. In the Firewall tab, select the custom profile and click Edit Rules.

   

4. Click Create and under Ports select Custom and then click on Custom.
5. Ensure Protocol is set to TCP.

6. In the Ports field enter 8080,8443,8843,8880,6789.

   

7. Click OK, and OK
8. Click Create and under Ports select Custom and then click on Custom.
9. In Protocol select UDP.

10. In the Ports field enter 3478.

    

11. Click OK, and OK
12. Click OK to save the firewall profile changes.
13. If it is highlighted, click Apply to save firewall changes.

Accessing UniFi Controller

1. Navigate to https://your-synology-box:8443/ (replacing your-synology-box with the DNS name of your Synology).
2. As the UniFi Controller comes with a self-signed TLS certificate you'll need to tell your browser to trust the certificate.
3. After this you should see the UniFi start-up wizard. If this is the first time you've used the software, proceed through the wizard following the steps. Alternatively (like me) if you're migrating from another installation you can click the or restore setup from backup to upload a back from the old system.

And with that you should be good to go!

Final thoughts

The ability to run Docker containers on a Synology is a great advantage. The UI is easy to use but flexible enough to allow you to run useful Docker images. Do check out my review of the DS1621xs, and check it out on amazon.com or amazon.com.au

Acknowledgements

• There are quite a few different Docker images for running UniFi. Thanks to Simon Waight for the suggestion of https://github.com/jacobalberty/unifi-docker.
• Ruud's instructions which formed the basis of the steps I followed here.