Ninja Way

  1. The Ninja Way is the recommended way to install. It will allow ease in updating as well as changes to the code. Node.js (12+), FFmpeg (3.3+), and MariaDB (10.4+) are the main components that Shinobi needs.
  2. Ninja Auto-iQ Multi/Slow Cooker with 80-Pre-Programmed Auto-iQ Recipes for Searing, Slow Cooking, Baking and Steaming with 6-Quart Nonstick Pot (CS960) 4.8 out of 5 stars 766 3 offers from $119.99.
  1. Ninja Way Wiki
  2. Ninja Wayne Memorial Dr
  3. Ninja Way

Download

It is recommended to install a fresh Ubuntu 19.10 for the Operating System before beginning. If you have other applications installed on the server machine you will need to ensure there are no conflicts.

If you have questions please post on Reddit or Discord. Due to limited resources support time is limited. Ordering a support package will give you priority for support.

Moe AlamWayDownload

Ninja ® Foodi ™ Ovens are unlike any other ovens. That’s because you can make everything from chicken wings and French fries to cookies, cakes, toast, and beef jerky.

Requirements

These requirements will be installed for you with The Ninja Way. The Ninja Way is the recommended way to install. It will allow ease in updating as well as changes to the code.

Node.js (12+), FFmpeg (3.3+), and MariaDB (10.4+) are the main components that Shinobi needs. With the Ninja Way it is expected that all these requirements will be fulfilled for you.

Ninja Way Wiki

To get the best experience and most support it is suggested that you install on a dedicated machine with Ubuntu 19.10 then install Shinobi the Ninja Way.

Friendly Warning : Avoid Docker. If you can use a VM if you must use a shared environment.

Installation

The Simplest Way

Install the Ubuntu 19.10 ISO with Shinobi, TensorFlow Object Detection. This Ubuntu Installer ISO will install NVIDIA Drivers, CUDA Toolkit 10.0, and CUDNN if an NVIDIA GPU is detected during installation.

Learn more about the ISO here.

The Ninja Way

Warning : The Ninja Way installs from source code. Which means many libraries from other sources are going to be installed aswell.

The easiest way to install from source, directly on metal, is through git. The following operating systems are supported.

  • CentOS 8

  1. Become root to use the installer and run Shinobi. Use one of the following to do so.

    • CentOS 8

  2. Download and run the installer.

Docker

It is recommended that you have a dedicated machine for Shinobi even if you intend to use Docker. If you are willing to install directly on the operating system please consider installing Ubuntu 19.10 and using the Ninja Way.
More Information about Docker Installation in the Respository's Docker folder.

Ubuntu : The Easier Way

  1. Open Terminal.

  2. Install git command line library.

  3. Open Shinobi directory.

  4. Packages will be installed. MariaDB will ask to create a password on first installation.

  5. Once complete. Open up http://localhost:8080 in your browser.

    • Note : if you are installed on a remote computer open up the IP in your web browser.

  6. You should now be able to manage accounts

CentOS, Fedora, RHEL : The Easier Way

  1. Open Terminal.

  2. Install git command line library.

  3. Open Shinobi directory.

  4. Packages will be installed. MariaDB will ask to create a password on first installation.

  5. Once complete. Open up http://localhost:8080 in your browser.

    • Note : if you are installed on a remote computer open up the IP in your web browser.

  6. You should now be able to manage accounts

Account Management

Way

Set up Superuser Access

Rename super.sample.json to super.json. Run the following command inside the Shinobi directory with terminal. Passwords are saved as MD5 strings.You only need to do this step once.

You should now be able to manage accounts

Set up Sub-Accounts

Login at http://your.shinobi.video/admin. With the main account of the group. If a sub account is used to login to this page it will be directed to the regular dashboard.

Clean up

Set up the cron file

  1. Run cron.js to get data about how much space is used and to clear old videos.

Updating Shinobi

Getting the latest files

There were multiple ways to do this, now there is only one recommended way to do it. Please follow the link below.

Daemonize and Startup

Keep running and on boot

  1. Start camera.js and cron.js then run check to see they are running under PM2.

  2. After camera.js and cron.js are started you can run the following to start them on boot.

Way

Configuration

Done Installation

Default Login

You should now be able to manage accounts

Ninja Way

Configuration File

conf.json

conf.json is the file that you create from conf.sample.json during the install process using the following command from inside the Shinobi directory.

Anyway! on to what’s really important. What’s in the file itself. This is the contents of conf.sample.json.

Available Options for conf.json

OptionsRequiredTypeDescription
cpuUsageMarkernostringThe marker that is used to search for CPU usage in top command. Default is %Cpu. Some systems, like Puppy Linux, require it be set to CPU.
defaultMjpegnostringA path leading to a JPEG file. This default image is needed for when the camera cannot provide frames.
doSnapshotnobooleanBy default the snapshot in the top left open its own FFMPEG process for a moment to get a single frame, You can avoid this by turning on JPEG API or setting this option to false.
updateKeynostringFor updating by API.
streamDirnostringdefault is /dev/shm/streams/. Remember to end with /. Leave it undefined or null to use default. Be careful in using HLS as Stream Type. This directory should be set as somewhere in RAM
videosDirnostringdefault is videos/ in the Shinobi directory. Remember to end with /. Leave it undefined or null to use default.
windowsTempDirnostringdefault is C:/Windows/Temp. If your system is not located on the C: drive then you must add this option in your conf.json file.
DropboxAppKeynostringFuture releases will hide dropbox functions when this key is left null.
ipnostringIP that is used for the Shinobi server instance. Default is undefined, which will tell the webserver to automatically choose.
portyesintPort that is used for the Shinobi server instance. Default is 8080
utcOffsetyesstringTimezone that matches your SQL database.
dbyesobjectThe login information for the SQL database
db.hostyesstringThe IP address or domain name. Default is 127.0.0.1
db.useryesstringThe user name. Default is majesticflame.
db.passwordyesstringThe password. Default is no password.
db.databaseyesstringThe database name. Default is ccio.
db.portyesintThe port number for Shinobi. Default is 3306.
cronnoobjectThe object that contains some options for cron.js
cron.deleteOldnobooleancron will delete videos older than Max Number of Days per account. Default is true.
cron.deleteNoVideonobooleancron will delete SQL rows that it thinks have no video files. Default is true.
cron.deleteOverMaxnobooleancron will delete files that are over the set maximum storage per account. Default is true.
mailnoobjectIf your Email account uses 2-Step Authentication, like Gmail, then you will be require to create an Application Password.
sslnoobjectIf you would to use SSL (Encryption) you can include this object.
ssl.keyyes*stringRequired if SSL object is present. This is a reference to a file that usually ends in .key.
Example : ssl/server.key will direct to a folder named ssl inside your Shinobi directory.
ssl.certyes*stringRequired if SSL object is present. This is a reference to a file that usually ends in .crt.
Example : ssl/server.crt will direct to a folder named ssl inside your Shinobi directory.
ssl.passphraseyes*stringIf your key and certificate use a passphrase you must define it or SSL will not start.
ssl.portnointThis is the port SSL will listen on. If option is undefined 443 will be used.
languagenostringDefault is en_CA. You can check the langauges folder inside the Shinobi directory for more options. You can make more by using node tools/translateLanguageFile.js.
addStoragenoobjectView the sample above for how to structure this object.
passwordTypenostringThis can be sha256, sha512, or md5. md5 is the default.
passwordSaltyes*stringThis is only needed if passwordType is set to sha512.

Troubleshooting

Finding Problems

What to do

For all errors please try the following before posting in the Issues or asking on Discord.

  • Read through the Shinobi Wiki
  • Searching the web.
    • Google, Lukol, anything.
  • Make sure you have installed all the Requirements.
  • Review the Installation Process
  • If you are paying for support package ignore the previous requirements and open a ticket or contact a developer directly.

Posting in the Issues

The following are required when posting in the issues.

  • Must be about Shinobi, not Node.js or a library used by Shinobi
  • Include a snippet of any errors you are describing.
    • If logs are not available, providing some screenshots may be helpful.
  • Must be about a bug.
    • Suggestions must be posted on Forum in the Suggestions section.

Support Packages


Ninja Wayne Memorial Dr

We will answer your questions about how Shinobi works, the different ways you can use it, and it's documentation. We will keep your installation maintained with the latest stable build.

Ninja Way

Ordering a support package also supports the developers.