@scrypted/nvr 0.0.180 → 0.0.181

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +41 -19
  2. package/dist/plugin.zip +0 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,29 +2,52 @@
2
2
 
3
3
  NVR plugin for Scrypted.
4
4
 
5
- ### Manage Subscription
5
+ This readme will guide you through the NVR setup, camera and detection setup, app installation, and optionally, self hosting.
6
+
7
+ ### Purchase and Manage Subscription
6
8
 
7
9
  This plugin is in a *paid* public beta. A [live demo server](https://demo.scrypted.app/#/demo) and free trial is available to test the product. Join the NVR channel on [Discord](https://discord.gg/DcFzmBHYGq) to report bugs and submit feature requests.
8
10
 
9
11
  The Scrypted NVR Subscription can be purchased and managed at the [billing portal](https://billing.scrypted.app).
10
12
 
11
- ### View Cameras and Recordings
13
+ ### NVR Setup
14
+
15
+ The NVR requires a storage directory for recordings. It is highly recommended to use a SATA/USB surveillance drive (and not an SD Card, etc) for storage.
12
16
 
13
- [Cameras and Recordings](/endpoint/@scrypted/core/public/) can be viewed on your local network by visiting the address of this Scrypted server. Install the Scrypted Cloud Plugin and visit [nvr.scrypted.app](https://nvr.scrypted.app) to view your cameras using any browser.
17
+ 1. Enter the drive's directory path in the Scrypted NVR Plugin settings. I.e., `/Volumes/External` or `/media/external`, etc.
18
+ * **Docker installations will need to mount the drive path into the container as a volume**. The Scrypted Docker Compose file can typically be found at `~/.scrypted/docker-compose.yml`. Edit the compose file as follows:
19
+ ```
20
+ volumes:
21
+ - ~/.scrypted/volume:/server/volume
22
+ # modify and add the additional volume for Scrypted NVR
23
+ - /media/external:/media/external
24
+ ```
25
+ 2. Observe the free space reported by Scrypted NVR Plugin to verify the correct drive is being used.
14
26
 
15
- ### Smart Detections
27
+ ### Camera Setup
16
28
 
17
- The Object Detection Plugin (`tensorflow-lite`) is automatically installed by Scrypted NVR. Detections can enabled per camera under `Integrations and Extensions`. When motion is triggered, the NVR will process the video for Smart Detections; this will use considerable CPU. System performance will vary based on available resources.
29
+ After adding a camera to Scrypted using the appropriate camera plugin, enable recording in the Camera Settings by selecting `Scrypted NVR` in the `Integrations and Extensions` list. Scrypted NVR highly recommends following the [Scrypted Codec Settings guide](https://github.com/koush/scrypted/wiki/Codec-Settings) to configure your camera for optimal recording and playback performance (these are the same settings for HomeKit). You can use the admin page provided by your camera manufacturer to configure these settings.
30
+
31
+ Object Detection can also be enabled in `Integrations and Extensions`. This extension provides event thumbnails and rich notifications to the app. The detection process will use considerable CPU. System performance will vary based on available resources.
32
+
33
+ ### View Cameras and Recordings
18
34
 
19
- ### Install App
35
+ After the cameras are configured, [Cameras and Recordings](/endpoint/@scrypted/core/public/) can be viewed on your local network by visiting the address of this Scrypted server.
20
36
 
21
- The Scrypted NVR app allows viewing of cameras and recordings remotely.
37
+ ### Remote Access via Apps and Browser
22
38
 
39
+ Cameras and recordings can be viewed remotely via a browser or the app. The [Scrypted Cloud](/endpoint/@scrypted/core/public/#/component/plugin/install/@scrypted/cloud) plugin is required.
40
+
41
+ 1. Install the [Scrypted Cloud](/endpoint/@scrypted/core/public/#/component/plugin/install/@scrypted/cloud) plugin.
42
+ * Scrypted Cloud accomodates custom domains and is required to be installed when self hosting. See below for self hosting instructions.
43
+ 2. Log in to the Scrypted Cloud plugin.
44
+ 3. Your cameras can now be viewed from anywhere at [nvr.scrypted.app](https://nvr.scrypted.app).
45
+
46
+ <br/>
23
47
 
24
48
  #### iOS App Instructions
25
49
 
26
- 1. Install and log into the Scrypted Cloud plugin.
27
- 2. [Install the Scrypted Beta App using TestFlight](https://testflight.apple.com/join/mpXXwLk7)
50
+ 1. [Install the Scrypted Beta App using TestFlight](https://testflight.apple.com/join/mpXXwLk7)
28
51
 
29
52
  <br/>
30
53
 
@@ -32,23 +55,22 @@ The Scrypted NVR app allows viewing of cameras and recordings remotely.
32
55
 
33
56
  All platforms (including iOS) can install the Progressive Web App (PWA):
34
57
 
35
- 1. Install and log into the Scrypted Cloud plugin.
36
- 2. On your phone/desktop, using the browser(s) specified in the section below for your OS, open [the app installation link](https://nvr.scrypted.app/#/install-pwa) and log into Scrypted Cloud.
37
- 3. This page can be installed as an app. See screenshot.
58
+ 1. On your phone/desktop, using the browser(s) specified in the section below for your OS, open [the app installation link](https://nvr.scrypted.app/#/install-pwa) and log into Scrypted Cloud.
59
+ 2. This page can be installed as an app. See [screenshot](https://user-images.githubusercontent.com/73924/194009896-359021b8-63a1-484f-aed7-35edeff92fa2.jpeg).
38
60
 
39
- <p align="center">
40
- <a href='https://user-images.githubusercontent.com/73924/194009896-359021b8-63a1-484f-aed7-35edeff92fa2.jpeg'>
41
- <img width="400" alt="Scrypted_NVR_App_Install" src="https://user-images.githubusercontent.com/73924/194009896-359021b8-63a1-484f-aed7-35edeff92fa2.jpeg"></a>
42
- </p>
61
+ <br/>
43
62
 
44
63
  PWA Installation Browser:
45
-
46
64
  * iOS: Install with Safari
47
65
  * Android: Install with Chrome
48
66
  * Windows/Mac/Linux: Install with Edge or Chrome
49
67
 
50
68
  <br/>
51
69
 
52
- ## Camera Codec Settings
70
+ ### Self Hosting
53
71
 
54
- You can use the admin page provided by your camera manufacturer to set the optimal codec settings for the NVR. It is highly recommended to use the codec settings detailed in the [Scrypted Codec Settings guide](https://github.com/koush/scrypted/wiki/Codec-Settings).
72
+ Scrypted can optionally be self hosted in the cloud with a reverse proxy to the https management port 10443. It must be SSL terminated. After the server is set up, enter the hostname in two locations:
73
+ * Scrpyted Cloud Plugin Settings
74
+ * This setting directs Scrypted to use the self hosted domain for all cloud services and signaling.
75
+ * iOS Settings App -> Scrypted -> Self Hosted -> Hostname
76
+ * This setting directs the iOS app to use the self hosted domain rather than Scrypted's Cloud servers.
package/dist/plugin.zip CHANGED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scrypted/nvr",
3
- "version": "0.0.180",
3
+ "version": "0.0.181",
4
4
  "scripts": {
5
5
  "prepublishOnly": "WEBPACK_DEVTOOL=nosources-source-map NODE_ENV=production scrypted-webpack",
6
6
  "prescrypted-vscode-launch": "WEBPACK_DEVTOOL=nosources-source-map scrypted-webpack",