02. Installation

Introduction

About Installation

The installation performs the following processes.

  • Collects device-specific information, registers the device to the NEQTO Console, and stores the serial ID issued.

  • Identifies the architecture, downloads the latest version of the software package, and installs it.

  • Registers the NEQTO service under "systemd" or "SysVinit", depending on the startup process possessed by the distribution. ("systemd" is preferentially selected)

    * Installation under "SysVinit" is supported from SW version 00.01.00 or later.
      Please use the latest installation tool ver 1.3 [2024/01/30] or later.

Important notes related to device registration:
When registering a device to the NEQTO Console, it uses the device-specific information.
"Architecture type and CPU information", "network adapter MAC address (limited to one, and the Ethernet adapter is preferentially selected)", and "OS information (distribution name with no version included)" will be collected and automatically registered. Note that it is assumed that this device-specific information will not be changed, and if any of the information is changed, a new device registration (re-installation) will be required.

About Re-installation

Installation can be performed as many times as needed.
If the software has already been installed and the installation is performed again, the parameters already set will be inherited and only the software will be updated to the latest version.
Even once uninstalled, if the device registration remains on the NEQTO console, it will be re-installed with the serial ID issued before uninstallation. If no device registration remains on the NEQTO Console, it will be a new device registration.


Installation

Prepare in advance:

Before beginning the installation, please check the following items:

  • NEQTO Console account registration must already be completed.
  • The target device for installation must satisfy the system requirements.
  • The target device for installation must be ready for network communication.
  • The following tools are required for installation. Please install them in advance if necessary:
    • "curl" or "wget"
    • "md5sum"
  • Immediately after installation is started, the device's system-specific information is sent to the NEQTO Console for automatic device registration.
  • In case of "systemd" supported environment, the NEQTO service will be registered under "systemd" and configured to start automatically.
  • In case of "systemd" unsupported environment, the NEQTO service will be registered under "SysVinit" and configured to start automatically. "update-rc.d" or "chkconfig" is required as an automatic startup configuration tool. Please install them in advance if necessary. If installation is started with these tools not present, an inquiry message will be displayed.

Installation procedure:

Please follow the steps below.

  1. First, login to the NEQTO Console and confirm the API key for Linux required for installation and the download URL for the installation tool.

    The installation tool may be updated with NEQTO Engine software releases. Always download and use the latest tool version.

  2. Download the installation tool to any directory on the Linux device.

    • If using "curl":
      $ curl -O https://<Download URL>/neqto-daemon-install.latest.sh↵
    • If using "wget":
      $ wget https://<Download URL>/neqto-daemon-install.latest.sh↵

  3. Set execute permissions on the downloaded installation tool.

    $ chmod 755 neqto-daemon-install.latest.sh↵

  4. Start the installation. Specify the API key for Linux with the -k option to the installation tool and run it as a Superuser (root). For other command options, refer to here.

    # neqto-daemon-install.latest.sh -k <Linux API key>↵

  5. Just after execution, important notes will be displayed. Please check it and enter "agree" if you agree. Thereafter, device registration will be executed, and software installation will continue.

    ============================================================
    NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
    ============================================================
    *** IMPORTANT ***
    Supported Architectures: armv6l armv7l aarch64 x86_64
    Will begin installation of the NEQTO service.
    Starting the installation will send the system-specific information of this device to the NEQTO Console for automatic registration.
    If you agree and want to continue, please enter "agree" >> agree↵

    • If the following inquiry message is displayed, refer here.
      Cannot find auto startup configuration tool for system services.
      Either 'update-rc.d' or 'chkconfig' is required.
      Do you want to continue the installation without setting the auto startup of the NEQTO service? [yes/no] >>

  6. Please wait until the final status "Installation completed successfully!" is displayed.

    ============================================================
    NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
    ============================================================
    *** IMPORTANT ***
    Supported Architectures: armv6l armv7l aarch64 x86_64
    Will begin installation of the NEQTO service.
    Starting the installation will send the system-specific information of this device to the NEQTO Console for automatic registration.
    If you agree and want to continue, please enter "agree" >> agree↵
    ============================================================ Registering device...OK
    Device-specific information to register in NEQTO:
    Platform: armv7l;XXXX;X;XXXX;XXXX;XXXX;XXXX
    NIC: ethX-XX:XX:XX:XX:XX:XX
    OS: Raspbian GNU/Linux
    Assigned Serial ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    ============================================================
    Downloading package...OK
    neqtod was installed under 'XXXXXX' (neqtod-XX.XX.XX)
    ============================================================
    Starting NEQTO service...
    Loaded: loaded (/etc/systemd/system/neqto.service; enabled; vendor preset: enabled)
    Active: active (running)
    ============================================================
    Installation completed successfully!

    The following message indicates where to register for NEQTO services.

    • When registered under "systemd":
      neqtod was installed under 'systemd' (neqtod-XX.XX.XX)
    • When registered under "SysVinit":
      neqtod was installed under 'SysVinit' (neqtod-XX.XX.XX)

  7. The device will start the NEQTO service as soon as the installation is complete.

    The device's specific information registered on the NEQTO Console and the serial ID issued will be displayed on the installation message above.

    Continue, proceed with node registration on the NEQTO Console. The device will repeat the retry operation until the node is linked on the NEQTO Console, and then will start "neqto.js" after the node is linked.

Command options:

  • -n <note>
    Writes an arbitrary string in the Notes field of the device information managed on the NEQTO Console at the same time as the device is registered. Only valid for new device registration.

  • -f
    The installation process will continue under the assumption that you have agreed to the "Confirmation of important notes" displayed just after the installation tool is executed.

  • -i
    Preferentially registers NEQTO services under "SysVinit" even if "systemd" supported environment.
    This option is valid only for the first installation. In case of re-installation, the current registration destination will be inherited.

Troubleshooting:

If the installation fails during the process, check the following items and perform the installation again. If the problem still cannot be resolved, please contact NEQTO Support.

To completely clean up to the pre-installation state, please perform uninstall.

  • "Please execute as root" is displayed.
     » The installation tool must be executed as a Superuser (root).

  • "APIKEY is not specified" is displayed.
     » It is necessary to specify the API key for Linux with the -k option when executing the installation tool.

  • "'systemctl' is required. Please install and try again" is displayed.
     » The NEQTO daemon requires "systemd". Please check system requirements.

  • "'md5sum' is required. Please install and try again" is displayed.
     » The installation tool requires the "md5sum" command. Please install it separately.

  • "Either 'curl' or 'wget' is required. Please install and try again" is displayed.
     » The installation tool requires either the "curl" or "wget" command. Please install it separately.

  • "Unsupported architecture - XXXX" is displayed.
     » This device architecture is not supported. Please check system requirements.

  • "No valid NIC" is displayed.
     » Cannot find a valid NIC required by the device-specific information. Please check system requirements.

  • Immediately after "Registering device..." is displayed, a "curl error" or "wget error" will be displayed.
     » Please check if the specified API key for Linux is correct.
     » Please check that network communication is available and that the Internet is accessible.

  • Immediately after "Downloading package..." is displayed, a "curl error" or "wget error" will be displayed.
     » Please check that network communication is available and that the Internet is accessible.

  • "systemctl daemon-reload error", "systemctl enable error" or "systemctl start error" is displayed.
     » Please check if "systemd" is operating properly.

  • "update-rc.d defaults error" or "chkconfig add error" is displayed.
     » Please check if "update-rc.d" or "chkconfig" is operating properly.

  • "NEQTO daemon start error" or "NEQTO service could not be started" is displayed.
     » For some reason the NEQTO service cannot be started. Please perform uninstallation once and then perform installation again.

  • "Cannot find auto startup configuration tool for system services. Either 'update-rc.d' or 'chkconfig' is required. Do you want to continue the installation without setting the auto startup of the NEQTO service? [yes/no] >> " is displayed.
     » Cannot find the automatic startup configuration tool that is required for registering NEQTO services under "SysVinit".
     ▹ If "no" is entered, the installation will be aborted. Please install "update-rc.d" or "chkconfig" that supports the "LSB (Linux Standard Base)" specification separately.
     ▹ If "yes" is entered, the installation will continue without automatic startup of the NEQTO service configured. When the system is rebooted, the service becomes inactive. Therefore, it is necessary to start the service with a command at each system startup, or to separately implement a mechanism to start the service automatically.


Uninstallation

Prepare in advance:

Before beginning the uninstallation, please check the following items:

  • Once uninstallation is started, all data related to the NEQTO installed on the device will be removed. It will not be possible to restore those data.
  • The data, registration information and licenses related to this device registered on the NEQTO Console will not be deleted. Please delete them separately on the NEQTO Console after the uninstallation is completed.

Uninstallation procedure:

Please follow the steps below.

  1. Start the uninstallation. Specify the -x option to the installation tool and run it as a Superuser (root). API key for Linux and network communication are not required. For other command options, refer to here.

    # neqto-daemon-install.latest.sh -x↵

  2. Just after execution, important notes will be displayed. Please check it and enter "agree" if you agree. Thereafter, uninstallation will be started.

    ============================================================
    NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
    ============================================================
    *** IMPORTANT ***
    Will begin uninstallation of the NEQTO service.
    It completely removes all data related to the NEQTO already installed on this system. It will not be possible to restore this data.
    In addition, the registration information and license associated with the device registered in the NEQTO Console will not be deleted. To delete this information, please perform the deletion on the NEQTO Console once the uninstallation is successfully complete.
    If you agree and want to continue, please enter "agree" >> agree↵

  3. Please wait until the final status Uninstallation completed successfully! is displayed.

    ============================================================
    NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
    ============================================================
    *** IMPORTANT ***
    Will begin uninstallation of the NEQTO service.
    It completely removes all data related to the NEQTO already installed on this system. It will not be possible to restore this data.
    In addition, the registration information and license associated with the device registered in the NEQTO Console will not be deleted. To delete this information, please perform the deletion on the NEQTO Console once the uninstallation is successfully complete.
    If you agree and want to continue, please enter "agree" >> agree↵
    ============================================================
    Uninstallation completed successfully!

Command options:

  • -f
    The uninstallation process will continue under the assumption that you have agreed to the "Confirmation of important notes" displayed just after the installation tool is executed.


Updated: 2024-01-29
← 01. System Requirements03. Software Configurations →