@scrypted/nvr 0.0.271 → 0.0.274
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.
- package/README.md +21 -21
- package/dist/plugin.zip +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ NVR plugin for Scrypted.
|
|
|
4
4
|
|
|
5
5
|
**This plugin is currently only intended for local RTSP cameras.**
|
|
6
6
|
|
|
7
|
-
This readme will guide you through the NVR setup,
|
|
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/DcFzmBHYGq).
|
|
8
8
|
|
|
9
9
|
### Purchase and Manage Subscription
|
|
10
10
|
|
|
@@ -17,7 +17,7 @@ The Scrypted NVR Subscription can be purchased and managed at the [billing porta
|
|
|
17
17
|
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.
|
|
18
18
|
|
|
19
19
|
1. Enter the drive's directory path in the Scrypted NVR Plugin settings. I.e., `/Volumes/External` or `/media/external`, etc.
|
|
20
|
-
|
|
20
|
+
* **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:
|
|
21
21
|
```
|
|
22
22
|
volumes:
|
|
23
23
|
- ~/.scrypted/volume:/server/volume
|
|
@@ -26,6 +26,8 @@ The NVR requires a storage directory for recordings. It is highly recommended to
|
|
|
26
26
|
```
|
|
27
27
|
2. Observe the free space reported by Scrypted NVR Plugin to verify the correct drive is being used.
|
|
28
28
|
|
|
29
|
+
<br/>
|
|
30
|
+
|
|
29
31
|
### Camera Setup
|
|
30
32
|
|
|
31
33
|
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.
|
|
@@ -38,11 +40,12 @@ After the cameras are configured, [Cameras and Recordings](/endpoint/@scrypted/c
|
|
|
38
40
|
|
|
39
41
|
### Remote Access via Apps and Browser
|
|
40
42
|
|
|
41
|
-
Cameras and recordings can be viewed remotely via a browser or the app.
|
|
43
|
+
Cameras and recordings can be viewed remotely via a browser or the app.
|
|
42
44
|
|
|
43
45
|
1. Install the [Scrypted Cloud](/endpoint/@scrypted/core/public/#/component/plugin/install/@scrypted/cloud) plugin.
|
|
44
|
-
|
|
45
|
-
2.
|
|
46
|
+
* Scrypted Cloud must also be installed when self hosting. See below for self hosting instructions.
|
|
47
|
+
2. Login on the Scrypted Cloud plugin.
|
|
48
|
+
* *Optional*: Configuring port forwarding or UPNP on your router for Scrypted Cloud is recommended for optimal performance and data privacy.
|
|
46
49
|
3. Your cameras can now be viewed from anywhere at [nvr.scrypted.app](https://nvr.scrypted.app).
|
|
47
50
|
|
|
48
51
|
<br/>
|
|
@@ -50,6 +53,8 @@ Cameras and recordings can be viewed remotely via a browser or the app. The [Scr
|
|
|
50
53
|
#### iOS App Instructions
|
|
51
54
|
|
|
52
55
|
1. [Install the Scrypted Beta App using TestFlight](https://testflight.apple.com/join/mpXXwLk7)
|
|
56
|
+
2. Login with the Scrypted Cloud credentials used in the previous steps.
|
|
57
|
+
3. The app will prompt to login a second time. The second time, use your *local* Scrypted Server credentials.
|
|
53
58
|
|
|
54
59
|
<br/>
|
|
55
60
|
|
|
@@ -67,24 +72,19 @@ PWA Installation Browser:
|
|
|
67
72
|
* Android: Install with Chrome
|
|
68
73
|
* Windows/Mac/Linux: Install with Edge or Chrome
|
|
69
74
|
|
|
75
|
+
1. Login with the Scrypted Cloud credentials used in the previous steps.
|
|
76
|
+
2. The app will prompt to login a second time. The second time, use your *local* Scrypted Server credentials.
|
|
77
|
+
|
|
70
78
|
<br/>
|
|
71
79
|
|
|
72
80
|
### Self Hosting
|
|
73
81
|
|
|
74
|
-
Scrypted can optionally be self hosted with a custom domain.
|
|
75
|
-
*
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
*
|
|
79
|
-
* Examples:
|
|
80
|
-
* `nvr.example.com` with port `10443` forwarded to Scrypted server `10443`: `nvr.example.com:10443`
|
|
81
|
-
* `nvr.example.com` with port `9999` forwarded to Scrypted server `10443`: `nvr.example.com:9999`
|
|
82
|
-
|
|
83
|
-
<br/>
|
|
84
|
-
|
|
85
|
-
### Self Hosting with a valid SSL Certificate
|
|
82
|
+
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.
|
|
83
|
+
* Install the Scrypted Cloud Plugin.
|
|
84
|
+
* For `Port Forwarding Mode`, select `Custom Domain`.
|
|
85
|
+
* Enter the personal custom domain into the `Hostname` setting.
|
|
86
|
+
* 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.
|
|
86
87
|
|
|
87
|
-
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* Enter `nvr.example.com` in the Scrypted Cloud Hostname Setting
|
|
88
|
+
In the iOS app:
|
|
89
|
+
* Enter Hostname at: iOS Settings -> Scrypted -> Self Hosted -> Hostname
|
|
90
|
+
* `nvr.example.com` with port `443` forwarded to Scrypted server `12345`: `nvr.example.com`
|
package/dist/plugin.zip
CHANGED
|
Binary file
|