Shinobi

Shinobi は Node.js で記述された最新のオープンソース NVR(Network Video Recorder) です。個人または教育のための使用であれば、Pro バージョンの使用にライセンスキーは必要ありません。商用目的の使用の場合は、このページを参照してください。

ノート: h.265 をサポートするカメラは、Shinobi ダッシュボードのブラウザでは表示できません。録画(ビデオのコピー)は引き続き機能しますが、ブラウザを使用して表示することはできません。モバイルアプリを使って、これらのストリームを表示できます。

インストール

shinobi-git^AUR をインストールして下さい。

ノート: Shinobi は root としてではなく非特権ユーザーとして実行されます。これは、アップストリームが node の実行を期待する方法です。その結果、いくつかの制限が課せられます:

WebUI からのプラグインのインストールは機能しません。必要な場合は、root としてサーバーを手動で起動して下さい。
pm2 が使用されていないため、WebUI からの再起動機能は機能しません。
root のみが実行できるため、1000 未満のポートへのバインドは機能しません。これは、FTP または SMTP を使用してモーション/オブジェクト検出を受信する場合にのみ関係します。いくつかの回避策オプションについては、#カメラ内からの動き/物体検出を参照してください。

Configuration

Install and set up the MariaDB server

Refer to MariaDB#Installation for initial setup, then use the following commands to create a database for Shinobi:

# mysql
> CREATE DATABASE ccio; flush privileges; \q

Create Shinobi's user majesticflame and grant it all privileges to the new database:

# mysql < /usr/share/shinobi/sql/user.sql

ノート: shinobi-git^AUR depends on mariadb, so MariaDB will be installed on the same server as Shinobi. However if you installed Shinobi manually or without the mariadb dependency with MariaDB installed on a separate server, then you will need to copy and modify /usr/share/shinobi/sql/user.sql as needed if, for example, your LAN IP is 192.168.9.100.

$ sed 's/127.0.0.1/192.168.9.100/g' < /usr/share/shinobi/sql/user.sql > /tmp/user.sql

Then copy the file to your MariaDB server with scp or any other mechanism then running the modified sql file:

# mysql < /tmp/user.sql

Finally populate the database with tables:

# mysql ccio < /usr/share/shinobi/sql/framework.sql

Setup Shinobi

ノート: If MariaDB is on a separate server, edit /etc/shinobi/conf.json and replace 127.0.0.1 under db.host.

Customize /etc/shinobi/conf.json as desired.

Optionally setup the mail section accordingly as well as replacing the cron key with something random as indicated in the comments.

Optionally change the super admin password by editing /etc/shinobi/super.json and replacing the value for "pass" with an md5sum hashed password. Generate one like this:

$ echo -n PASSWORD | md5sum

Start and enable shinobi with the shinobi.target unit. shinobi.target will start/stop shinobi-camera.service and shinobi-cron.service. Browse to http://localhost:8080/super to perform initial setup including creating a user/users. See the official configure guide for a walk-through. Once finished, browse to http://localhost:8080 and log in as the non-admin user.

ノート: Replace localhost with a LAN IP if on a separate computer and replace 127.0.0.1 under ip in /etc/shinobi/conf.json.

Android and iOS apps

Shinobi Mobile Apps for both Android and iOS are available though this public test.

Tips and tricks

Delay between camera video and Shinobi

Some level of a lag or delay between the camera and the Shinobi dashboard is normal and dependent on stream type and video settings. See upstream documentation for some tips on minimizing the delay.

Motion/object detection natively in Shinobi

Shinobi can monitor a video feed and only record if motion is detected. Full frame or trigger areas are natively supported. See the setting-up-motion-detection article of upstream's documentation.

Motion/object detection from within the camera

Some camera manufactures offer native motion/object detection within the firmware of the camera itself. Shinobi can accept external event to trigger a record when motion is detected by the camera and these events are communicated by either SMTP or FTP.

ノート: Adjustment to a higher value to the Segment length variable might be needed if there is a lag between when the camera detects motion and when Shinobi triggers the start of video. To test this, simply watch the live stream while someone triggers motion. Observe the time from the camera's clock when the motion was triggered and compare that to the video. Set a higher value and test again.

Since our package is not running node as root, it cannot use the native ports for these services (25 for STMP and 21 for FTP).

It is recommended to simply select a port above 1,000 for these services on Shinobi and within the camera.

If using the native ports is a hard requirement, use a drop-in snippet for shinobi-camera.service:

[Service]
AmbientCapabilities=CAP_NET_BIND_SERVICE

Resources

Shinobi docs - Official docs and guides.
iSpy camera database - Large database of URLs for various cameras.
Shinobi camera database - Searchable database of supported cameras including things such as protocols, URLs for streams, and other technical specs.
Home assistant camera database - Another resource for finding URLs for streams.