How to use Facial Recognition

How to Install the Plugin

1. Open the Superuser panel of your Shinobi server.

http://YOUR_SHINOBI/super

• YOUR_SHINOBI is the IP and port of your Shinobi server.

2. Open the Plugin Manager tab and then select Download Plugins.

3. Locate " TF.js Face Recognition " in the list and download it. Once the download is complete you will find it listed in " Downloaded " as "shinobi-face ".

4. If you have an NVIDIA GPU but the drivers are not already installed you can click the "Commands"  dropdown and select the NVIDIA Installer labelled "Install NVIDIA Drivers v440, CUDNN v8, CUDA Toolkit 10.0 (Ubuntu 20.04 and Rocky 9)" .

Wait for this process to complete. It may ask you to reboot the machine once installed, allow it to do so.

Click the "Controls and Logs" tab to see when Shinobi is started.

5. Locate the "shinobi-face" plugin and click "Run Installer" in the "shinobi-face" block. If you have an NVIDIA GPU it will install support for it automatically.

Follow along in the next session on how to Enable it.

Enabling the Plugin

There are two ways to do this. One is easy and the other is the legacy as well as the safer way.

Do not do both! Pick one!

First Method : Enabling it via the Superuser panel.

1. Locate the "shinobi-face" plugin in the Plugin Manager and click "Enable" in the "shinobi-face" block.

2. Restart Shinobi.

Second Method : Enabling it as a service.

This assumes your Shinobi is installed in the default location at /home/Shinobi .

1. Open Terminal or Putty and SSH to your Shinobi server.

2. Navigate to the Shinobi face plugin folder.

cd /home/Shinobi/plugins/dl_face-logger-groups-tfjs-gpu-1-7-3

3. Daemonize the plugin with PM2 with the same privileges as Shinobi (become root or use sudo if you don't know).

pm2 start shinobi-face.js

4. Save PM2 so the plugin starts if the machine is rebooted.

pm2 save

5. Restart Shinobi from Terminal or from Superuser panel. The command below will do it from Terminal.

pm2 flush && pm2 restart camera && pm2 logs

Follow the next section to learn how to configure the plugin from your Dashboard.

Configuring the Plugin

1. Login to your regular dashboard, the one with your cameras configured.

http://YOUR_SHINOBI/

• YOUR_SHINOBI is the IP and port of your Shinobi server.

2. Open the Monitor Settings for a camera that will have the Face Recognition enabled.

3. Navigate to the Detector Settings and enable Object Detection then select the Face Recognition plugin.

4. OPTIONAL : Enable the "Save Unknown Faces" option if you want to automatically save unknown faces.

5. Save the Monitor Settings.

6. Open the Face Manager from the left side menu

7. Type the name of the person you want to add faces for then click Add .

8. Upload images of faces and they will automatically designate to the name typed into the Name field.

Your camera should now recognize the uploaded face. It will appear like an Object Detection but the tag will have the name you have saved.

Searching Recorded Footage for Faces

You can now search the face name in the Videos tab or Timeline tab with the Object Tag search field. Videos associated to the tag will be displayed.

To search for videos with Unknown faces search "UNKN".

Enjoy!