Full Installation

This tutorial walks you through setting up, configuring, and running the full NEPI Docker container on a suitable edge processor. This is a more comprehensive setup than Docker Lite and is recommended for production deployments.

Warning: Only perform this full installation on a NEPI device. To try NEPI on a general-purpose PC, use the Lite installation instead.

What you will need

1) 1x A monitor, keyboard, and mouse connected to the host system.

NEPI Docker User Setup

This section creates the nepihost user account and prepares your device to install NEPI Docker by cloning the NEPI setup repository that contains the required installation scripts.

1) Log into a user account with Administrator privileges, or use the existing nepihost account if available.

2) Open a Terminal window: right-click the desktop / Open in Terminal

3) Confirm your system has internet access by running the following command:

ping -c 1 google.com

Terminal output showing ping test

4) Update Git application (sudo password is '#Nsetup4You'):

sudo apt update && sudo apt install -y git

Terminal output showing git installation

5) Clone the NEPI setup repository:

cd /home/${USER}
git clone https://github.com/nepi-engine/nepi_setup.git

Terminal output showing repository clone

6) Run the NEPI Docker user setup script (sudo password is '#Nsetup4You'):

cd /home/${USER}/nepi_setup/scripts
sudo su

Then:

./docker_user_setup.sh

Terminal output showing user setup script

Terminal output showing user setup completion

7) Power cycle your system when complete to apply the new settings.

NEPI Docker Environment Setup

This section will set up the NEPI Docker required software environment.

1) Log into the nepihost account created in Docker User Setup.

2) Run the NEPI Docker environment setup script (sudo password is 'nepi'). If prompted, enter 'y' or 'yes':

~/nepi_setup/scripts/docker_env_setup.sh

Terminal output showing environment setup

Note: If you get a 'System program problem detected' popup, select 'Cancel' to dismiss it.

System program problem dialog

Terminal output showing environment setup completion

3) Once the script completes, scroll through the terminal output and verify there are no errors.

4) Power Cycle your system when complete.

NEPI Docker Config Setup

This section will configure the NEPI Docker configuration using the default settings.

1) Log into the nepihost account (sudo password is 'nepi').

Note: To enable remote file access through NEPI's built-in Samba network drive sharing, you must first create and mount the following folders as separate partitions:
  1. /mnt/nepi_config - minimum 200 MB

Create these partitions before running the next setup step.

2) Run the NEPI configuration setup script (sudo password is 'nepi'):

source ~/nepi_setup/scripts/docker_config_setup.sh

Terminal output showing config setup

Terminal output showing config setup progress

This process will create the following NEPI Folders:

  1. NEPI Storage folder created at /mnt/nepi_storage, along with several user subfolders for saved data, AI models, import/export Docker images, and user saved configurations.

3) Test that you can reconnect to the internet and sync clocks:

ninet

4) Check for internet connection:

pingi

Terminal output showing internet connectivity test

5) Power Cycle your system when complete.

NEPI Docker Init Setup

This section will initialize and test your NEPI Docker solution.

1) Log into the nepihost account (sudo password is 'nepi').

2) Enable internet connection and sync clocks:

ninet

Terminal output showing internet connection

3) Check for internet connection:

pingi

Terminal output showing ping test

4) Run the Docker storage initialization script (sudo password is 'nepi'). If prompted, enter 'y' or 'yes':

source ~/nepi_setup/scripts/docker_storage_init.sh

Terminal output showing storage initialization

5) Initialize the NEPI Docker image installation:

nepiinit

The script will display the NEPI images currently installed.

Terminal output showing NEPI Docker images

NEPI Docker Image Testing

This section verifies that the NEPI Docker container runs successfully and that the NEPI Resident User Interface (RUI) launches correctly.

1) Start your NEPI container running:

nepistart

Terminal output showing NEPI container starting

2) Wait for the startup confirmation message.

3) Open Chromium browser and enter: localhost:5003

4) Confirm that the NEPI RUI dashboard loads and shows a blinking green indicator, signaling that NEPI is active.

NEPI RUI dashboard showing active status

NEPI Docker Service Setup

This step enables NEPI to automatically start whenever the system boots.

1) Enable NEPI Docker service:

nepienable

Terminal output showing NEPI service enabled

2) Power Cycle your system when complete.

3) Log back into nepihost (sudo password is 'nepi').

4) Verify that your NEPI Container is running after reboot:

dps

Debugging and Shortcuts

If your container is not running, try to debug NEPI Docker Service issues with the following commands:

nepirestart
nepistatus
nepilogs

For detailed debugging instructions, refer to the official GitHub setup guide: NEPI Docker Host Setup Instructions on GitHub.

View all NEPI Docker command-line shortcuts anytime by typing:

nepihelp