Doorbird plugin for Shinobi
Clone or download
Latest commit 6ecc0d7 Feb 24, 2018

README.md

Shinobi Doorbird Plugin

Build Status

Requirements

  • Git Optional, needed for update script
  • Shinobi (Needs to be installed and running your system)
  • node.js and npm (also required by Shinobi, should be there already)
  • pm2 (also required by Shinobi, should be there already)

Installation

Plugin Auth

Within your shinobi config, you will need to add a random string as a key for the doorbird plugin.

"pluginKeys": {
  "Doorbird": "change_this_to_something_very_random"
}

Copy the sample config file and adjust the values to fit your needs.

cp conf.sample.json conf.json
vim conf.json

Be sure to change the value of key to match the key in the first step.

"key": "change_this_to_match_doorbird_plugin_key"

The easiest way:

This method assumes you are using the default setup for Shinobi:

./INSTALL.sh

An easy alternative:

Install required libraries

npm install

Daemonize the plugin with pm2

pm2 start lib/index.js --name doorbird --wait-ready

Save the daemon

pm2 save

Updating

Run the update script

./UPDATE.sh

Verify that your conf.json is correct

Run the install script

./INSTALL.sh