NEPI Edge AI Platform

Get Started with NEPI

Optional · 3 min See NEPI connect sensors, run AI at the edge, and open the dashboard Watch this before choosing your install path.

NEPI is free to try and source available. The tutorials below will get you running in about 30 minutes. NEPI installs as a container, so it runs on top of your existing system without replacing anything on your device.

Docker Lite

New to Linux or Docker? Start here. An automated script handles everything: Docker setup, management tools, and shortcuts. No command line expertise needed.

Docker Full

Ready for production? Production installation on embedded processors. Follow Lite first, then upgrade when you are ready.

Select your install path - tutorial loads below

New to Linux or Docker

Docker Lite

Automated setup script. Installs Docker, NEPI management tools, and shortcuts for you. No Linux expertise needed.

Automated install · 30 GB min · Ubuntu or Jetson

Tutorial loaded below

Production

Docker Full

Full OS integration for permanent production deployments. Manages network, SSH, and system services at the OS level.

Advanced · 40 GB min · back up device first

Tutorial loaded below

Docker Lite - setup tutorial

Automated setup · Ubuntu PC or NVIDIA Jetson · ~30 min

Resources

Ubuntu PC or NVIDIA Jetson · Internet access · 30 GB free disk space · Admin (sudo) access

This tutorial walks you through setting up, configuring, and running a NEPI Docker Lite Installation on a supported device.

Supported devices: Ubuntu PC, NVIDIA Jetson

NEPI Docker Lite Installations are recommended for PC-based installations, trial Edge-Compute processor installations, and NEPI Software development. With fully automated NEPI Docker setup processes, it is also recommended for non-experienced Linux users.

After testing with the Lite installation, you can upgrade your system to a Full installation for production deployments with support for both local and remote real-time management of operating system services. See the NEPI Docker Full Setup instructions.

Note: NEPI Docker installation will require a minimum of 30 GB of available free hard drive space on your device.

NEPI Docker Lite Setup

Log into a user account on the device with 'Administrator' privileges. Open a Terminal window by right-clicking on the desktop and selecting the "Open in Terminal" option.

Make sure your system has internet access by running the following command:

ping -c 1 google.com

Update Git application:

sudo apt update && sudo apt install -y git

Clone the NEPI Setup repo:

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

Run the NEPI Docker Lite setup script:

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

Then, if prompted, enter y or yes:

source ./docker_lite_setup.sh

This process will create (if not already created) and set up the following NEPI folders:

NEPI Storage folder at /mnt/nepi_storage, along with user subfolders for Saved Data, AI models, Import/Export Docker Images, and User Saved Configurations.
NEPI Config folder at /mnt/nepi_config, along with several config subfolders.

Power cycle your system when complete.

NEPI Docker Init Setup

Log back into the user account on the device with 'Administrator' privileges.

Check for internet connection:

ping -c 1 google.com

Run the NEPI Docker Storage Initialization script:

source ~/nepi_setup/scripts/docker_storage_init.sh

Run the NEPI Docker Image Initialization script:

Note: This step can take a long time as it involves downloading several large files from the internet.

source ~/nepi_setup/scripts/docker_image_init.sh

After the import completes, you can print the current installed NEPI Docker Image by typing:

dimg

NEPI Docker Image Testing

Refresh your .bashrc file:

sbrc

Start your NEPI container running:

nepistart

The start script will let you know if the installed NEPI Image started successfully.

Open Chromium web browser. Check that the NEPI Resident User Interface (RUI) is running by opening the Chromium browser and entering the following in the search bar:

localhost:5003

This will take you to the NEPI RUI dashboard. Once the NEPI core software system is running, you should see a blinking green indicator and messages.

You can also access the NEPI admin page by entering the following in the search bar:

localhost:5003/admin

The default admin password is: nepiadmin

For full setup instructions, see the Lite Installation tutorial.

This tutorial will walk you through setting up, configuring, and running a NEPI Docker Demo Installation on a supported device.

SUPPORTED DEVICES: Ubuntu PC, NVIDIA Jetson

NEPI Docker Demo Installations are recommended for a quick demo of the NEPI Software Container for experienced Linux users. Note: If you are not an experienced Linux user, you may want to try the NEPI Docker Lite installation which includes a fully automated setup process. See the NEPI Docker Lite Setup instructions.

Note: NEPI Docker installation will require a minimum of 20 GB of available free hard drive space on your device.

NEPI Docker Demo Env Setup

Log into a user account on the device with 'Administrator' privileges. Open a Terminal window by right-clicking on the desktop and selecting the "Open in Terminal" option.

Check that Docker is installed on your device by typing:

docker

Note: If Docker is not installed, install Docker along with any additional software required if you also need NVIDIA GPU support.

Check that a Chromium web browser is installed on your device by typing:

chromium

Note: If Chromium is not installed, install Chromium.

Create NEPI required system folders on your device, and add your user to required system groups:

sudo -v

Then run:

CONFIG_USER=$(id -un) && USER_1000=$(id -nu 1000)
sudo mkdir /mnt/nepi_config
sudo chown 1000:1000 /mnt/nepi_config
sudo mkdir /mnt/nepi_storage
sudo chown 1000:1000 /mnt/nepi_storage
sudo usermod -aG sudo $CONFIG_USER
sudo adduser ${CONFIG_USER} dialout
sudo usermod -aG dialout ${CONFIG_USER}
sudo usermod -aG tty ${CONFIG_USER}
sudo usermod -aG i2c ${CONFIG_USER}
sudo usermod -aG video ${CONFIG_USER}
sudo usermod -aG docker ${CONFIG_USER}
sudo usermod -aG ${USER_1000} ${CONFIG_USER}
exec su -l $CONFIG_USER

Install the latest NEPI Docker Image for your device. Select your device type:

Pull the NEPI Docker image:

sudo docker pull numurusinc/nepi:latest-amd64

Retag the image as nepi:

sudo docker tag numurusinc/nepi:latest-amd64 nepi:latest
sudo docker rmi numurusinc/nepi:latest-amd64

Note: NEPI Docker images are large files and will take several minutes to download and install.

Install the latest NEPI Storage Files which include sample data, AI model, and configuration files:

sudo -v

Then run:

cd /mnt/nepi_storage
storage_latest_link='https://www.dropbox.com/scl/fi/za3sz2q7e0pbcj6m89d8h/nepi_storage-latest.zip?rlkey=eq6u97w6qpqiqblcudqnwj8ud&st=hj0yewy3&dl=0'
storage_latest_zip=nepi_storage-latest.zip
sudo rm ${storage_latest_zip} 2> /dev/null
sudo wget ${storage_latest_link} -O ${storage_latest_zip}
sudo -v && sudo unzip -o -q $storage_latest_zip
sudo rm ${storage_latest_zip} 2> /dev/null
sudo chown -R 1000:1000 ${NEPI_STORAGE}
ls ./

Start your NEPI container:

sudo docker run -d --privileged --rm -e UDEV=1 --ipc=host --user 0:0 \
--mount type=bind,source=/mnt/nepi_storage,target=/mnt/nepi_storage \
--mount type=bind,source=/mnt/nepi_config,target=/mnt/nepi_config \
--mount type=bind,source=/dev,target=/dev \
--mount type=bind,source=/etc/udev,target=/etc/udev \
--cap-add=SYS_TIME --volume=/var/empty:/var/empty \
-v /etc/ntpd.conf:/etc/ntpd.conf -e DISPLAY=:0 \
--net=host -p 9091:9091 -p 9092:9092 -p 11311:11311 \
-p 137:137/udp -p 138:138/udp -p 139:139/tcp -p 445:445/tcp \
nepi:latest /bin/bash -c '/nepi_start_all'

Pull the NEPI Docker image:

sudo docker pull numurusinc/nepi:latest-amd64-cuda

Retag the image as nepi:

sudo docker tag numurusinc/nepi:latest-amd64-cuda nepi:latest
sudo docker rmi numurusinc/nepi:latest-amd64-cuda

Note: NEPI Docker images are large files and will take several minutes to download and install.

Install the latest NEPI Storage Files which include sample data, AI model, and configuration files:

sudo -v

Then run:

cd /mnt/nepi_storage
storage_latest_link='https://www.dropbox.com/scl/fi/za3sz2q7e0pbcj6m89d8h/nepi_storage-latest.zip?rlkey=eq6u97w6qpqiqblcudqnwj8ud&st=hj0yewy3&dl=0'
storage_latest_zip=nepi_storage-latest.zip
sudo rm ${storage_latest_zip} 2> /dev/null
sudo wget ${storage_latest_link} -O ${storage_latest_zip}
sudo -v && sudo unzip -o -q $storage_latest_zip
sudo rm ${storage_latest_zip} 2> /dev/null
sudo chown -R 1000:1000 ${NEPI_STORAGE}
ls ./

Start your NEPI container:

sudo docker run -d --privileged --rm -e UDEV=1 --ipc=host --user 0:0 \
--mount type=bind,source=/mnt/nepi_storage,target=/mnt/nepi_storage \
--mount type=bind,source=/mnt/nepi_config,target=/mnt/nepi_config \
--mount type=bind,source=/dev,target=/dev \
--mount type=bind,source=/etc/udev,target=/etc/udev \
--cap-add=SYS_TIME --volume=/var/empty:/var/empty \
-v /etc/ntpd.conf:/etc/ntpd.conf -e DISPLAY=:0 \
--net=host -p 9091:9091 -p 9092:9092 -p 11311:11311 \
-p 137:137/udp -p 138:138/udp -p 139:139/tcp -p 445:445/tcp \
--gpus all --runtime nvidia -v /tmp/.X11-unix/:/tmp/.X11-unix
nepi:latest /bin/bash -c '/nepi_start_all'

Pull the NEPI Docker image:

sudo docker pull numurusinc/nepi:latest-jetson

Retag the image as nepi:

sudo docker tag numurusinc/nepi:latest-jetson nepi:latest
sudo docker rmi numurusinc/nepi:latest-jetson

Note: NEPI Docker images are large files and will take several minutes to download and install.

Install the latest NEPI Storage Files which include sample data, AI model, and configuration files:

sudo -v

Then run:

cd /mnt/nepi_storage
storage_latest_link='https://www.dropbox.com/scl/fi/za3sz2q7e0pbcj6m89d8h/nepi_storage-latest.zip?rlkey=eq6u97w6qpqiqblcudqnwj8ud&st=hj0yewy3&dl=0'
storage_latest_zip=nepi_storage-latest.zip
sudo rm ${storage_latest_zip} 2> /dev/null
sudo wget ${storage_latest_link} -O ${storage_latest_zip}
sudo -v && sudo unzip -o -q $storage_latest_zip
sudo rm ${storage_latest_zip} 2> /dev/null
sudo chown -R 1000:1000 ${NEPI_STORAGE}
ls ./

Start your NEPI container:

sudo docker run -d --privileged --rm -e UDEV=1 --ipc=host --user 0:0 \
--mount type=bind,source=/mnt/nepi_storage,target=/mnt/nepi_storage \
--mount type=bind,source=/mnt/nepi_config,target=/mnt/nepi_config \
--mount type=bind,source=/dev,target=/dev \
--mount type=bind,source=/etc/udev,target=/etc/udev \
--cap-add=SYS_TIME --volume=/var/empty:/var/empty \
-v /etc/ntpd.conf:/etc/ntpd.conf -e DISPLAY=:0 \
--net=host -p 9091:9091 -p 9092:9092 -p 11311:11311 \
-p 137:137/udp -p 138:138/udp -p 139:139/tcp -p 445:445/tcp \
--gpus all --runtime nvidia -v /tmp/.X11-unix/:/tmp/.X11-unix
-v /var/run/docker.sock:/var/run/docker.sock -v /tmp:/tmp
-v /usr/bin/nvargus-daemon:/usr/bin/nvargus-daemon
nepi:latest /bin/bash -c '/nepi_start_all'

Note: If you encounter any issues starting and running the NEPI Software container, you may consider running the NEPI Docker Lite Installation which includes debugging tools. See the NEPI Docker Lite Setup instructions.

Open Chromium web browser. Check that the NEPI Resident User Interface (RUI) is running by opening the Chromium browser and entering the following in the search bar:

localhost:5003

This will take you to the NEPI RUI dashboard. Once the NEPI core software system is running, you should see a blinking green indicator and messages.

Note: RUI controls related to User, Device, Time, Network, and Software management are not enabled for NEPI Demo installations.

You can also access the NEPI admin page for managing NEPI software configurations by entering the following in the search bar:

localhost:5003/admin

The default admin password is: nepiadmin

To get an AI model running and learn more about using, configuring, and building NEPI software, see the documentation, tutorials, videos, and community forum available at nepi.com/tutorials/quick-start.

Note: If you save any camera or AI detection data, you can access it at:

cd /mnt/nepi_storage/data

NEPI Software Support

To learn more about using, configuring, and building NEPI software, see the documentation, tutorials, videos, and community forum available at nepi.com.

This tutorial walks you through setting up, configuring, and running a NEPI Docker Full installation on a supported device.

Supported devices: Ubuntu PC, NVIDIA Jetson

NEPI Docker Full Installations are recommended for embedded Edge-Compute processor installations, production deployments, and NEPI Software development.

Note: NEPI Docker Full installation will make significant changes to your device's operating system configuration and set up NEPI management of operating system services. If you want to first try a Lite installation, see the NEPI Docker Lite Setup instructions.

Note: NEPI Docker installation will require a minimum of 40 GB of available free hard drive space on your device.

NEPI Docker Full User Setup

Log into a user account on the device with 'Administrator' privileges. Open a Terminal window by right-clicking on the desktop and selecting the "Open in Terminal" option.

Make sure your system has internet access:

ping -c 1 google.com

Update Git and clone the NEPI Setup repo:

sudo apt update && sudo apt install -y git
cd /home/${USER}
git clone https://github.com/nepi-engine/nepi_setup.git

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

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

source ./docker_full_user_setup.sh

Power cycle your system when complete.

NEPI Docker Environment Setup

Log into the nepihost user using password nepi. Clone the NEPI Setup repo and run the environment setup script:

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

Power cycle your system when complete.

NEPI Docker Config Setup

Log into nepihost (password nepi) and run the configuration setup script:

source /home/nepihost/nepi_setup/scripts/docker_full_config_setup.sh

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

ninet

Power cycle your system when complete.

NEPI Docker Init Setup

Log back into nepihost, reconnect to the internet, and run the initialization scripts:

ninet

source /home/nepihost/nepi_setup/scripts/docker_storage_init.sh

Note: This step can take a long time as it involves downloading several large files from the internet.

source /home/nepihost/nepi_setup/scripts/docker_image_init.sh

NEPI Docker Image Testing

Refresh your .bashrc and start the NEPI container:

sbrc

nepistart

Open Chromium web browser. Check that the NEPI Resident User Interface (RUI) is running at:

localhost:5003

Access the admin page at localhost:5003/admin. The default admin password is: nepiadmin

NEPI Docker Service Setup

If everything is working, enable the NEPI Docker Service to auto-start on boot:

nepienable

Power cycle your system when complete. After reboot, verify the container is running:

dps

For full setup instructions including host configuration, remote connections, and debugging, see the Full Installation tutorial.

Next steps

Three things to try first

Pick whichever fits what you're building.

Need help? Ask the community.

Discord is fastest. The forum is best for longer threads. We're in both.

Discord Community forum GitHub Docker Hub

Get Started with NEPI

Docker Lite

Docker Full

NEPI Docker Lite Setup

NEPI Docker Init Setup

NEPI Docker Image Testing

NEPI Docker Demo Env Setup

NEPI Software Support

NEPI Docker Full User Setup

NEPI Docker Environment Setup

NEPI Docker Config Setup

NEPI Docker Init Setup

NEPI Docker Image Testing

NEPI Docker Service Setup

You're running NEPI.

Three things to try first

Connect a sensor

Deploy an AI model

Read the docs

Need help? Ask the community.