Shinobi#

Shinobi The Next Generation in Open-Source Video Management Software with support for over 6000 IP and USB Cameras

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling shinobi#

Command:#

vlab set shinobi.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

shinobi
enable: True

Finalising changes:#

run: vlab update_one service=shinobi

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

The login credentials are the default username and password you created for services during the initial config.

Follow the Shinobi documentiton for the rest of the setup and configuration.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=shinobi to complete the changes

ACCESS#

shinobi (HTTPS) link: https://shinobi.vivumlab.xyz/ shinobi (HTTP) link: http://shinobi.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set shinobi.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

shinobi
https_only: True
Finalising changes:#

run: vlab update_one service=shinobi

AUTH#

Default: False
Options: True/False

Command:#

vlab set shinobi.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

shinobi
auth: True
Finalising changes:#

run: vlab update_one service=shinobi

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set shinobi.domain shinobi.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

shinobi
domain: shinobi.com
Finalising changes:#

run: vlab update_one service=shinobi

SUBDOMAIN#

Default: shinobi
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set shinobi.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

shinobi
subdomain: media
Finalising changes:#

run: vlab update_one service=shinobi

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set shinobi.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

shinobi
version: 2.7
Finalising changes:#

run: vlab update_one service=shinobi

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.