N3uron Installation and upgrade

Getting N3uron up and running is quick and easy. Installation takes less than a minute and the system will then be ready to immediately start collecting and delivering data. Simply download the installer from the N3uron website, run the installer and the WebUI will automatically open as soon as the installer has finished.

Windows Setup 

Step 1: Right click on the setup file and select “Run as administrator”.

Figure 1. N3uron must be installed using the “Run as administrator” option

Step 2: Choose the functionalities to be installed.

Figure 2. Component selection

Step 3: Choose the required TCP ports and finish the installation.

Figure 3. Default ports used by N3uron 

Step 4: The WebUI will automatically launch in the default web browser. To access N3uron WebUI from a different machine, use the machine’s IP and the port that was configured for the WebUI during setup (by default 8003 for HTTP or 8443 for HTTPS).

Default N3uron WebUI credentials.

Step 5: Set User Account Control to the lowest level possible.

Figure 4. In order to load backup configurations from the N3uron Web interface, User Account Control must be configured to the lowest possible level.

N3uron runs as a service and is automatically initiated when Windows is started. The service can also be stopped/started manually from the Start menu.

Figure 5. N3uron Start Menu to Stop/Start the service

Uninstalling N3uron in Windows

To uninstall N3uron from a Windows device, click the ‘Uninstall’ option in the N3uron Start menu.

Upgrading N3uron in Windows

To update N3uron on a machine running on Windows, follow these steps:

Step 1: Create a backup of \N3uron\bin and \N3uron\config folders. If something goes wrong during the update, restoring these folders will return the system to its original state.

Step 2: Stop the service.

Step 3: Run the installer for the new version using the "Run as Administrator" option in order to update the binary files to the new version. N3uron will start automatically once the installation process is complete.

Step 4: Login into the WebUI to check that everything is running properly.

Linux Setup

N3uron does not require Linux GUI, which means that it can be installed on any headless device. It can either be installed using the console or an SSH connection. It can then be configured from the Web interface. This User Guide assumes a basic knowledge of Linux systems and their administration.

To install the latest N3uron version in one step, run the command below: 

curl -fsSL https://get.n3uron.com/install.sh | sudo bash

If you prefer to install it manually, the following procedure will install N3uron to the /opt folder. It is also possible to install N3uron to a different folder, depending on the end user’s preferences.

Step 1: Download N3uron setup file. 

A Linux setup file for all the different distributions can be downloaded from  n3uron.com/downloads/  and uploaded or copied to the target machine.

Step 2: Decompress the file, where <arch> is the architecture of the target machine and <version> corresponds to the N3uron version downloaded.

sudo tar -xvzf n3uron-setup-linux-<arch>-<version>.tar.gz -C /opt/

Step 3: Install N3uron

sudo /opt/n3uron/bin/n3uron install

sudo apt install libcurl4

Step 4: Start the service

sudo systemctl start n3uron

To access the N3uron WebUI from a different machine, use the machine’s IP and the port that was configured for the WebUI (by default 8003 for HTTP or 8443 for HTTPS).

Default N3uron WebUI users.

N3uron service can be controlled from the console using the following commands:

sudo systemctl stop n3uron
sudo systemctl start n3uron
sudo systemctl restart n3uron
systemctl status n3uron

Uninstalling N3uron in Linux

To uninstall N3uron from the host machine, run the following commands:

Step 1: Uninstall N3uron service

sudo <n3uron folder>/bin/n3uron uninstall

For example, if N3uron is installed in the ‘/opt/n3uron’ folder, the command would be:

sudo /opt/n3uron/bin/n3uron uninstall

Step 2: Delete N3uron folder (optional)

sudo rm -r <n3uron folder>

For example, if the N3uron folder is /opt/n3uron the command would be:

sudo rm -r /opt/n3uron

Upgrading N3uron in Linux

To update to the latest N3uron version on a Linux machine, execute the following command:

curl -fsSL https://get.n3uron.com/install.sh | sudo bash

If you prefer to update it manually, follow these steps:

Step 1: Create a backup of /n3uron/bin and / n3uron/config folders. If something goes wrong during the update, restoring these folders will return the system to its original state.

Step 2: Stop the N3uron service:

sudo systemctl stop n3uron

Step 3: Extract the new version of the binary files from the installer, where <arch> is the architecture of the target machine and <version> corresponds to the N3uron version that has been downloaded. The following command assumes N3uron is installed in /opt/n3uron:

sudo tar -xvzf n3uron-setup-linux-<arch>-<version>.tar.gz -C /opt/ ./n3uron/bin

sudo tar -xvzf n3uron-setup-linux-<arch>-<version>.tar.gz --skip-old-files -C /opt/ ./n3uron/config

Step 4: Start the service again and login into the WebUI to check that everything is running correctly:

sudo systemctl start n3uron

Docker Setup

Docker is a platform that allows users to install and run N3uron inside a container. A container is a lightweight and self-sufficient environment that contains all the necessary components of N3uron, including the code, system tools, and settings. 

To access N3uron's Docker image, you can do so through the following link: https://hub.docker.com/r/n3uronhub/n3uron.  

Note:

This image does not contain the embedded MongoDB engine for Historian. Use the example below to launch N3uron with Mongo.

• Step 1: Start a N3uron instance:

docker run -d -h docker-node01 -p 8003:8003 n3uronhub/n3uron

Then, visit http://localhost:8003.

Using the persistent storage

• Step 1: Create the volumes to persist data:

docker volume create n3_config
docker volume create n3_data
docker volume create n3_licenses
docker volume create n3_log

• Step 2: Run the container with the volumes:

docker run -d \
    -p 8003:8003 \
    -p 8443:8443 \
    -v n3_config:/opt/n3uron/config \
    -v n3_data:/opt/n3uron/data \
    -v n3_log:/opt/n3uron/log \
    -v n3_licenses:/opt/n3uron/licenses \
    n3uronhub/n3uron:v1.21.6

Now visit http://localhost:8003 or https://localhost:8443

Note:

TCP ports used by the N3uron default installation:

• 8003: Web interface (HTTP)
• 8443: Secure web interface (HTTPS)

TCP ports assigned to N3uron must not be in use by any other applications.

Using docker compose

Example 'compose.yaml' for N3uron: 

services:
  n3uron:
    image: n3uronhub/n3uron:v1.21.6
    hostname: docker-node01 # Set the hostname
    ports:
     - 8003:8003 # HTTP WebUI
     - 8443:8443 # HTTPS WebUI
     - 8004:8004 # HTTP WebVision
     - 8444:8444 # HTTPS WebVision
     - 3001:3001 # Inbound Links
    volumes:
      - config:/opt/n3uron/config
      - data:/opt/n3uron/data
      - licenses:/opt/n3uron/licenses
      - log:/opt/n3uron/log
    restart: always

volumes:
  config:
  data:
  licenses:
  log:

Then run 'docker compose up' and visit http://localhost:8003 or https://localhost:8443.

MongoDB Configuration

The Historian module requires an external MongoDB database to work.

Example 'compose.yaml':

services:
  n3uron:
    image: n3uronhub/n3uron:v1.21.6
    hostname: docker-node01
    ports:
      - 8003:8003 # HTTP WebUI
      - 8443:8443 # HTTPS WebUI
      - 8004:8004 # HTTP WebVision
      - 8444:8444 # HTTPS WebVision
      - 3001:3001 # Inbound Links
    volumes:
      - n3_config:/opt/n3uron/config
      - n3_data:/opt/n3uron/data
      - n3_licenses:/opt/n3uron/licenses
      - n3_log:/opt/n3uron/log
    restart: always

  mongo:
    image: mongo:6
    ports:
       - 27017:27017
    environment:
      MONGO_INITDB_ROOT_USERNAME: root
      MONGO_INITDB_ROOT_PASSWORD: example
    volumes:
      - mongo_data:/data/db
    restart: always

volumes:
  n3_config:
  n3_data:
  n3_licenses:
  n3_log:
  mongo_data:

Run docker compose up and visit http://localhost:8003 or https://localhost:8443.

Note:

Depending on the module instances being used, it may be necessary to add other ports to the above example file. For instance, Web Vision may require the addition of ports 8004 and 8444.

Note:

When configuring the MongoDB instances to be used by Historian, enter the name of the service in the Host field. In the example above we have used mongo.

The only default database in Mongo is admin, so if you want to use another one for storing historical data, it must have been previously created in MongoDB.

Note:

By default, the latest N3uron version will be installed.
If you want to install a specific N3uron version, you can enter the following command: 

n3uronhub/n3uron:v1.21.X