Giter Club home page Giter Club logo

shinobi-doorbird-plugin's Introduction

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

shinobi-doorbird-plugin's People

Contributors

mafischer avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.