UNMS - Installation & Update

 Overview


This article describes how to install a fresh copy of UNMS on your server, or update an existing installation. This is a guide for a Linux installation, see the following note for Windows and OS X users:

book_25x25.png  NOTES & REQUIREMENTS:

Unfortunately, Docker does not provide full support for Windows and OS X systems, so we can't ensure proper operation of UNMS, smooth backups and upgrades. At this time we recommend that you install VirtualBox with the latest version of Ubuntu 16.04.1 LTS (Xenial Xerus) and then follow the Linux instructions provided below.

Table of Contents

1. Prerequisites

2. Installation Instructions

3. Manual update Instructions (optional)

4. Managing the SSL certificate for access via HTTPS (optional)

5. Changing the HTTP and HTTPS ports (optional)

6. Changing the device inform port (optional)

7. Running UNMS behind a reverse proxy (optional)

8. Changing the UNMS container's IP address (optional)

9. Cloud

10. UNMS Data

11. Devices Latency and Outage Statistics

12. Installing prerequisites

13. Related Articles


Prerequisites


Back to Top


Installation Instructions


Back to Top

Run the command below on the host to install and start UNMS (it will automatically install Docker if it is not installed already). If a UNMS installation already exists, it will be overwritten, but all data will be kept. When the process is complete, you can access UNMS at http://server_hostname_or_ip/. Please don't use localhost. Use server hostname or its IP address. You can register your devices to UNMS by following this article: UNMS - How to Register Devices to UNMS (coming soon).

$ curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UNMS/master/install.sh > /tmp/unms_install.sh && sudo bash /tmp/unms_install.sh

Manual update Instructions (optional)


Back to Top

Starting with UNMS version 0.7.14, we have introduced a one-click update option in the UI. When a new version is available, you will be able to install the update by clicking a button in the new version notification dialog or under Settings/Maintenance.

But you can also run this command on the host to reinstall/update to the latest version manually:

$ curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UNMS/master/install.sh > /tmp/unms_install.sh && sudo bash /tmp/unms_install.sh --update

Updating the app will preserve all configuration (custom ports, SSL certificates, etc.). If you wish to change those settings, please follow the Installation Instructions above and specify all settings again.


Managing the SSL certificate for access via HTTPS (optional)


Back to Top

By default, UNMS uses Let's Encrypt to automatically create and manage an SSL certificate for its domain name. The certificate is saved under  /home/unms/data/cert/live . Use installation script arguments  --ssl-cert-dir <DIRECTORY>  --ssl-cert <FILENAME>  --ssl-cert-key <FILENAME>  and optionally  --ssl-cert-ca <FILENAME>  to manage the certificate manually.

$ curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UNMS/master/install.sh > /tmp/unms_install.sh 
$ sudo bash /tmp/unms_install.sh --ssl-cert-dir /etc/certificates --ssl-cert fullchain.pem --ssl-cert-key privkey.pem

Make sure that the UNMS has read permission on the certificate directory and all files.


Changing the HTTP and HTTPS ports (optional)


Back to Top

Use installation script arguments --http-port <NUMBER> and --https-port <NUMBER> to configure the UNMS server to listen on non-standard ports. Defaults are 80 (HTTP) and 443 (HTTPS).

$ curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UNMS/master/install.sh > /tmp/unms_install.sh 
$ sudo bash /tmp/unms_install.sh --http-port 8080 --https-port 8443
info_i_25x25.png Please be aware that UNMS must be accessible from the internet via HTTP port 80 if you want to use automatic SSL certificate management via Let's Encrypt.

Changing the device inform port (optional)


Back to Top

info_i_25x25.png Inform port is the port that your devices use to connect to UNMS.

Using a separate inform port is useful when you need to expose the port outside your private network, but don't want to expose the UNMS GUI.

Use installation script argument --ws-port <NUMBER> to configure the UNMS WebSocket server to use a separate port for communication with your devices.

$ curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UNMS/master/install.sh > /tmp/unms_install.sh 
$ sudo bash /tmp/unms_install.sh --ws-port 8444

Running UNMS behind a reverse proxy (optional)


Back to Top

Use installation script arguments --behind-reverse-proxy--public-https-port <NUMBER> and --public-ws-port <NUMBER> if you plan to run UNMS behind a reverse proxy server. Setting --public-https-port is only necessary if the proxy listens for HTTPS on a different port than UNMS. Setting --public-ws-port is only necessary when you use --ws-port (as mentioned in the section above) to separate the inform port form the HTTPS port.

$ curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UNMS/master/install.sh > /tmp/unms_install.sh
$ sudo bash /tmp/unms_install.sh --behind-reverse-proxy --public-https-port 443 --http-port 8080 --https-port 8443

Please be aware that this puts the responsibility of managing an SSL certificate on the reverse proxy and disables the automatic certificate management via Let's Encrypt. The reverse proxy must still use HTTPS for communication with UNMS, optionally with a custom SSL certificate. HTTP-only communication between UNMS and the reverse proxy is not supported.

The UNMS - Reverse Proxy Examples article (coming soon) shows working reverse proxy configurations for Nginx and Apache.


Changing the UNMS container's IP address (optional)


Back to Top

Use installation script argument --subnet <CIDR> to change the UNMS container's subnet if you experience IP address conflicts.

$ curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UNMS/master/install.sh > /tmp/unms_install.sh 
$ sudo bash /tmp/unms_install.sh --subnet 172.45.0.1/24

You may also wish to change the IP address of the docker0 bridge created by Docker. See the docker user guide for more information. Please note that this may affect containers other than UNMS running on your system.


Cloud


Back to Top

We recommend using the latest version of Ubuntu 16.04.1 LTS (Xenial Xerus) or Amazon AMI. Here are examples of suitable cloud services:

  • AWS, EC2 instance, t2.small (2 GB RAM), Ubuntu 16.04.1 LTS (Xenial Xerus)
  • DigitalOcean, basic droplet (2 GB RAM), Ubuntu 16.04.1 LTS (Xenial Xerus)
info_i_25x25.png For a detailed tutorial on DigitalOcean see: UNMS - How to Deploy on DigitalOcean (Coming Soon).

 


UNMS Data


Back to Top

By default, the installation script ensures that the application settings and data (logs, site images, encryption key, etc.) are stored outside of the docker container (/home/unms/data). This will enable you to back up that data, and more importantly, this will enable you to perform any future UNMS upgrades without any data loss.


Devices Latency and Outage Statistics


Back to Top

By default, all connected devices to UNMS will ping the UNMS host to check for latency and if any devices are being reported as offline which will result in outage statistics being generated. Ping must be allowed to the UNMS Host for this to work properly.


Installing Prerequisites


Back to Top

Run the following commands on your Ubuntu or Debian system to ensure that all required tools are installed:

sudo apt-get update
sudo apt-get install curl sudo bash netcat

Related Articles


Back to Top

UNMS - How to Register Devices to UNMS (coming soon)

UNMS - Reverse Proxy Examples article (coming soon)