Install

Find videos about Shinobi on YouTube : https://www.youtube.com/user/MrMoea92

• Windows, Linux, Mac OS : Vagrant
• Windows, Linux, Mac OS : Plain VirtualBox
• Mac OS : Native
• Ubuntu 16.04 : The Easier Way
• Ubuntu 16.04 : The Harder Way
• How to Update

Requirements

• Node.js 7.2.0 or higher
• check your version with nodejs -v or node -v
• FFMPEG 2.8 or higher with libvpx and libx264.
• libx265 is optional. Choosing not to install it simply means the options for it won't work.
• Linux or MacOS base operating system capable of running the previously mentioned libraries and programs.
• Virtual Machines use Linux.
• Currently Windows cannot natively run Shinobi. This is due to the choice of certain exec commands and not the JavaScript itself. You can adapt it for use on Windows but it will take one with a sharp mind and a bold heart.

Windows, Linux, Mac OS : Vagrant

This sets up an Ubuntu 16.04 Virtual Machine running on VirtualBox and uses Vagrant to setup and configure everything in one command.

1. Open Terminal.

2. Download the repo via GIT

git clone [email protected]:moeiscool/Shinobi.git -o origin

3. Download and Install Vagrant https://www.vagrantup.com/downloads.html

4. Go to the /Shinobi directory which you created in Step 2 Run vagrant up from the terminal or command line

Windows, Linux, Mac OS : Plain VirtualBox

VIDEO TUTORIAL : https://www.youtube.com/watch?v=kENOPPTA0Xg

• You know what to do with this if you know what VirtualBox is.
  • Shinobi-12-29-2016.ova https://mega.nz/#!rkZQHQBT!9gTBRwUU5UGpOvtBUAMUUVAJhEaW5zrDMs8MgaN1JNo
    • Username : shinobi
    • Password : night

1. Once logged in

   cd shinobi
   

2. Start server.

   pm2 start camera.js
   

3. 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.
     • Username : [email protected]
     • Password : password

• To get your IP you can run the following command.

  ifconfig
  

Mac OS : Native

1. Open Terminal.

2. Install the required system packages git nodejs npm mysql via brew. If you don't have brew, download it from here: http://brew.sh/ If you have these already on your system you can skip this step.

   brew install git nodejs npm mysql
   

3. Install the ffmpeg package via brew.

   brew install ffmpeg
   

4. Download the repo via GIT

   git clone [email protected]:moeiscool/Shinobi.git -o origin
   

5. Import the sql/framework.sql SQL file, it will create a database called ccio

   cat sql/framework.sql | mysql -u root -p
   

6. Import the sql/default_data.sql SQL file, it will create a default user and camera source

   cat sql/default_data.sql | mysql -u root -p ccio
   

7. Run npm install from your Shinobi directory to install the required nodejs packages.

   npm install
   

8. Copy conf.sample.json to conf.json in your Shinobi directory and enter your database connection details

   cp conf.sample.json conf.json
   

9. Set your timezone in conf.json. This is important if your event times are not matching.

   "utcOffset":"-0800"
   

10. Run npm start from your Shinobi directory to start the Shinobi App.

    npm start
    

11. 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.
      • Username : [email protected]
      • Password : password

Ubuntu 16.04 : The Easier Way

VIDEO TUTORIAL : https://www.youtube.com/watch?v=CZSKV5gRd90

1. Open Terminal.

2. Download Shinobi with wget if you don't have git installed.

   • Do this only if you haven't already downloaded the files.

   wget https://github.com/moeiscool/Shinobi/tarball/master
   

3. Untar the downloaded file. The extracted directory is the shinobi directory.

   tar -xzf master
   

4. Rename the directory for easier access. The extracted folder name will be different. moeiscool-Shinobi-XXXXXXX is only an example.

   mv moeiscool-Shinobi-XXXXXXX shinobi
   

5. Open Shinobi directory.

   cd shinobi
   

6. Make INSTALL.sh an executable file.

   chmod +x INSTALL.sh
   

7. Execute INSTALL.sh. Run :

• This installs libav-tools, nodejs, npm, pm2, and mysql-server

  ./INSTALL.sh
  

8. Packages will be installed. MySQL will ask to create a password on first installation.

9. Then the installer will ask you for the credentials created. The default username is usually root.

10. Copy conf.sample.json as another file named conf.json.

    cp conf.sample.json conf.json
    

11. Set your timezone in conf.json. This is important if your event times are not matching.

    "utcOffset":"-0800"
    

12. Edit conf.json to reflect your sql credentials. I don't reccommend using root.

    nano conf.json
    

13. After installation is complete

    pm2 start camera.js
    

14. 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.
      • Username : [email protected]
      • Password : password

• To get your IP you can run the following command.

  ifconfig
  

Ubuntu 16.04 : The Harder Way

VIDEO TUTORIAL : https://www.youtube.com/watch?v=jfgUNfVEEEc

Dont have FFMPEG installed?

1. Open Terminal.

2. To install :

   apt-get install ffmpeg
   

   • If that doesn't work try :

   apt-get install libav-tools
   

Dont have Node.js installed?

1. Open Terminal.

2. Install Node.js and it's package manager

   • Note : #apt-get install node installs something else, not Node.js.

   apt-get install nodejs npm
   

3. Create a symlink to use nodejs.

   • pm2 needs this. If you don't plan on using pm2, then ignore this step.

   ln -s /usr/bin/nodejs /usr/bin/node
   

4. Not on Ubuntu? Other operating systems can be found here.

   • https://nodejs.org/en/download/package-manager/

Dont have MySQL installed?

1. Open Terminal. Run :

   apt-get install mysql-server
   

2. Installation of MySQL prompt you to set a password for root user in MySQL on your first install.

• Mac OS (will need more techiness ironically, follow this link) : https://blog.joefallon.net/2013/10/install-mysql-on-mac-osx-using-homebrew/ .

Application Install

1. Open Terminal.

2. Download Shinobi with wget if you don't have git installed.

   • Do this only if you haven't already downloaded the files.

   wget https://github.com/moeiscool/Shinobi/tarball/master
   

3. Untar the downloaded file. The extracted directory is the shinobi directory.

   tar -xzf master
   

4. Rename the directory for easier access. The extracted folder name will be different. moeiscool-Shinobi-XXXXXXX is only an example.

   mv moeiscool-Shinobi-XXXXXXX shinobi
   

5. Set permissions on the shinobi directory. Where camera.js is located.

   chmod -R 755 shinobi
   

6. Open Shinobi directory.

   cd shinobi
   

Setup SQL

7. Go to sql and install the SQL files in your database.

   cd sql
   

8. Terminal SQL client can be accessed by running :

   • The password will have been set during the installation of MySQL.

   mysql -u root -p
   

9. OPTIONAL : Create New SQL User with privileges. If you choose to use your own pre-defined credentials skip this step.

   source ./user.sql
   

   • or create your own

   CREATE USER 'majesticflame'@'127.0.0.1' IDENTIFIED BY '';
   GRANT ALL PRIVILEGES ON * . * TO 'majesticflame'@'127.0.0.1';
   FLUSH PRIVILEGES;
   

10. while still in the SQL client. Install the Shinobi database. It will create a database called ccio.

    source ./framework.sql
    

11. OPTIONAL : default_data.sql contains a demo user and a demo rtsp to mp4 monitor.

    source ./default_data.sql
    

12. After importing the data. Exit the sql client.

    exit
    

13. Go up one directory to enter the main directory. Where camera.js is located.

```
cd ..
```

14. Copy conf.sample.json as another file named conf.json.

    cp conf.sample.json conf.json
    

14a. Edit conf.json to reflect your sql credentials. I don't reccommend using root.

```
nano conf.json
```

14b. Set your timezone in conf.json. This is important if your event times are not matching.

```
"utcOffset":"-0800"
```

Install Libraries

15. Run npm install while in the main directory. This will install the libraries Shinobi needs.

    npm install
    

    • Can't get npm install to work? Try downloading this, the required node libraries already built. Place the node_modules folder in the same directory as camera.js.
      • https://mega.nz/#!upRRnRhD!RZSqKMnXYyvpeo_pg5loNpxBz3yFNXqQAo8bvKaqy1Y

Launch Shinobi

16. To start :

    node camera.js
    

    • If you did not make the symlink for nodejs then you must run nodejs camera.js instead.

17. 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.
      • Username : [email protected]
      • Password : password

• To get your IP you can run the following command.

  ifconfig
  

PM2 is needed to use UPDATE.sh and to Daeomonize the process

npm install pm2 -g

then to start :

pm2 start camera.js

• run pm2 logs to see the console for any errors.
• forever is another program to daemonize, but i've had more success with pm2.

How to Update

These commands remove and recreate camera.js, web, and UPDATE.sh. If you have made any changes to the source code please back them up before running the update command.

By Terminal

navigate to your Shinobi directory, then run the following command. This command only works for those with builds from 8/Jan/2017 and after

chmod +x UPDATE.sh&&./UPDATE.sh

By API

updateKey can be set in conf.json. https://github.com/moeiscool/Shinobi/wiki/Configuration

http://xxx.xxx.xxx.xxx/[API KEY]/update/[UPDATE KEY]