From 52b9a3d2cd52979d8d8de5d2c9118a3edfdfe1d6 Mon Sep 17 00:00:00 2001 From: Moe Date: Mon, 31 Aug 2020 18:26:08 -0700 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 44ab111d..3401f8c1 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,29 @@ Shinobi is the Open Source CCTV Solution written in Node.JS. Designed with multiple account system, Streams by WebSocket, and Direct saving to MP4. Shinobi can record IP Cameras and Local Cameras. -# Install and Use +## Install and Use - Installation : http://shinobi.video/docs/start - Install with Docker : https://gitlab.com/Shinobi-Systems/Shinobi/-/tree/dev/Docker - Post-Installation Tutorials : http://shinobi.video/docs/configure -- Troubleshooting Guide : http://shinobi.video/docs/start#trouble-section +- Troubleshooting Guide : https://hub.shinobi.video/articles/view/v0AFPFchfVcFGUS + +## "is my camera supported?" + +Ask yourself these questions to get a general sense. + +- Does it have ONVIF? + - If yes, then it may have H.264 or H.265 streaming capability. +- Does it have RTSP Protocol for Streaming? + - If yes, then it may have H.264 or H.265 streaming capability. +- Can you stream it in VLC Player? + - If yes, use that same URL in Shinobi. You may need to specify the port number when using `rtsp://` protocol. +- Does it have MJPEG Streaming? + - While this would work in Shinobi, it is far from ideal. Please see if any of the prior questions are applicable. +- Does it have a web interface that you can connect to directly? + - If yes, then you may be able to find model information that can be used to search online for a streaming URL. + +Configuration Guides : http://shinobi.video/docs/configure ## Asking for help @@ -24,24 +41,24 @@ Get a Mobile License to unlock extended features on the Mobile App as well as su - Shinobi Mobile App : https://cdn.shinobi.video/installers/ShinobiMobile/ - Get a Mobile License : https://licenses.shinobi.video/subscribe?planSubscribe=plan_G31AZ9mknNCa6z -# Why make this? +## Why make this? http://shinobi.video/why -# Author +## Author Moe Alam, Shinobi Systems Shinobi is developed by many contributors. Please have a look at the commits to see some of who they are :) https://gitlab.com/Shinobi-Systems/Shinobi/-/commits/dev -# Support the Development +## Support the Development Ordering a certificate or support package greatly boosts development. Please consider contributing :) http://shinobi.video/support -# Links +## Links - Articles : http://hub.shinobi.video/articles - Documentation : http://shinobi.video/docs @@ -49,7 +66,7 @@ http://shinobi.video/support - Some features may not be listed. - Donation : http://shinobi.video/docs/donate - Buy Shinobi Stuff : https://licenses.shinobi.video -- Tested Cameras and Systems : http://shinobi.video/docs/supported +- User Submitted Configurations : http://shinobi.video/docs/cameras - Features : http://shinobi.video/features - Reddit (Forum) : https://www.reddit.com/r/ShinobiCCTV/ - YouTube (Tutorials) : https://www.youtube.com/channel/UCbgbBLTK-koTyjOmOxA9msQ