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:
Table of Contents
NOTE: It is recommended to install UNMS on a server, with a public IP address and FQDN, which is directly connected on the main gateway of the network. In this setup, UNMS will automatically have a valid certificate, it will report outages in the most precise manner and all of its advanced functions will perform optimally.
It is certainly possible to place UNMS server in a different place in your topology but there may be some limitations involved.
- Supported Distros (LXC virtualized Distros aren’t officially supported please use KVM):
- 2 GB RAM (Minimal)
- 16 GB storage (Minimal)
- 64-bit (x64) CPU
- Local Ports:
- 80 (Let's Encrypt certificate automation)
- 81 (Suspension page)
- 443 (UI, API, Devices connector)
- Allow ping (see Devices Latency and Outage Statistics)
- Kernel with overlay2 storage driver (see Docker Storage Drivers)
- bash, curl, sudo, netcat (see Installing prerequisites)
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. You can use the attribute
--updateif you want to be sure the new installation will have the same parameters as the old one. You can register your devices to UNMS by following this article: The UNMS Key and the Device Registration Process. In case you need to customize the installation process please read Optional installation steps.
curl -fsSL https://unms.com/v1/install > /tmp/unms_inst.sh && sudo bash /tmp/unms_inst.sh
The installation script will check if your ports :80 and :443 are open and if they are not, it will ask you to specify which ports you want UNMS to use. The same applies to the overcommit memory settings. If the
vm.overcommit_memory is not set to '1', the installation script asks for a permission to do it. In case you do not want to be bothered with those interrupts in the installation process you can use
--unattended attribute to let the installation script do all the necessary arrangements by itself.
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.
NOTE: The installation script needs to use sudo permissions. Those are required to install Docker in case it is not available in the OS already. It is also needed to create the UNMS user, under which the UNMS application runs as well as to set up a cron task which manages the UNMS updates.