Installing Nuclias Connect in Linux
There are two ways to install Nuclias Connect on Linux
Before you begin this procedure, download the latest Nuclias Connect package.
Contents
Docker Hub Installation
Preparing the Software Environment
Before installing Nuclias Connect, we must first set up the environment. Please follow the guide for installing Nuclias Connect with the Docker Hub in order, before continuing on to the next item in the list.
Install Docker
The Docker is available in two editions: Community Edition (CE) and Enterprise Edition (EE). For this section, Docker CE is used in the writing of this manual.
To install Docker, you will need a 64-bit OS and a kernel at 3.10 or newer. Kernels older than 3.10 do not have the necessary features required to run containers; data loss and kernel panics occur frequently under certain conditions.
Check your current Linux version by using the uname –r command.
Prerequisites
To install Docker CE here, you need the 64-bit version of one of these Ubuntu versions, or CentOS 7:
- Cosmic 18.10
- Bionic 18.04 (LTS)
- Xenial 16.04 (LTS)
- User name with sudo privileges
Docker CE is supported on x86_64 (or amd64), armhf, arm64, s390x (IBM Z), and ppc64le (IBM Power) architectures.
Uninstalling Previous Versions of Docker
It is recommended to uninstall any previous versions of the Docker software before proceeding. Use the following command to uninstall.
$ sudo apt-get remove docker docker-engine docker.io docker-ce
Once the previous version is removed, the latest version of the Docker software can be installed.
Installing Docker
Installing Docker is performed through the terminal window by using the following command:
$ sudo apt-get install docker.io
Once the command is initiated, the following results are displayed.
[sudo] password for dlink: Reading package lists... Done Building dependency tree Reading state information... Done The following additional packages will be installed: bridge-utils cgroupfs-mount containerd docker.io pigz runc Ubuntu-fan 0 upgraded, 7 newly installed, 0 to remove and 63 not upgraded. Need to get 0 B/52.2 MB of archives. After this operation, 257 MB of additional disk space will be used. Do you want to continue? [Y/n]
To finalize the installation, Enter Y.
Do you want to continue? [Y/n] Y
The following results are displayed.
Preconfiguring packages ... Selecting previously unselected package pigz. (Reading database ... 175976 files and directories currently installed.) Preparing to unpack .../0-pigz_2.4-1_amd64.deb ... Unpacking pigz (2.4-1) ... Selecting previously unselected package bridge-utils. Preparing to unpack .../1-bridge-utils_1.6-2ubuntu1_amd64.deb ... Unpacking bridge-utils (1.6-2ubuntu1) ... Selecting previously unselected package cgroupfs-mount. Preparing to unpack .../2-cgroupfs-mount_1.4_all.deb ... Unpacking cgroupfs-mount (1.4) ... Selecting previously unselected package runc. Preparing to unpack .../3-runc_1.0.0~rc7+git20190403.029124da-0ubuntu1_adm64.deb ... Unpacking runc (1.0.0~rc7+git20190403.029124da-0ubuntu1) ... Selecting previously unselected package containerd. Preparing to unpack .../4-containerd_1.2.6-0ubuntu1_amd64.deb ... Unpacking containerd (1.2.6-0ubuntu1) ... Selecting Preparing to unpack .../5-docker.io_18.09.5-0ubuntu1_amd64.deb ... Unpacking docker.io (18.09.5-0ubuntu1) ... Selecting previously unselected package Ubuntu-fan. Preparing to unpack .../6-ubuntu-fan_0.12.12_all.deb ... Unpacking Ubuntu-fan (0.12.12) ... Setting up runc (1.0.0~rc7+git20190403.029124da-0ubuntu1) ... Setting up pigz (2.4-1) ... Setting up cgroupfs-mount (1.4) ... Setting up containerd (1.2.6-0ubuntu1) ... Created symlink /etc/system/system/multi-user.target.wants/containerd.service/lib/system/system /conatinerd.service. Setting up Ubuntu-fan (0.12.12) ... Created symlink /etc/system/system/multi-user.target.wants/Ubuntu-fan.service/lib/system/system /Ubuntu-fan.service. Setting up docker.io (18.09.4-0ubuntu1) ... Adding group ‘docker’ (GID 130) Done. Created Symlink /etc/system/system/sockets.target.wants/docker.socket → /lib/system/system/docker.socket. Processing triggers for systemd (240-6ubuntu5) ... Processing triggers for man-db (2.8.5-2) ...
After installing Docker, you need to configure Docker to start at boot so when the server is rebooted, Docker service will start automatically.
$ sudo systemct1 enable docker $ sudo systemctl start docker
Install Docker Compose
Compose is available for the Windows or 64-bit Linux operating systems.
Prerequisites
The Docker Engine must be installed prior to the installation of Compose.
- On Windows systems, Docker Compose is included in the desktop installation.
- On Linux systems, the Docker software for your specific OS must first be installed. Once installed, continue with the Compose installation process.
Installing Compose on Linux
On Linux, the Docker Compose binary can be downloaded from the Compose repository release page found on GitHub. See the following instructions.
Check the latest Docker Compose from Github at https://github.com/docker/compose/releases.
$ sudo curl -L https://github.com/docker/compose/releases/download/1.23.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
Note: To install a different version of Compose, substitute the variable 1.23.1 with the preferred version of Compose.
Apply executable permissions to the aforementioned binary. See the following command:
$ sudo chmod +x /usr/local/bin/docker-compose
Once the installation is complete, verify it by testing the version. See the following command to verify the version of the Compose binary.
$ sudo docker-compose –version docker-compose version 1.23.1, build b02f1306
Setting Up Nuclias Connect via the Docker Hub
To generate the command for setting up Nuclias Connect through Docker Hub, go to https://download.nuclias.com.
Below you can see an example of the command.
$ sudo curl -L https://raw.githubusercontent.com/nuclias-connect/connect/dev/install.sh | sudo sh -s [mongo-username] [mongo-password]
This completes the Docker Hub installation of Nuclias Connect.
Tarball Installation
Visit: https://download.nuclias.com to download the Nuclias Connect tarball package. The file is named: nuclias_connect_1.0.0.tar.gz.
Once the package is downloaded, make a note of its location for later use. In this example, the tar package (nuclias-connect.tar.gz) is downloaded in an archived form (GZ) to the desktop.
To extract the Nuclias Connect package:
From the desktop, press Ctrl + Alt + T to launch a terminal window.
From the terminal window, navigate to the location of the downloaded tar package. For this example, the package is located on the desktop.
Enter the following command to change directories.
$ cd Desktop
Once in the correct directory, use the ls command to view a list of available files in the directory.
To extract the package, type in the following command and the respective password for the user.
:~/Desktop$sudo tar xvzf nuclias-connect.tar.gz
That command will extract the contents of the package. The following results will appear:
Nuclias_connect/ Nuclias_connect/docker-compose.yml Nuclias_connect/config/ Nuclias_connect/config/key/ Nuclias_connect/config/key/ca-cert.pem Nuclias_connect/config/key/openssl.cnf Nuclias_connect/appconfig.json Nuclias_connect/images Nuclias_connect/images/mongo.tar Nuclias_connect/images/core.tar Nuclias_connect/images/web.tar Nuclias_connect/entrypoint-initdb.sh
The Nuclias Connect package is now extracted and ready for access.
Navigate to the directory containing the init.sh shell file and type in the following command to initialize the Nuclias Connect package.
$ cd Desktop ~/Desktop$ cd nuclias_connect ~/Desktop/nuclias_connect$ sudo ./init.sh
The binary is executed and the following results will appear:
########### Welcome to Nuclias Connect ########### -- -- -- -e (1/11)---- check your system type ---- SYSTEM：Linux Ubuntu -e check system finished -e (2/11)---- check docker ---- Docker version 18.09.6, build 481bc77 -e docker installed -e (3/11)---- check docker-compose ---- docker-compose version 1.23.1, build b02f1306 -e docker-compose installed -e (4/11)---- check docker status ---- message: 2 -e docker sevice is running -e (5/11)---- check core image ---- message: 2 -e core image is existed -e (6/11)---- check web image ---- message: 2 -e web image is existed -e (7/11)---- check mongo image ---- message: 2 -e mongo image is existed -e (8/11)---- check web_port ---- message: 0 -e web_port is free -e (9/11)---- check core_port ---- message: 0 -e core_port is free -e (11/11)---- check file and directory ---- -e check file finished -e all check_job finished -e Now initial set the database administrator account for Nuclias Connect, please confirm is the first time set administrator account? [y/n]
As the initialization of the Nuclias Connect software takes place, a prompt will display requesting to setup the database administrator account. If this is the first time using the database, you need to set a database administrator for the account.
Setup Database Profile
For first time users, you must first set the database administrator. The following command describes the process.
In the Nuclias Connect initialization stage, the following prompt appears next.
-e Now initial set the database administrator account for Nuclias Connect, please confirm is the first time set administrator account? [y/n]
Enter Y (Yes) to set the administrator account and password.
At the prompt, enter the administrator user name and the related password. In the following example the variable admin is used for both instances.
User Name: admin Password: admin Confirm Password: admin Creating volume “nuclias_connect_MONGO-DATA” with default driver Creating mongo ... done Creating nuclias_connect_core ... done Creating nuclias_connect_web ... done -e Nuclias services are running ... -- commands list ----------------------- | | -e | start: docker-compose up –d | -e | stop:: docker-compose down | | | --------------------------------------- :~/Desktop/nuclias_connect$
With the Mongo DB, core, and web containers setup complete, Nuclias Connect can now be launched using a web browser.
Find Your Server IP Address
To connect to the Nuclias Connect, use the following information:
From the desktop, press Ctrl + Alt + T to launch a terminal window.
In the console, navigate to the directory containing the Nuclias Connect package. In the following example, the folder nuclias_connect is used to describe the location of the software.
$ cd Desktop ~/Desktop$ cd nuclias_connect
Enter the following command to obtain the defined IP address of the Nuclias Connect instance.
~/Desktop/nuclias_connect$ ip addr
The results will appear as follows. The IP address for use in a web browser is found below. This instance's address is 172.17.3.47, but yours may be different.
1: lo: <LOOPBACK, UP, LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group t glen 1000
Link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
Inet 127.0.0.1/8 scope host lo
Valid_lft forever preferred_lft forever
Inet6 ::1/128 scope host
Valid_lft forever preferred_lft forever
2: enp3s0f2: <BROADCAST, MULTICAT, UP,LOWER_UP> mtu 1500 qdisc fq_code1 state up group default qlen 1000
link/ether 30:65:ec:25:be:3b brd ff:ff:ff:ff:ff:ff
inet 172.17.5.47/24 brd 172.17.5.255 scope global dynamic noprefixroute ip3 sof2
valid_lft 22085sec preferred_lft 22085sec
inet6 fe80::c3a8:bcbd:6cda:4dc3/64 scope link noprefixroute
valid_lft forever preferred_lft forever
3: wlp2s0: <NO-CARRIER,BROADCAST, MULITCAST,UP> mtu 1500 qdisc noqueu state DOWN group default qlen 1000
link/ether a4:db:30:cb:36:0e brd ff:ff:ff:ff:ff:ff
4: docker0: <NO-CARRIER,BROADCAST, MULITCAST,UP> mtu 1500 qdisc noqueu state DOWN group default qlen 1000
link/ether 02:42:11:ff:39:9f brd ff:ff:ff:ff:ff:ffs
inet 172.18.0.1/16 brd 172.18.255.255 scope global docker0
valid_lft forever preferred_lft forever
In the above interface session the IP address (172.17.5.47) of the Nuclias Connect is identified. This is the IP address to use through a web browser to access the Nuclias Connect interface.
The Docker Hub installation process is complete. The core containers necessary to access Nuclias Connect through a web browser are now in place. To access the Nuclias Connect interface see Launch Nuclias Connect for further details.
Launch Nuclias Connect
With the core containers setup and the MongoDB profiles configured, Nuclias Connect can now be accessed through a web browser.
To obtain the IP address to access Nuclias Connect through a web browser, see Find Your Server IP Address.
The default settings for the Nuclias Connect are as follows:
- Web port: 30001
- From the desktop, open a web browser.
- In the address field, enter the aforementioned address of Nuclias Connect. In this instance, the IP address is 172.17.5.47:30001.
Connecting to Nuclias Connect on a Browser - A privacy error screen may appear when establishing a connection to the Nuclias Connect server. In this instance, click Proceed to 172.17.5.47 (unsafe) to open the Nuclias Connect portal.
- The Nuclias Connect main login screen is displayed as seen in the following image. The initial login username and password is admin. You will be required to modify your password after logging in for the first time.
Nuclias Connect Login Screen - The Nuclias Connect software is now ready to be configured and setup through your Small Office/Home Office or enterprise network.
Software Nuclias Connect Login - The default username and password is admin. You are required to change your password when you login for the first time to secure your account.
Enter admin as the current password, then enter the new password and its confirmation in the appropriate fields. Click Modify to continue.
Change Password Requirement - After a successful password change, you're required to provide some installation information to continue the activation. Complete the information requested and click Apply to continue.
Finish ActivationParameter Description How are you using Nuclias Connect? Own Use or Customer How many people in your department? Options: <10, 10-50, 50-100, >100 How many APs do you plan to manage? Options: <20, 20-50, 50-100, 100-500, >500 How many sites do you plan to manage? Enter the number of sites to manage Apply Click to continue the activation process. - The activation process is now completed. Click OK to finalize the process.
Finalize Activation Process