@scrypted/nvr 0.2.23 → 0.2.24

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 (4) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +13 -80
  3. package/dist/plugin.zip +0 -0
  4. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  <details>
2
2
  <summary>Changelog</summary>
3
3
 
4
+ ### 0.2.23
5
+
6
+ point readme to docs
7
+ typo
8
+ use all drives for free space calculation
9
+ add default automatic storage management mode
10
+ round detections to reduce on disk/net size
11
+ fix file truncate regression caused by finally block
12
+
13
+
4
14
  ### 0.2.22
5
15
 
6
16
  add debug info to image drag
package/README.md CHANGED
@@ -3,106 +3,39 @@
3
3
  NVR plugin for Scrypted.
4
4
 
5
5
  **This plugin is currently only intended for local RTSP cameras. Cloud cameras, such as Ring, Google, and Arlo may work but are not supported.**
6
+
7
+ **New Scrypted users are encouraged to integrate and verify their cameras with Scrypted before using the NVR plugin**.
6
8
 
7
- This readme will guide you through the NVR setup, smart detection setup, and app installation. **New Scrypted users are encouraged to integrate and verify their cameras with Scrypted before using the NVR plugin**. Additional help and support can also be found on the [Scrypted Discord #nvr Channel](https://discord.gg/YNNSczz2fE).
9
+ ## Purchase and Manage Subscription
8
10
 
9
- ### Purchase and Manage Subscription
10
-
11
- 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.
11
+ This Scrypted NVR 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.
12
12
 
13
13
  1. Visit to the [billing portal](https://billing.scrypted.app) and login to purchase a subscription. Return to the billing portal at any time to upgrade or cancel the subscription.
14
- 2. Login to the Scrypted NVR Plugin using the *same login account* from the billign potral. The plugin's `Login` button can be found at the top of the Scrypted NVR plugin page within the Scrypted Management Console.
15
-
16
- After purchase, Mac and Windows users must [Install](https://docs.scrypted.app/desktop-application.html) or [Migrate](https://docs.scrypted.app/migration.html#migrating-to-the-desktop-application) to the [Desktop Application](https://docs.scrypted.app/desktop-application.html).
17
-
18
- ### NVR Setup
19
-
20
- 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.
21
-
22
- 1. Enter the drive's directory path in the Scrypted NVR Plugin settings. For example, `/Volumes/External/video` (Mac), `/mnt/sda/video` (Linux), `Z:\video` (Windows), or `/nvr` (Docker).
23
- * **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:
24
- ```
25
- volumes:
26
- - ~/.scrypted/volume:/server/volume
27
- # modify and add the additional volume for Scrypted NVR
28
- # the following example would mount the /mnt/sda/video path on the host
29
- # to the /nvr path inside the docker container.
30
- - /mnt/sda/video:/nvr
31
- ```
32
- 2. Observe the free space reported by Scrypted NVR Plugin to verify the correct drive is being used.
14
+ 2. Login to the Scrypted NVR Plugin using the *same login account* from the billing potral. The plugin's `Login` button can be found at the top of the Scrypted NVR plugin page within the Scrypted Management Console.
33
15
 
34
16
  <br/>
35
17
 
36
- ### Camera Setup
37
-
38
- 1. Before adding the camera, Scrypted NVR highly recommends following the [Scrypted Codec Settings guide](https://github.com/koush/scrypted/wiki/Codec-Settings) 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.
39
- 2. Add the camera using the appropriate camera plugin.
40
- 3. Enable recording in the Camera Settings by selecting `Scrypted NVR` in the `Integrations and Extensions` list.
41
- 4. [Verify Motion Detection and Object Detection is working](https://github.com/koush/nvr.scrypted.app/wiki/Scrypted-NVR-Camera-Verification).
42
- * Object Detection is an optional feature. Disabling the `Scrypted NVR Object Detection` extension will reduce system load.
43
- * Scrypted NVR will automatically install the appropriate software Object Detection plugins (ie, CoreML, OpenVINO, etc). If the server has a Coral accelerator, the `Tensorflow Lite` plugin must be manually installed.
44
-
45
- ### View Cameras and Recordings
46
-
47
- 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.
48
-
49
- ### Remote Access via Apps and Browser
50
-
51
- Cameras and recordings can be viewed remotely via a browser or the app.
52
-
53
- 1. Install the [Scrypted Cloud](/endpoint/@scrypted/core/public/#/component/plugin/install/@scrypted/cloud) plugin.
54
- * Scrypted Cloud must also be installed when self hosting. See below for self hosting instructions.
55
- 2. Login on the Scrypted Cloud plugin.
56
- * *Optional*: Configuring port forwarding or UPNP on your router for Scrypted Cloud is recommended for optimal performance and data privacy.
57
- 3. Your cameras can now be viewed from anywhere at [nvr.scrypted.app](https://nvr.scrypted.app).
18
+ ## Installation
58
19
 
59
20
  <br/>
60
-
61
- #### iOS App Instructions
62
-
63
- 1. [Install the Scrypted Beta App using TestFlight](https://testflight.apple.com/join/mpXXwLk7)
64
- 2. Login with the Scrypted Cloud credentials used in the previous steps.
65
- 3. The app will prompt to login a second time. The second time, use your *local* Scrypted Server credentials.
21
+ <div style="color: red;">
22
+ Please refer to the Camera Setup steps in the docs for optimal performance, even if the Camera has already been added to Scrypted.
23
+ </div>
66
24
 
67
25
  <br/>
68
26
 
69
- #### Progressive Web App Instructions
70
-
71
- All platforms (including iOS) can install the Progressive Web App (PWA):
72
- 1. On your phone/desktop launch the appropriate browser:
73
- * iOS: Install with Safari
74
- * Android: Install with Chrome
75
- * Windows/Mac/Linux: Install with Edge or Chrome
76
- 2. Visit [the app installation link](https://nvr.scrypted.app/#/install-pwa) and log into Scrypted Cloud.
77
- 3. This page can be installed as an app. See [screenshot](https://user-images.githubusercontent.com/73924/194009896-359021b8-63a1-484f-aed7-35edeff92fa2.jpeg).
78
- 4. Launch the newly installed PWA.
79
- 5. Login with the Scrypted Cloud credentials used in the previous steps.
80
- 6. The app will prompt to login a second time. The second time, use your *local* Scrypted Server credentials.
27
+ Installation documentation for the NVR can be found on the primary [Scrypted Documentation](https://docs.scrypted.app/scrypted-nvr/installation.html) site, and contains the guide for [adding cameras](https://docs.scrypted.app/scrypted-nvr/installation.html#camera-setup), [configuring recording storage](https://docs.scrypted.app/scrypted-nvr/installation.html#recording-storage), [cloud access](https://docs.scrypted.app/scrypted-nvr/apps.html), and [downloading the mobile apps](https://docs.scrypted.app/scrypted-nvr/apps.html).
81
28
 
82
29
  <br/>
83
30
 
84
- ### Discord
31
+ ## Discord
85
32
 
86
33
  Help and support can also be found on the [Scrypted Discord #nvr Channel](https://discord.gg/YNNSczz2fE).
87
34
 
88
- *Optional/Tip: If you're a member of the Scrypted Discord server, you can use [this link](https://discord.com/oauth2/authorize?scope=identify&client_id=1072990480553496710&response_type=code) to get special flair on your Discord account.*
89
-
90
- <br/>
91
-
92
- ### Self Hosting
93
-
94
- Scrypted can optionally be self hosted with a personal custom domain. This setup process is for advanced users and offers no benefits over port forwarding, other than bypassing the cloud login.
95
- * Install the Scrypted Cloud Plugin.
96
- * For `Port Forwarding Mode`, select `Custom Domain`.
97
- * Enter the personal custom domain into the `Hostname` setting.
98
- * Set up a SSL Termination to the `Local HTTPS Port` on the Scrypted Server. This port is random and can be viewed or changed in the Scrypted Cloud Plugin settings. This can be done with nginx or a variety of other reverse proxies.
99
-
100
- In the iOS app:
101
- * Enter Hostname at: iOS Settings -> Scrypted -> Self Hosted -> Hostname
102
- * `nvr.example.com` with port `443` forwarded to Scrypted server `12345`: `nvr.example.com`
35
+ *Optional/Tip: If you're a member of the Scrypted Discord server, you can use [this link](https://discord.com/oauth2/authorize?scope=identify&client_id=1072990480553496710&response_type=code) to get an exclusive role as an NVR Subscriber.*
103
36
 
104
37
  <br/>
105
38
 
106
- ### Home Assistant Cards
39
+ ## Home Assistant Cards
107
40
 
108
41
  Scrypted NVR provides [Home Assistant cards](https://docs.scrypted.app/home-assistant.html).
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.2.23",
3
+ "version": "0.2.24",
4
4
  "scripts": {
5
5
  "scrypted-setup-project": "scrypted-setup-project",
6
6
  "prescrypted-setup-project": "scrypted-package-json",