@scrypted/nvr

Scrypted NVR Plugin

NVR plugin for Scrypted.

This readme will guide you through the NVR setup, camera and detection setup, app installation, and optionally, self hosting.

Purchase and Manage Subscription

This plugin is in a paid public beta. A live demo server and free trial is available to test the product. Join the NVR channel on Discord to report bugs and submit feature requests.

The Scrypted NVR Subscription can be purchased and managed at the billing portal.

NVR Setup

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.

1. Enter the drive's directory path in the Scrypted NVR Plugin settings. I.e., /Volumes/External or /media/external, etc.

• 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:

    volumes:                                                       
            - ~/.scrypted/volume:/server/volume                    
            # modify and add the additional volume for Scrypted NVR
            - /media/external:/media/external                      

1. Observe the free space reported by Scrypted NVR Plugin to verify the correct drive is being used.

Camera Setup

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 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.

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.

View Cameras and Recordings

After the cameras are configured, Cameras and Recordings can be viewed on your local network by visiting the address of this Scrypted server.

Remote Access via Apps and Browser

Cameras and recordings can be viewed remotely via a browser or the app. The Scrypted Cloud plugin is required.

1. Install the Scrypted Cloud plugin.

• Scrypted Cloud accomodates custom domains and is required to be installed when self hosting. See below for self hosting instructions.

1. Log in to the Scrypted Cloud plugin.
2. Your cameras can now be viewed from anywhere at nvr.scrypted.app.

iOS App Instructions

1. Install the Scrypted Beta App using TestFlight

Progressive Web App Instructions

All platforms (including iOS) can install the Progressive Web App (PWA):

1. On your phone/desktop, using the browser(s) specified in the section below for your OS, open the app installation link and log into Scrypted Cloud.
2. This page can be installed as an app. See screenshot.

PWA Installation Browser:

• iOS: Install with Safari
• Android: Install with Chrome
• Windows/Mac/Linux: Install with Edge or Chrome

Self Hosting

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:

• Scrpyted Cloud Plugin Settings
  • This setting directs Scrypted to use the self hosted domain for all cloud services and signaling.
• iOS Settings App -> Scrypted -> Self Hosted -> Hostname
  • This setting directs the iOS app to use the self hosted domain rather than Scrypted's Cloud servers.