Skip to content

Installation and Updates

This page explains how to install UIP on a new machine and update an existing system to the latest version. Read the article in its entirety before beginning the installation or update process.

New Installation

Before you begin the installation you must verify that your machine meets or exceeds the Host Machine System Requirements

  • Configure any DNS servers that are required to connect this system to other resources on your network
  • Configure any HTTP|HTTPS web proxy servers if required to access the internet including any related certificate authority certificates that must be trusted
  • Configure your system firewall to allow outgoing HTTP|HTTPS traffic to the internet and incoming HTTP traffic on port 80 and 9090 from the browser you will use to configure the system
  • Check if your local networks conflict with the default internal docker networks 172.17.0.0/16, 172.18.0.0/16, 10.255.0.0/16, 10.116.187.0/24, 10.117.0.0/16. If there is a conflict refer to the System Requirements section for guidance on how to reconfigure those networks before proceeding with the installation.

  • Know the repository credentials for downloading the software. The install script will prompt for credentials from one of the following authentication resources:

    • NECAM/LATAM Region Users

      • Username: necam/emailuser@company.com
        • Use NEC Anytime account email address prefixed with necam/ (all lower-case)
      • Password: password
        • Use the "Password for NEC Applications" configured under My Account for the specified NEC Anytime account. This will be different from the password used to log into the NEC Anytime website.

    • NECJ Region Users

      • Username: necj/loginname
        • Use NEC Software Activation License Center username prefixed with necj/ (all lower-case)
      • Password: password
        • Use the password for the specified NEC Software Activation License Center account

    • NECEMEA Region Users

      • Username: necemea/loginname
      • Password: password
        • Use the password for the specified NEC BusinessNet account

    • NECASIA Region Users

      • Username: necasia/loginname
        • Use NEC Product Activation License Portal (LMS) username prefixed with necasia/ (all lower-case)
      • Password: password
        • Use the password for the specified NEC Product Activation License Portal (LMS) account

    • NECAU/NZ Region Users

      • Username: necaunz/loginname
        • Use NEC Product Activation License Portal (LMS) username prefixed with necaunz/ (all lower-case)
      • Password: password
        • Use the password for the specified NEC Product Activation License Portal (LMS) account

Download Install Script

After connecting a terminal to the target machine, execute the following command to download the installation script. Note that the first command has capital letter "O" (not a zero digit) after the hyphen.

curl -Ofv https://nec-downloads.com/nap/nap-install.sh

If you are unable to download the install script you may need to follow the System Requirements > Configure HTTP|HTTPS Proxy instructions.

Run Install Script

The installation script will download and install a small number of required software packages on the target machine. Execute the following command with root privileges and monitor its progress.

sudo bash nap-install.sh

If you wish to configure a client access system name during the software deployment a --dnsname switch can be appended when the install script is executed.

sudo bash nap-install.sh --dnsname host.yourdomain.com

Warning

If installing on a IaaS platform or other network environment where the local hostname differs from the DNS name used to access the system, the --dnsname switch should be used with the nap-install.sh script to correctly configure your system. All DNS settings and entries should be made before proceeding and the system should be accessible by that DNS name.

If you have an external MongoDB database service that you want to use for storing UIP information refer to External MongoDB Database Support.

If you have an external MondoDB or HTTPS Proxy that uses a TLS certificate which is self-signed or signed by a private CA you must provide the CA certificate when the nap-install.sh script is executed by adding a "--cacerts FOLDER" command line parameter to supply a folder that contains the CA certificate file(s). They must be in PEM format and have a file extension of .crt.

sudo bash nap-install.sh --cacerts ~/ca-certs-folder/

During the install you will be prompted to select a download region. Please select the number that best describes your NEC sales region. You will also be prompted to enter your repository credentials to allow access to the download. See the New Installation section for details on the account to be used.

If other software updates are in progress, it will display the message "[Waiting for other software updates to finish...]". If the updates take more than 10 minutes the installation will be aborted and it will display the message "Other software updates still in progress after waiting 10 minutes, aborting install".

When the script is finished executing it will display the message "To continue, open a web browser to this address: http://###.###.###.###:9090."

If your system does not meet the recommended system requirements a message will be displayed in the console and you must respond to continue. More information on the system requirements can be found in the System Requirements section.

Follow Setup Wizard

At this point, you should open a compatible web browser which is able to access the address that was displayed when the install script finished.

The browser should display a Setup Wizard website which will guide you through the rest of the installation process.

The Setup Wizard is automatically displayed in the language that was set as preferred by the end user in the web browser. Supported languages are en-Us and ja, the default one being english.

Administrator Account

An administrator login account must be configured which will be the first login that can be used to access the system after the installation is finished.

  • Password must contain at least 1 digit, 1 uppercase character, 1 lower case character, and 1 non-alphanumeric character
  • Password must be between 9 and 100 characters long

Monitor Installation Progress

During the last step of the Setup Wizard the progress of the automated portion of installation process will be displayed.

If the installation finishes successfully you will be redirected to the system's sign on page after all of the services have finished installing. You can log in using the administrator account credentials that were configured in the setup wizard.

If a service fails to start properly during the installation process it will stop and indicate that a failure has occurred. Refer to the troubleshooting section of this page for more information on what to do if your installation fails.

Sign In

You can sign in using the credentials that were configured during the administrator account configuration step of the setup wizard.

Updates

The Administration > About page can be used to view the current version information and update an existing system to the latest version of software that is available.

If your system is backup capable, such as hosted on a hypervisor system, it is recommended to create a checkpoint of the virtual machine prior to running the software update to create a restore point.

If a software update contains modifications for the systems user interface you may need to force a reload of the website, or sign out and then sign in after the update has completed.

Before upgrading UIP to the latest version, it is recommended to apply the latest security updates to Ubuntu. Run apt update and then apt upgrade to get the latest package versions including kernel updates. If the system is using one or more remote Adapter Hubs, it is recommended to apply the latest security updates for Ubuntu to all Adapter Hubs.

Configure Custom Registry

If a third-party container image referenced by an adapter or adapter hub service is stored in a private registry that requires login credentials, use the Configure Registries feature to manage those credentials.

Troubleshooting

This section contains information which can be used to troubleshoot unexpected issues which may occur during the installation process.

Installation and Update Issues

If an unexpected problem occurs during an installation or software update which results in the user interface being inaccessible, detailed troubleshooting information can be retrieved from log files within the system's host machine. To view the contents of these log files you must connect a terminal to the machine and have root access.

If a problem occurs during the execution of the nap-install.sh script, detailed troubleshooting data can be found in the file /var/log/nec/install.log. It can be viewed by typing the following command in your terminal session:

sudo nano -v /var/log/nec/install.log

If a problem occurs while using the Setup Wizard, or during a software update, detailed troubleshooting data can be found in the file /var/log/nec/orchestration.log. It can be viewed by typing the following command in your terminal session:

sudo nano -v /var/log/nec/orchestration.log

Networking

Test Connection

Test access to the remote resources used by UIP using Test Connection.

Other Systems

If there are issues accessing remote systems from UIP, the following commands can assist in checking network connectivity. The examples below use the very small busybox Docker container to run the commands in order to have a similar environment to the rest of the UIP system. These commands are useful when troubleshooting DNS and networking issues from Docker containers. Keep in mind that ping might be blocked on some networks or devices, so a negative result with ping does not necessarily indicate a network problem.

# Ping a network resource.
# Replace DESTINATION with the address (IP or FQDN) of your destination system.
docker run busybox ping DESTINATION

# Run a DNS lookup.
# Replace DESTINATION with a name to look up (e.g. the FQDN of your UIP system).
docker run busybox nslookup DESTINATION

Reset Lost UIP Login Account Password or disable MFA

If the password(s) for accessing UIP have been lost it is possible to Reset a UIP Login Account Password or Disable MFA.