---
url: /add-camera.md
---
# Add a Camera

::: warning
The [Camera Configuration](/camera-preparation) steps should be completed prior to adding the camera to Scrypted.
:::

Scrypted supports a variety of camera plugins, some of which are listed on this page. In the `Scrypted Management Console`, navigate to `Plugins` in the side bar. Then search and install the appropriate Scrypted Plugin for your camera manufacturer.

## Plugins

Cameras fall into two categories: `Local` cameras and `Cloud` cameras. `Local` cameras stream on the local network, while `Cloud` cameras stream through the cloud, even if the camera is on the local network.  Cloud cameras can also be added to Scrypted, but often have limited functionality, including: high latency streams, slow snapshots, unreliable motion detection, etc.

Find the matching plugin for your camera and install it in Scrypted Management Console. Multiple brands may be supported by a plugin, so check the list carefully. For example, Amcrest supports Dahua and some Lorex cameras. Hikvision supports many white labeled cameras.

If the camera is a `Local` camera, and no compatible plugin can be found, try using the `ONVIF` or `RTSP` plugin (in that order).

::: tip
When adding a camera using the appropriate `Local` camera plugin, it is recommended to log in with **admin** login credentials. Features such as Pan/Tilt/Zoom, codec configuration, etc, are often unavailable to a user account.
:::

## Amcrest

The `Amcrest Plugin` also supports Dahua and some Lorex cameras. Supports `Two Way Audio`.

* Install the ONVIF plugin if your camera has `Pan/Tilt/Zoom` capability.

## Hikvision

The `Hikvision Plugin` also supports a wide variety of whitelabled cameras such as Hitosino, etc. Supports `Two Way Audio`.

* Install the ONVIF plugin if your camera has `Pan/Tilt/Zoom` capability.

## Reolink

The `Reolink Plugin` supports Reolink cameras and doorbells. `Two Way Audio` is only supported on the doorbell.

## Tapo

The Tapo plugin *only* provides `Two Way Audio` support for Tapo cameras. The Tapo camera itself should be added using the `ONVIF Plugin`.

## Doorbird

Doorbird Plugin supports Doorbird devices, including `Two Way Audio`.

## Unifi Protect

The `Unifi Protect Plugin` supports all Unifi cameras, including `Two Way Audio`.

Create a dedicated Protect user account with `Local Administrator` permissions.

Unifi cameras must enable regular motion events/recordings. This is not the same thing as smart detections.

::: warning
A local account is required. Ubiquiti SSO accounts are not supported as they will fail to authorize if the internet is down or 2FA is required. A local account can be created in the Unifi Protect Settings on the UDM/UNVR.
:::

::: warning
Unifi Protect's `Enhanced Mode` camera configuration changes the codec to H.265 and should be disabled.
:::

## ONVIF

Most local cameras can be used with the `ONVIF Plugin`, but using this plugin is recommended only if a manufacturer plugin is not available.

## RTSP

`RTSP Plugin` should be used as a last resort, as it will require a Scrypted to do video processing to detect motion events.

* If the RTSP Camera has webhook or mail delivery for motion events, that can be used to trigger a [Dummy Motion Switch](/detection/dummy-detection) within Scrypted, and video processing will not be necessary.
* If there is no mail delivery of motion events, use one of the [Motion Detection Plugins](/detection/motion-detection) to analyze video for motion.
* When adding the camera with the `RTSP Plugin`, add and assign all available streams. There is typically a `Main Stream` and a `Substream`.

::: tip
For optimal system performance, it is extremely important to add and assign both the main stream and the sub stream. Motion analysis on a high resolution main stream may cause system instability.
:::

## Ring

The `Ring Plugin` can be used to add Ring nearly all Ring cameras, sensors, security systems, lights, and more.

## Arlo

The `Arlo Plugin` supports all Arlo cameras.

## Google

The `Google Device Access Plugin` supports Google, Nest, and Dropcam cameras, as well as Nest/Google Thermostats.

## Tuya

The `Tuya Plugin` supports Tuya cameras. It requires a Tuya developer account.

## Wyze

The `Wyze Plugin` supports Wyze cameras. It requires a Wyze email account (not Google or Apple Sign In) and [API Key](https://developer-api-console.wyze.com/#/apikey/view).

Wyze cameras do not have a built in motion sensor. Use one of the [Motion Detection Plugins](/detection/motion-detection) to analyze video for motion for HomeKit Secure Video and NVR Object Detection support.

---

---
url: /AGENTS.md
---
# AGENTS.md

## Project Overview

This is the documentation site for [Scrypted](https://scrypted.app), an open source video integration platform and NVR. The site is built with [VitePress](https://vitepress.dev) and deployed to [docs.scrypted.app](https://docs.scrypted.app).

The main Scrypted application repository is at [github.com/koush/scrypted](https://github.com/koush/scrypted).

## Build & Dev Commands

| Command | Description |
| - | - |
| `npm install` | Install dependencies |
| `npm run docs:dev` | Start the local dev server with hot reload |
| `npm run docs:build` | Build the static site into `.vitepress/dist/` |
| `npm run docs:preview` | Preview the production build locally |

## Architecture

```
.vitepress/config.ts   # VitePress configuration: sidebar, nav, head, plugins
.vitepress/theme/      # Custom theme (extends default VitePress theme)
src/                   # Vue components and TypeScript helpers used in Markdown
parts/                 # Reusable Markdown partials (included via <!--@include:-->)
install/               # Installation guide pages
scrypted-nvr/          # Scrypted NVR documentation
detection/             # Vision and AI plugin docs
buyers-guide/          # Hardware buyer's guide
maintenance/           # Server maintenance docs
home-assistant/        # Home Assistant integration docs
public/                # Static assets (images, icons)
```

### Content Conventions

* All documentation pages are Markdown files (`.md`).
* Pages can include Vue `<script setup>` blocks for interactivity (e.g., importing components from `src/`).
* Reusable content snippets live in `parts/` and are embedded into pages using VitePress's `<!--@include: ./parts/file.md-->` directive.
* Custom Vue components (e.g., `ImagePopup.vue`) are imported from `../src/` relative to the page.
* VitePress containers (`::: tip`, `::: warning`, `::: details`) are used for callouts.
* Mermaid diagrams are supported via `vitepress-plugin-mermaid`.
* The `vitepress-plugin-llms` plugin generates `llms.txt` and `llms-full.txt` for LLM consumption.

### Sidebar and Navigation

The sidebar structure is defined entirely in `.vitepress/config.ts`. When adding a new page, also add a corresponding entry to the sidebar config so it appears in navigation.

### Image and Asset References

Static assets (images, icons) live in `public/` and are referenced with absolute paths (e.g., `/img/logo.png`).

## Deployment

The site is deployed via GitHub Pages. The `CNAME` file at the repo root sets the custom domain to `docs.scrypted.app`.

## Editing Guidelines

* Write in clear, concise prose. The audience ranges from home automation enthusiasts to IT professionals.
* Use relative links between documentation pages (e.g., `[Camera Configuration](/camera-preparation)`).
* Test changes with `npm run docs:dev` before submitting.
* Run `npm run docs:build` to verify the site builds without errors.
* Keep page frontmatter minimal; VitePress config handles titles and navigation.

---

---
url: /scrypted-nvr/ai-summaries.md
---
# AI Summaries

Scrypted NVR can use AI to automatically generate natural-language descriptions of camera events. When detections occur, the AI produces a short summary and title that is delivered as a push notification and displayed in the NVR app's **Stories** tab.

## Setup

AI Summaries are configured in the `Scrypted Management Console`, under the `AI Summary` settings for the NVR plugin. Set the `AI Provider` to one of the following:

* **Cloud**: Uses a cloud-based AI provider (OpenAI, Anthropic, or Gemini). An API key is required.
* **Local**: Uses a local AI model running on your Scrypted server. Requires the `LLM Plugin` and can use llama.cpp or connect to any OpenAI compatible endpoint.

::: tip
Local models allow running AI Summaries entirely on-premises without sending images to the cloud.
:::

### Cloud Providers

Select a provider and enter the API key. A default model will be auto-populated, but any compatible model can be specified. Use the `Test Endpoint` button to verify the connection.

### Camera Groups

By default, all cameras are summarized together. Camera groups can be created in the `Advanced` settings to generate separate summaries for different sets of cameras, such as "Indoor" and "Outdoor".

::: warning
When camera groups are defined, cameras that are not assigned to any group will be excluded from AI Summaries entirely.
:::

## Notifications

When a summary is generated, a push notification is sent with an AI-generated title and a montage of detection thumbnails. Summary notifications can be enabled or disabled per camera via the notification settings, under the `Summary` notification type.

## Stories

The NVR app's camera timeline includes a **Stories** tab that displays AI summaries as story cards. Tapping a story navigates to the camera's timeline at the relevant timestamp to view the recording.

---

---
url: /alexa.md
---
# Alexa

Cameras imported into Scrypted can be streamed to the Alexa devices such as Echo Show and the Alexa mobile apps.

## Alexa Home Plugin Setup

Install the `Alexa Plugin`.

The `Alexa Plugin` will automatically enable itself on all the devices currently integrated into Scrypted. In any case, Verify the `Alexa` is enabled for the camera. If it is not, enable it, then `Reload` the `Alexa Plugin`.

## Scrypted Cloud Plugin Setup

The `Scrypted Cloud Plugin` should have been automatically installed. If it was not, install it. Then click the `Login` button to register with Scrypted's cloud service.

::: tip
Alexa connects to Scrypted's Cloud service communicate with your server. Alexa will not function without cloud connectivity.
:::

## Alexa Setup

Setup Scrypted on the Alexa app using your [Mobile Device](#mobile-device) or via the [Browser](#browser).

### Mobile Device

1. Open the Alexa app.
2. Click More > Skills & Games.
3. Click Search icon in top right.
4. Type "scrypted" and then search.
5. Click 'Scrypted Home Automation'.
6. Click 'Enable To Use'.

### Browser

1. Click [this link](https://www.amazon.com/ClockworkMod-Scrypted-Home-Automation/dp/B09WHHD9VN).
2. Note if your default marketplace isn't `amazon.com`, replace the domain with your default marketplace.
3. Click 'Enable'.

# Complete Setup

Follow on-screen prompts and log in to Scrypted with the same account from the previous setp. Your devices should now sync with Amazon Alexa.

---

---
url: /scrypted-nvr/apps.md
---
# Apps and Remote Access

Cameras and recordings can be viewed remotely via a browser or the app by enabling cloud access.

1. Install the `Scrypted Cloud Plugin`.
   * Scrypted Cloud must also be installed even if self hosting on a custom domain.
2. Login on the `Scrypted Cloud Plugin`.
3. Your cameras can now be viewed from anywhere at [nvr.scrypted.app](https://nvr.scrypted.app).

## iOS

2. [Install Scryped from the App Store](https://apps.apple.com/us/app/scrypted/id1658171214). This link must be opened on the iOS device or search for Scrypted on the App Store.
3. Login using the Scrypted Cloud credentials from the previous steps.
4. The app will prompt to login a second time. The second time, use your *local* Scrypted Server credentials.

## Android

1. [Install the Scrypted Android App](https://play.google.com/store/apps/details?id=app.scrypted.nvr) from the Google Play Store.
2. Login using the Scrypted Cloud credentials from the previous steps.
3. The app will prompt to login a second time. The second time, use your *local* Scrypted Server credentials.

## Windows, Mac, and Linux

1. Download the [Desktop Application](/desktop-application.md).
2. Enter the sign in code.
3. Select `Viewer` mode.

## Installable Web App

All of the above platforms can also install the Progressive Web App (PWA):

1. On your phone/desktop launch the appropriate browser:
   * iOS: Install with Safari
   * Android: Install with Chrome
   * Windows/Mac/Linux: Install with Edge or Chrome
2. Visit [the app installation link](https://nvr.scrypted.app/#/install-pwa) and log into Scrypted Cloud.
3. This page can be installed as an app. See [screenshot](https://user-images.githubusercontent.com/73924/194009896-359021b8-63a1-484f-aed7-35edeff92fa2.jpeg).
4. Launch the newly installed PWA.
5. Login with the Scrypted Cloud credentials used in the previous steps.
6. The app will prompt to login a second time. The second time, use your *local* Scrypted Server credentials.

---

---
url: /maintenance/migration.md
---
# Backup and Restore

When migrating to the `Desktop Application` **on the same server**, continue with the [Desktop Migration](#migrating-to-the-desktop-application) steps below. Otherwise follow the steps to [Create A Backup](#create-a-backup) and [Restore A Backup](#restore-a-backup) to another server.

## Migrating to the Desktop Application

When migrating to the Desktop Application on the same server, first stop the existing command line or Docker installation:

::: code-group

```sh [Mac]
launchctl unload ~/Library/LaunchAgents/app.scrypted.server.plist 
rm ~/Library/LaunchAgents/app.scrypted.server.plist
rm -rf ~/.scrypted/node_modules
```

```powershell [Windows]
sc.exe stop scrypted.exe
sc.exe delete scrypted.exe
Remove-Item -Recurse -Force $env:USERPROFILE\.scrypted\node_modules
```

```sh [Linux]
sudo systemctl stop scrypted.service
sudo rm /etc/systemd/system/scrypted.service
rm -rf ~/.scrypted/node_modules
```

```sh [Docker Compose]
cd ~/.scrypted
docker compose down
rm -rf ~/.scrypted/node_modules
```

:::

Install the Desktop app, and then delete the following plugins if they are installed. These plugins are no longer necessary, as the Desktop Application has hardware accelerated equivalents:

* PAM-Diff
* Python Codecs
* OpenCV

The Scrypted data migration is now complete.

## Create a Backup

![](/img/create-backup.png)

1. Click Settings in the sidebar of the Management Console.
2. Click Backup to download the backup file.

* The backup does **not** include NVR recordings.

::: tip
Backups can be automated using other tools (curl, wget, etc) by using this URL:
`https://[scrypted-server-ip]:10443/web/component/backup`. The web request will require `Basic` authentication using an admin account on the Scrypted server.
:::

## Restore a Backup

1. Click Settings in the sidebar of the Management Console.
2. Click Restore and select the backup file.

* Restoring the backup will restart the server.
* All users, settings, and plugins will be restored to the state of the backup.
* The restore will trigger plugins to redownload additional data like Object Detection Models.

::: warning
Restoring a backup from a *different* system will also restore that system's `Scrypted Server Address`. These addresses can be found within the Scrypted Management Console sidebar Settings. The old addresses must be removed and updated with the addreses of the new system.
:::

## Manual Backup and Restore

The Manual Backup and Restore steps below must be performed on a Scrypted server that is shutdown/stopped.

::: code-group

```sh [Docker Compose]
cd ~/.scrypted
docker compose down
```

```sh [Linux]
sudo systemctl stop scrypted.service
sudo rm /etc/systemd/system/scrypted.service
```

```sh [Mac]
launchctl unload ~/Library/LaunchAgents/app.scrypted.server.plist 
rm ~/Library/LaunchAgents/app.scrypted.server.plist
```

```powershell [Windows]
sc.exe stop scrypted.exe
sc.exe delete scrypted.exe
```

:::

### Locate Database

The Scrypted database can be copied to another server by copying the `volume` directory. The `volume` path depends on your current installation host platform:

::: code-group

```[Linux]
~/.scrypted/volume
```

```[Mac]
~/.scrypted/volume
```

```[Windows]
%USERPROFILE%\.scrypted\volume
```

:::

### Copy Database

::: tip
If the Scrypted server is being upgraded to the [Desktop App](/desktop-application) or a different installation method, skip the `Copy` step and simply run the installer. The existing Scrypted Database will be used in place.
:::

1. `Copy` the `volume` to your new server, and place it in the appropriate location. The volume can be restored on any other Scrypted installation, even another architecture or host OS.
2. Start Scrypted on the new server.
3. Update the `Scrypted Server Address` setting since the new server will have a different IP address.

---

---
url: /camera-preparation.md
---
# Camera Configuration

Before adding a camera to Scrypted, the stream settings are configured for max compatibility with HomeKit, Google Home, Alexa, and [Scrypted NVR](https://demo.scrypted.app/#/demo). The steps below detail the optimal settings for these streaming destinations.

## Camera Administration

Open the Camera's web admin page or app to configure its codecs, motion sensor, and other various settings. Some cameras may not have a configuration tool. Cloud cameras like Ring, Google, and Arlo should continue on to [Adding the Camera](/add-camera).

## Authentication Setup

Ensure the camera password is a simple alphanumeric phrase. Special characters *often* cause issues when authenticating with RTSP, HTTP, or other camera services. If the camera supports both `Basic` and `Digest` Authorization, configure it for `Digest` only, which is more secure.

::: warning
The camera login must have administrator level access. Motion event reporting and camera auto configuration is only available to administrator accounts.
:::

::: warning
Reolink cameras must use simple alphanumeric passwords or the stream will fail to load.
:::

## Stream Setup

Streams must be set up to enable all available video and audio streams and configuring the codecs for compatibility with HomeKit, Scrypted NVR, etc.

### Disable on Camera AI

Some cameras, such as Hikvision or Amcrest, expose more streams and `Framerate` options when on camera AI is disabled. This feature is not used by Scrypted NVR or HomeKit, and should be disabled for improved streaming performance. Hikvision's `VCA Resource`, for example, should be set to `Monitoring`.

### Enable all Streams

Enable the all available streams on the camera. Scrypted will use multiple streams, if available, for different purposes (remote streaming, analysis, etc). Most cameras will have one one `Main Stream` and one `Substream`. Some may only have a `Main Stream`. Cameras with one `Main Stream` and two `Substreams` are ideal.

If there are multiple substreams, check the substreams in the dropdown or list to ensure they are all enabled. Ensure audio is also enabled on all the streams. 4K Hikvision and Amcrest, for example, have 1 main stream and 2 substreams. Note that the Hikvision is set to `Video&Audio` to ensure audio playback:

::: tip
Hikvision and other camera models require that the `Report to Surveillance Center` Option is checked.
:::

## Video Setup

### H.264 Video Codec

::: tip
HomeKit, Google Home, Alexa, and the web all **require** H.264 for live streaming.

Cameras encoding H.265 will suffer severe picture quality degradation during playback due to transcoding (in addition to the massively increased CPU usage and latency). Thus it is highly recommended that cameras encode H.264 natively.

Reolink cameras only output H.265 in 4k mode, but will use H.264 if the resolution is lowered to 2k. Even though the resolution is lower, the picture quality at native 2k is better than transcoded 4k.

Unifi Protect's `Enhanced Mode` changes the codec to H.265 and should be disabled.
:::

Set all the stream video codecs to `H.264` (M or Main profile if specifiable). Do **NOT** use `H.264+`, `Super H.264`, etc: **TURN OFF/DISABLE ALL SPECIAL VARIANTS**. Sometimes this unsupported variant setting is called `Smart Code(c)` and it should be set to `Close` or `Off`.

#### Main Stream Setup

If the camera only has a single main stream, configure it as `1920x1080` and `2 Mbit`. The camera may support a higher resolution, but without substreams, it is recommended to use balanced settings. Otherwise, use the max available resolution for the `Main Stream`.

|Main Stream Resolution|Bitrate|
|-|-|
|3840x2160|8 Mbit, Variable/VBR|
|2688x1520|3.5 Mbit, Variable/VBR|
|1920x1080|2 Mbit, Variable/VBR|

#### Sub Stream(s) Setup

|Stream|Max Resolution|Bitrate|
|-|-|-|
|Substream 1 or 2|1280x720|1 Mbit, variable|
|Substream 1 or 2|640x360|500 Kbit, variable|

### Framerate Settings

Configuring the camera frame rate involves changing two related settings: the `Frame Rate` and the `Frame Interval` (also sometimes referred to as `Keyframe Interval`, `I-Frame Interval`, or `Interframe Space`). Cameras will allow configuration either the `Interval` or `Space`. Use the settings guide below.

|Frame Rate|Interval|Space|
|-|-|-|
|20|80|4 (or 2)|

If `Frame Rate` of `20` is unavailable, `10` can be used instead.

|Frame Rate|Interval|Space|
|-|-|-|
|10|40|4 (or 2)|

#### Framerate Explanation

* Any `Frame Rate` between 10 and 30 is fine, and the chosen `Frame Rate` will determine the `Frame Interval`.
* A `4 (or 2) second frequency`, aka the `Interframe Space`, can be used to compute the `Frame Interval`.
  * `Interframe Space` is the number of seconds between keyframes. `Frame Interval` is the number frames between keyframes.
  * Cameras are typically configured in `Frame Interval`. The formula for `Frame Interval` value is: `Frame Interval = 4 seconds * Frame Rate`. Examples:
    * If `Frame Rate` is `30`, `Frame Interval` should be set to `120`.
    * If `Frame Rate` is `20`, `Frame Interval` should be set to `80`.
    * If `Frame Rate` is `10`, `Frame Interval` should be set to `40`.

## Audio Setup

Configure the audio codec on all streams by manufacturer recommendation below, and codec availability.

|Manufacturer|Codec|Sample Rate|
|-|-|-|
|Amcrest/Dahua|AAC|8000|
|Other Manufacturer|PCM-ulaw/G711u/G711mulaw|8000|

## Motion Sensor Setup

Most cameras have a built in motion sensor. It may be disabled by default, or have a blank activity zone. For optimal results, it is *highly recommended* to configure the motion zones to filter extraneous activity:

* Trees, bushes, or other objects that may trigger motion via wind.
* Camera facing a busy road will trigger motion on every passing car.

If the camera does not have a motion sensor, use a [Motion Detection Plugin](/detection/motion-detection) to enable sofware motion detection.

## Enable ONVIF

`ONVIF` is a standard camera communication channel for motion, snapshots, two way audio, codecs configuration. and pan/tilt/zoom. It is available on most `Local` cameras and should be enabled (even if not using the `ONVIF Plugin`).

* Enable `ONVIF` on the camera.
* Some cameras require entering a separate username and password for the ONVIF service. Ensure the `ONVIF` service has a user set up with the **same** username and password credentials used for the camera itself.

---

---
url: /buyers-guide/cameras.md
---
# Camera Recommendations

## Camera Checklist

For optimal Scrypted performance in [HomeKit](/homekit), [Alexa](/alexa), [Google Home](/google-home), and [Scrypted NVR](/scrypted-nvr/), look for:

* Local streaming via RTSP/RTMP
* Wired connection (power over ethernet) is strongly recommended. Use wireless sparingly to reach areas that may not be easily serviced with PoE.
* H.264 video with configurable codec settings (`Framerate`, `Bitrate`, and `Frame Interval`).
* 2-3 `Main` and `Substreams`. Additional `Substreams` provides Scrypted with the flexibility to provide the best stream for any connection.
* Night Color cameras have better object detection performance than Infrared. This is preferable if there is some amount of ambient light.

Unifi cameras are recommended, but this doc will focus on cameras that do not require adoption into the Unifi ecosystem, which can be cost prohibitive or not meet specific hardware requirements. One can generally find better cameras at lower prices and more flexibility in choices.

The links and models below are ones that [@koush](https://github.com/koush) has personally purchased or have received positive user reports. Please verify that the link corresponds with the given model number, as the listing under the link may change.

## Doorbell

In addition to the Unifi G4 Doorbell, the following doorbells have full Scrypted support: doorbell events and two way audio.

* [Reolink Wifi/PoE Doorbell](https://www.amazon.com/REOLINK-Doorbell-Detection-Storage-Assistant/dp/B0B7S3JSG7/ref=sr_1_3?hvadid=623182026151\&hvdev=c\&hvlocphy=9061303\&hvnetw=g\&hvqmt=e\&hvrand=4474805440243407911\&hvtargid=kwd-1392011983863\&hydadcr=18883_13355422\&keywords=reolink+camera+doorbell\&qid=1681099620\&sr=8-3\&ufe=app_do%3Aamzn1.fos.18ed3cb5-28d5-4975-8bc7-93deae8f9840)

* [Amcrest AD410](https://www.amazon.com/Amcrest-Doorbell-Detection-Weatherproof-Wide-Angle/dp/B091KMT9GB/ref=sr_1_1?crid=1Y6SVFORAH6GS\&keywords=ad410\&qid=1669356288\&s=electronics\&sprefix=ad410%2Celectronics%2C145\&sr=1-1\&ufe=app_do%3Aamzn1.fos.18ed3cb5-28d5-4975-8bc7-93deae8f9840)

::: tip
A two way audio camera can be combined with a smart button to create a doorbell in Scrypted. This is a flexible and reliable solution. Within HomeKit, Google Home, and Alexa, the doorbell group will behave exactly like any other Doorbell. See the [DIY Doorbell](https://github.com/koush/scrypted/wiki/Do-It-Yourself-Doorbell).
:::

## 8MP/4K Cameras

* One Way Audio
  * [Amcrest IP8M-T2669EW-AI](https://www.amazon.com/s?k=amcrest+8mp+ai\&crid=2Z8QPKLQ68WCF\&sprefix=amcrest+8mp+ai%2Caps%2C143\&ref=nb_sb_noss_1): This has 3 streams, and a great price. Solid 4K choice on a budget.
  * Hikvision models with 3 streams such as DS-2CD2086G2-IU are highly recommended, but 2 streams is totally fine too. More expensive but has better image quality in both day and night.
* Two Way Audio
  * [Hikvision DS-2CD2386G2-ISU/SL](https://www.amazon.com/Hikvision-DS-2CD2386G2-ISU-SL-AcuSense-Original/dp/B09JJWYQJ5/ref=sr_1_1_sspa?crid=GV0C06DJSRXA\&keywords=DS-2CD2386G2-ISU%2FSL\&qid=1689003265\&sprefix=ds-2cd2386g2-isu%2Fsl%2Caps%2C192\&sr=8-1-spons\&ufe=app_do%3Aamzn1.fos.18ed3cb5-28d5-4975-8bc7-93deae8f9840\&sp_csd=d2lkZ2V0TmFtZT1zcF9hdGY\&psc=1): Stunning picture quality.
* Night Color + Two Way Audio
  * [Hikvision DS-2CD2087G2H-LIU/SL](https://www.ebay.com/sch/i.html?_from=R40&_trksid=p2332490.m570.l1313&_nkw=DS-2CD2087G2H-LIU%2FSL&_sacat=0)

::: warning
It is not recommended to buy a 4K wireless cameras, as the stream bitrate will be problematic on a wireless network, resulting in dropped frames and connections.
:::

::: warning
Reolink 4K cameras *only* supports H.265 in 4K mode. Dropping the resolution to 2K mode allows H.264 usage, but the image is cropped, and has a narrower field of view. Reolink 4K cameras are not recommended.
:::

## 4MP/2K Cameras

* PoE
  * One Way Audio
    * [Amcrest IP5M-T1179EW](https://www.amazon.com/Amcrest-5-Megapixel-NightVision-Weatherproof-IP5M-T1179EW-28MM/dp/B083G9KT4C/ref=sr_1_2_sspa?crid=3GF8K377TKHYI\&keywords=amcrest+4mp\&qid=1669361597\&sprefix=amcrest+4mp%2Caps%2C156\&sr=8-2-spons\&sp_csd=d2lkZ2V0TmFtZT1zcF9hdGY\&psc=1)
    * [Reolinks 810a](https://www.amazon.com/REOLINK-Detection-Timelapse-Recording-RLC-810A/dp/B07K74GWX5/ref=sr_1_1_sspa?crid=3HM3VPTXYPTQO\&keywords=reolink%2B4K%2Bpoe\&qid=1689003324\&sprefix=reolink%2B4K%2Bpo%2Caps%2C136\&sr=8-1-spons\&ufe=app_do%3Aamzn1.fos.18ed3cb5-28d5-4975-8bc7-93deae8f9840\&sp_csd=d2lkZ2V0TmFtZT1zcF9hdGY\&th=1): Cheap and has 3 RTMP streams. This camera is advertised as a 4K camera, but the 4K stream is HEVC/H.265 only, which is not recommended for use with Scrypted. The H.264 stream is 2K.
    * Any Amcrest, Hikvision (Hitosino), or Reolink is fine really.
  * Two Way Audio
    * [Hikvision DS-2CD2346G2-ISU/SL](https://www.amazon.com/HITOSINO-Acusense-Darkfighter-Camera-Built/dp/B092MGTHNS/ref=sr_1_10?crid=1SNGDCXTCUTQ7\&keywords=hitosino%2Btwo%2Bway\&qid=1669354931\&s=electronics\&sprefix=hitosino%2Btwo%2Bway%2Celectronics%2C105\&sr=1-10\&ufe=app_do%3Aamzn1.fos.18ed3cb5-28d5-4975-8bc7-93deae8f9840\&th=1)
  * Night Color
    * [Hikvision DS-2CD2047G2-LU](https://www.ebay.com/sch/i.html?_from=R40&_trksid=p2334524.m570.l1313&_nkw=hikvision+4mp+colorvu+bullet&_sacat=0&_odkw=DS-2CD2087G2H-LIU%2FSL&_osacat=0)
* Wireless
  * One Way Audio
    * [Reolink 510a](https://www.amazon.com/Security-Security-2-4-Detection-Waterproof-RLC-510WA/dp/B08PYN7TS2/ref=sr_1_1_sspa?crid=3C6EUD88K8I8S\&keywords=reolink+2K+wireless\&qid=1689004037\&sprefix=reolink+2k+wireles%2Caps%2C129\&sr=8-1-spons\&ufe=app_do%3Aamzn1.fos.18ed3cb5-28d5-4975-8bc7-93deae8f9840\&sp_csd=d2lkZ2V0TmFtZT1zcF9hdGY\&psc=1)
    * [Tapo C110](https://www.amazon.com/smart-indoor-security-camera-tapo/dp/B09YL5G1Y8/ref=sr_1_6?hvadid=570485739804\&hvdev=c\&hvlocphy=9033320\&hvnetw=g\&hvqmt=e\&hvrand=12813899484270259277\&hvtargid=kwd-822050146986\&hydadcr=10039_13478011\&keywords=tapo%2Bc200\&qid=1689003849\&sr=8-6\&th=1): Indoor camera.
    * [Tapo C210](https://www.amazon.com/indoor-pet-wifi-camera-tapo/dp/B09Y8TLP25/ref=sr_1_2?crid=499XUYK8UKNR\&keywords=tapo%2Bc210\&qid=1689003913\&s=electronics\&sprefix=tapo%2Bc210%2Celectronics%2C128\&sr=1-2\&th=1): Indoor camera. Has Pan/Tilt functionality.
    * [Tapo C310](https://www.amazon.com/security-camera-wireless-outdoor-tapo/dp/B08LHG2W7Y/ref=asc_df_B08LHG2W7Y/?tag=hyprod-20\&linkCode=df0\&hvadid=600153859656\&hvpos=\&hvnetw=g\&hvrand=18132377741092454297\&hvpone=\&hvptwo=\&hvqmt=\&hvdev=c\&hvdvcmdl=\&hvlocint=\&hvlocphy=9033320\&hvtargid=pla-1129824239938\&th=1): Outdoor camera.
  * Two Way Audio
    * [Amcrest IP4M-1041](https://www.amazon.com/Amcrest-UltraHD-Security-4-Megapixel-IP4M-1041W/dp/B095XD17K5/ref=sr_1_1_sspa?crid=27ASRHBUE0BM4\&keywords=4mp+amcrest\&qid=1669355229\&s=electronics\&sprefix=4mp+amcrest%2Celectronics%2C107\&sr=1-1-spons\&ufe=app_do%3Aamzn1.fos.18ed3cb5-28d5-4975-8bc7-93deae8f9840\&sp_csd=d2lkZ2V0TmFtZT1zcF9hdGY\&psc=1): Indoor camera.
    * The Tapo cams listed above all include two way audio that are varying degrees of functional. Tapo uses a proprietary reverse engineered protocol for two way audio, they are prone to breakage with firmware updates or manufacturer whims. Using older firmwares may be necessary, which is why they are not in the two way audio recommendation list.

## 1080P/2MP

The price point difference between 1080p and 2K is minimal, just get a 2K camera and run it at 1080p if you must. The same brand recommendations as 2K apply.

---

---
url: /buyers-guide/report-card.md
---
# Camera Report Card

This report card is intended to help guide your purchasing decisions.

* **Do not buy cloud cameras.**
* Notes per plugin are included after the report card.

### Local Cameras

|Manufacturer|Codecs|Motion|Talkback|Snapshots|Doorbell|
|------------|------|------|--------|---------|--------|
|Hikvision   |     A|     A|       A|        A|       N|
|Amcrest     |     A|     A|       A|        A|       Y|
|ONVIF       |     A|     A|       A|        A|       Y|
|Unifi       |    B+|     A|      B\*|       D\*|       Y|
|Reolink     |     B|     C|      A\*|        A|       Y|
|Tapo        |    B-|     C|      C\*|        F|       Y|

### Cloud Cameras

**DO NOT BUY**. These are all cloud cameras and should not be purchased.

|Manufacturer|Codecs|Motion|Talkback|Snapshots|Doorbell|
|------------|------|------|--------|---------|--------|
|Ring        |     D|     D|       A|        F|       Y|
|Tuya        |     C|     B|       F|        F|       N|
|Arlo        |     C|     D|       F|        F|       N|
|Google Gen 2|     C|     F|       F|        F|       Y|
|Nest        |     F|     D|       F|        F|       Y|

## Hikvision

Excellent high end cameras.

## Amcrest

Excellent budget cameras. Do not buy Amcrest Smart Home `ASH-` models as most of them do not support RTSP and are not compatible with Scrypted. The `AD-` models work great.

## ONVIF

Not all ONVIF cameras support motion events and two way audio. For example, Hikvision and Amcrest support both, but Reolink only supports Motion. Codec quality and performance will vary by manufacturer.

## Unifi

This is the only local camera known to support the Opus audio codec, which is the ideal codec for streaming. Offers 3 streams. Unifi does not allow codec configuration. This has caused issues, such as breaking HomeKit Secure Video, in the past. Do not enable `Enhanced Mode` as that changes the camera codec to H.265 which is not compatible with most other platforms.

Unifi Two Way Audio is a proprietary protocol that may break without notice.

Unifi snapshots are only refreshed every 10 seconds. Snapshots are also very low resolution and look pixelated in the Home app and elsewhere. Using Prebuffer Snapshots resolves this at the cost of significant CPU usage, however, those are on a 5 second refresh.

## Reolink

Offers 3 RTMP streams. Two way audio is only supported on the Doorbell and possibly some other newer models.

## Tapo

Motion detection seems spotty. The camera does not have a snapshot url. That means snapshots are decoded from the video stream, and this causes additional CPU load. Tapo uses a proprietary two way audio protocol that may be broken on current or future firmware updates.

## Ring

Camera can't be prebuffered because motion events will not be delivered while viewing. SIP stream contains SEI information, requiring bitstream processing which adds latency. Motion is cloud delivered and slow/buggy. Snapshots can't be requested while someone is viewing the stream and must be pulled from a live stream. This can be expensive and will use excessive bandwidth. **Ring Edge supports local video streaming**. Unable to configure codecs which may be unsuitable for remote streaming due to high bandwidth, and requires transcoding.

## Arlo

Camera can't be prebuffered because motion events will not be delivered while viewing. Two Way Audio is not implemented. Motion is cloud delivered and slow/buggy. Snapshots can't be requested while someone is viewing the stream and must be pulled from a live stream. This can be expensive and will use excessive bandwidth.

## Google Camera Gen 2

Camera can't be prebuffered because motion events will not be delivered while viewing. Spotty motion events. Difficult setup. No snapshots. Do not buy. Throw in garbage.

## Nest

Camera can't be prebuffered because motion events will not be delivered while viewing. Spotty motion events. Difficult setup. Spotty snapshots. Do not buy. Throw in garbage.

## Tuya

No notes yet. Seems better than other cloud cameras, but still severely limited.

---

---
url: /camera-validation.md
---
# Camera Validation

After the camera has been installed and added to Scrypted, install the `Diagnostics` plugin and perform the validation process on the camera.

Camera validation will check the camera's configuration, motion sensor, snapshots, and other functionality:

```
============================================
Device Validation: Kitchen
============================================
Device Selected          Running
                         OK
Device Capabilities      Running
                         OK
Motion Detection         Running
                         OK
Recent Motion            Running
                         OK
Snapshot                 Running
                         OK
Streams                  Running
                         OK
Local                    Running
                         OK
Local (IDR)              Running
                         OK
Local Recorder           Running
                         Skipped (Duplicate)
Remote Recorder          Running
                         OK
Remote Recorder (IDR)    Running
                         OK
Remote                   Running
                         Skipped (Duplicate)
Low Resolution           Running
                         OK
Low Resolution (IDR)     Running
                         OK
Audio Codecs             Running
                         OK
============================================
Device Validation Complete: Kitchen
============================================
```

## Troubleshooting

The `Console` button in the camera's page within Scrypted can be used to view the logs for the camera, in case there are errors. The camera Plugin may also have documentation troubleshoot common issues.

## Continue Setup

After verifying the camera stream and motion sensor functionality, continue on to the [Platform](/platforms.md) or [Scrypted NVR](/scrypted-nvr/) setup.

---

---
url: /maintenance/cluster.md
---
# Cluster Mode

`Cluster Mode` enables distributed computing. Plugin, detection, decode, and encode will automatically be assigned to the best suitable machine in a cluster.

A Scrypted installation can operate in either `server` or `client` mode. There can only be one `server` machine but there may be multiple `client` machines. The `server` machine will ingest the camera streams, while `client` machines will perform detection. Machines in a cluster can be a mix of operating systems and architectures. For example, you can use a NAS saving video Unraid (`server`) with a Mac Mini performing detection (`client`).

## Cluster Mode Networking

Cluster servers and clients must be on the same network with no NAT or firewall between them.

## Cluster Server Setup

The Cluster server will ingest the camera streams and save them to the NVR storage.

```sh
# Set worker type. There can only be one server.
SCRYPTED_CLUSTER_MODE=server
# This is the IP of this machine.
SCRYPTED_CLUSTER_ADDRESS=192.168.2.130
SCRYPTED_CLUSTER_SECRET=swordfish
SCRYPTED_CLUSTER_LABELS=storage
```

Restart the server.

Upon successful configuration, Cluster workers, including the server itself, will be listed within the `Plugins` page in the Scrypted Management Console sidebar.

::: warning
Compute plugins like OpenVINO will fail to load until a Cluster Client is set up and connected in the next section.
:::

## Cluster Client Setup

A Cluster client will perform video decoding and detection.

When adding a client, install Scrypted as usual. Account creation is not necessary. Once the server is running, create and edit Scrypted `.env` configuration file:

::: tip
When using the Scrypted Desktop App as a Cluster Client, the initial setup must be configured to use Scrypted Server Mode. The startup mode can be changed in the app's system menu via `Reset Startup Settings`. After configuring the `.env` below the the the Desktop app will join the cluster as a client.
:::

```sh
# Set worker type. There can be multiple clients.
SCRYPTED_CLUSTER_MODE=client
# this is the IP of the server machine,
# matching the SCRYPTED_CLUSTER_ADDRESS in the prior section.
SCRYPTED_CLUSTER_SERVER=192.168.2.130
SCRYPTED_CLUSTER_SECRET=swordfish
# designate this worker as available for decode and detection workloads
SCRYPTED_CLUSTER_LABELS=compute,transcode,@scrypted/openvino
# if this is a mac, delete the previous line and
# use @scrypted/coreml label instead
# SCRYPTED_CLUSTER_LABELS=compute,transcode,@scrypted/coreml
```

Restart the client.

::: info
Cluster clients are not accessible at https port 10443 like the server. All connected clients can be viewed and managed from the primary server.

`Plugins` in the sidebar will show connected workers and their running processes.

`Server Settings` in the sidebar will show `Cluster Settings`.
:::

## Optional Properties

```sh
# Custom name for the worker
SCRYPTED_CLUSTER_WORKER_NAME=my-worker-name
```

---

---
url: /install/desktop-app.md
---
# Desktop App

The recommended installation method for Mac and Windows is the [Desktop App](/desktop-application). The app provides hardware accelerated
features unavailable to the background service inside a self contained, easily installable, package. The app can also serve as a viewer for an existing Scrypted server installation. The desktop app requires a paid license.

## Ubuntu/Debian Repository

::: tip
Scrypted servers running on Linux should typically use the [Docker](#linux-docker) installation.
:::

The Desktop App can be installed and updated via `apt`:

```sh
echo 'deb [trusted=yes] https://nuts.scrypted.app/apt stable main' | sudo tee /etc/apt/sources.list.d/scrypted.list
sudo apt update
sudo apt install scrypted-electron
```

Install the Desktop App from the above instructions. The management console can be accessed via the app.

## Releases Repository

The latest and legacy releases of the desktop apps can be found in the [Releases Repository](https://github.com/koush/nvr.scrypted.app/releases) page on Github.

---

---
url: /scrypted-nvr/storage/docker.md
---
# Docker Volume

Use the [Quick Setup](#quick-setup) script to format a disk or use an existing directory in Scrypted NVR. [Manual Docker Setup](#manual-docker-setup) steps are also available.

## Quick Setup

::: tip
Before using the following Quick Setup script, remove any existing `NVR Storage Directory` setting from the `NVR Plugin Settings`. Manual configuration is not necessary with this script, the container will be automatically configured if no configuration is provided.
:::

Run the following to download the [script](https://github.com/koush/scrypted/blob/main/install/docker/setup-scrypted-nvr-volume.sh):

```sh
mkdir -p ~/.scrypted
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/docker/setup-scrypted-nvr-volume.sh > ~/.scrypted/setup-scrypted-nvr-volume.sh
```

If a recording directory is already formatted and mounted, follow the steps at [Existing Storage Directory](#existing-storage-directory). Otherwise continue on to formatting a [New Disk](#new-disk).

### Existing Storage Directory

::: tip
The existing storage directory should be on an ext4 filesystem.
:::

```sh
sudo SERVICE_USER=$USER bash ~/.scrypted/setup-scrypted-nvr-volume.sh /path/to/existing/directory
```

The docker container will be updated and restarted with the new Recordings Directory.

### New Disk

Run the following to list available disks:

```sh
lsblk
```

The output will be similar to below:

```
NAME   MAJ:MIN RM   SIZE RO TYPE MOUNTPOINTS
loop0    7:0    0  63.4M  1 loop /snap/core20/1974
loop1    7:1    0  63.9M  1 loop /snap/core20/2105
loop2    7:2    0 111.9M  1 loop /snap/lxd/24322
loop3    7:3    0  53.3M  1 loop /snap/snapd/19457
loop4    7:4    0  40.4M  1 loop /snap/snapd/20671
sda      8:0    0   128G  0 disk 
├─sda1   8:1    0     1M  0 part 
└─sda2   8:2    0   128G  0 part /
sdx      8:16   0  4096G  0 disk 
sr0     11:0    1  1024M  0 rom  
```

In the example above the 4TB storage disk is listed as `sdx`. To format and use `sdx`, run:

```sh
sudo SERVICE_USER=$USER bash ~/.scrypted/setup-scrypted-nvr-volume.sh sdx
```

The docker container will be updated and restarted with the new disk.

Continue on to [Enable Camera Recording](/scrypted-nvr/camera-recording).

## Manual Docker Setup

1. The storage disk must be formatted as `ext4` or `xfs`.
2. Edit `~/.scrypted/docker-compose.yaml`.
3. Make the highlighted changes in the yaml block below, adjust the storage directory as appropriate.
4. Restart the container by running the following:

```sh
cd ~/.scrypted && docker compose down && docker compose up -d
```

## docker-compose.yaml

```yaml{13,36}
services:
  scrypted:
    environment:
      # Scrypted NVR Storage (Part 2 of 3)

      # Uncomment this line to configure the NVR plugin to store
      # recordings within the /nvr directory inside the container.
      # DO NOT MODIFY /nvr.
      # The Recordings Directory in the NVR Plugin will autopopulate
      # with /nvr (unless it was manually changed earlier).
      # The disk or network share will ALSO need to be configured in
      # Part 3.
      - SCRYPTED_NVR_VOLUME=/nvr

      - SCRYPTED_WEBHOOK_UPDATE_AUTHORIZATION=Bearer SET_THIS_TO_SOME_RANDOM_TEXT
      - SCRYPTED_WEBHOOK_UPDATE=http://localhost:10444/v1/update

      # Uncomment next 3 lines for Nvidia GPU support.
      # - NVIDIA_VISIBLE_DEVICES=all
      # - NVIDIA_DRIVER_CAPABILITIES=all

      # Uncomment next line to run avahi-daemon inside the container
      # Don't use if dbus and avahi run on the host and are bind-mounted
      # (see below under "volumes")
      # - SCRYPTED_DOCKER_AVAHI=true
    # runtime: nvidia

    volumes:
      # Scrypted NVR Storage (Part 3 of 3)

      # Modify to add the add a Recordings Directory for Scrypted NVR.
      # The following example would mount the /mnt/media/video path on
      # the host to the /nvr path inside the docker container.
      # Modify /mnt/media/video according to the server path.
      # DO NOT MODIFY /nvr.
      - /mnt/media/video:/nvr

      # Or use a network mount from one of the CIFS/NFS examples at the top of this file.
      # - type: volume
      #   source: nvr
      #   target: /nvr
      #   volume:
      #     nocopy: true

      # uncomment the following lines to expose Avahi, an mDNS advertiser.
      # make sure Avahi is running on the host machine, otherwise this will not work.
      # not compatible with Avahi enabled via SCRYPTED_DOCKER_AVAHI=true
      # - /var/run/dbus:/var/run/dbus
      # - /var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket

      # Default volume for the Scrypted database. Typically should not be changed.
      - ~/.scrypted/volume:/server/volume
```

---

---
url: /detection/dummy-detection.md
---
# Dummy Detection

## Dummy Switch Plugin

The `Dummy Switch Plugin` can be used to create `Motion` and `Binary` sensors within Scrypted that are triggered by an external event, like the `Webhook Plugin` or `Mail Plugin`.

## Mail Plugin

Older `RTSP Cameras` that do not support `ONVIF` may support mail delivery of motion events. The `Mail (SMTP) Plugin` can be used to listen for incoming mail, and trigger a motion sensor linked to that `RTSP Camera`.

## Dummy Switch Plugin Setup

1. Install the `Dummy Switch Plugin`.
2. `Add New` Dummy Switch. This switch will activate a motion sensor.
3. Find the RTSP Camera within Scrypted.
4. Enable the `Custom Motion Sensor` Extension.
5. Select the `Dummy Switch` that was created and `Save`.

## Mail Plugin Setup

1. Install the `Mail Plugin`.
2. Enable the `Mail` Extension on the `Dummy Switch` that was previously configured.
3. Enter a unique mail address (any username and domain is valid, it won't actually be sent there) and `Save`.

### Camera Setup

1. Open the Camera's web admin page or app.
2. Navigate to SMTP Settings.
3. Enter the IP of your `Scrypted Server` as the SMTP server.
4. Disable `Login Anonymously` if it is enabled.
5. Provide any authentication credentials (Scrypted does not require it).
6. Provide the email address that was used in the previous step for both the Sender and Recipient.
7. Navigate to Event or Motion Settings.
8. Enable Send SMTP/Mail on the motion event.



---

---
url: /scrypted-nvr/features.md
---
# Features

## Smart Detections

### Timeline and Events

The Timeline and Events views are powered by `Smart Detections` that highlight key moments in the day: people and cars arriving and leaving, packages, and animals.

## Face Recognition

Tag and recognize faces for use in [automations](/detection/smart-motion-sensor.md).

## License Place Recognition

Recognize and search vehicle plates.

## Rich Notifications

Rich Notifications are delivered instantly to iOS, Android, and Web apps with a thumbnail of the detection.

## AI Search

Search across the history of all cameras using natural language.

## AI Summaries

Scrypted NVR can use AI to automatically generate natural-language descriptions of camera events. When detections occur, the AI produces a short summary and title that is delivered as a push notification and displayed in the NVR app's **Stories** tab. [Setup guide](/scrypted-nvr/ai-summaries).

## Adaptive Bitrate

Scrypted NVR leverages all the camera substreams and transcoding to provide bulletproof streams, regardless of downstream network conditions.

::: tip
Adaptive Bitrate is a [Platform](/platforms) level feature, and **also** improves streaming to HomeKit, Google Home, Alexa, and Home Assistant.
:::

## Hardware Accelerated AI

Scrypted NVR `Smart Detections` use one of the available [Object Detection Plugins](/detection/object-detection) which can run on:

* CPU
* GPU
* Apple Silicon Neural Engine 🔥
* Intel Core Ultra NPU 🔥
* [Coral.ai](https://coral.ai) accelerators

### Apple Silicon

Scrypted NVR can leverage the [Neural Engine](https://www.makeuseof.com/what-is-a-neural-engine-how-does-it-work/) on the new Apple Silicon chips using the `CoreML Plugin`. Incredible performance at low power. Installing the [Scrypted Desktop App](/desktop-application) is recommended on Mac.

### Intel

Scrypted NVR supports Intel iGPUs and accelerator cards for blazing fast detection performance using the `OpenVINO Plugin`. 12th Generation Intel processors like the N100 have great performance at a low power and price point.

Intel Core Ultra chips with the built in NPU are also supported and provide state of the art performance.

### NVIDIA

Scrypted NVR supports object detection on NVIDIA GPUs via the `ONNX Plugin`. NVIDIA object detection requires CUDA, which is only provided in [Scrypted's NVIDIA Docker image](/installation.html#docker-compose-yml) when using the `koush/scrypted:nvidia` image.

### Google Coral EdgeTPU

Scrypted NVR supports object detection using the [Google Coral.ai](https://coral.ai) accelerators via the `Tensorflow-Lite Plugin`. The PCI and USB models are both supported.

---

---
url: /google-home.md
---
# Google Home

Cameras imported into Scrypted can be streamed to the Google Home devices such as Chromecast, Android TV, and the Nest Hub. Camera streaming is not supported by Google Home in the Google Home iOS app.

## Google Home Plugin Setup

Install the `Google Home Plugin`.

The `Google Home Plugin` will automatically enable itself on all the devices currently integrated into Scrypted. In any case, Verify the `Google Home` is enabled for the camera. If it is not, enable it, then `Reload` the `Google Home Plugin`.

## Scrypted Cloud Plugin Setup

The `Scrypted Cloud Plugin` should have been automatically installed. If it was not, installed it. Then click the `Login` button to register with Scrypted's cloud service.

::: tip
Google Home connects to Scrypted's Cloud service communicate with your server. Google Home will not function without cloud connectivity.
:::

## Google Home Setup

1. Open the Google Home app on iOS or Android.
2. Link/Add a new device.
3. Link the `Scrypted Home Automation` service.
4. Log in with the same credentials used for the `Scrypted Cloud Plugin`.
5. Scrypted is now connected and all selected devices are available in Google Home.

**Note:** Video streaming no longer works in the Google Home app - you'll need to use a Nest Hub to view.

---

---
url: /buyers-guide.md
---
# Hardware Recommendations

When choosing [cameras](/buyers-guide/cameras.md) or [server hardware](/buyers-guide/servers.md), it's important to choose hardware that supports the features required by downstream [Platforms](/platforms) and [Scrypted NVR](/scrypted-nvr/). Camera hardware with the right capabilities can dramaticially reduce Server hardware requirements.

---

---
url: /home-assistant.md
---
# Home Assistant

The Scrypted Custom Component for Home Assistant adds support for managing Scrypted from your Home Assistant Dashboard, and creation of Scrypted NVR cards. A demo of the cards is available on the [Scrypted NVR Home Assistant Demo Site](https://ha-demo.scrypted.app).

## Addon Setup

:::tip
The Custom Component must be installed even if using the Scrypted Home Assistant Addon.
:::

If Scrypted was installed via the [Home Assistant Addon](https://github.com/koush/scrypted/wiki/Installation:-Home-Assistant-OS), complete the following steps, otherwise continue on to [Install Custom Component](#install-custom-component).

1. Navigate to the Scrypted Addon in the Home Assistant sidebar. A separate dedicated Scrypted `admin` must be created in `Users` in the sidebar menu (the default `homeassistant` automatic login user can not be used).

2) Now, remove the `Scrypted` sidebar item via the Addon configuration. The custom component will supercede the addon sidebar item.

## Install Custom Component

The [Scrypted Custom Component](https://github.com/koush/ha_scrypted) repository can be found on github.

1. Install the custom component using the [Home Assistant Community Store (HACS)](https://hacs.xyz) by adding the `Custom Repository`:

```
https://github.com/koush/ha_scrypted
```

2. In the HACS panel, select `Scrypted` from the repository list and select the `INSTALL` button.
3. Go to `Settings > Devices & Services > Add Integration` and select `Scrypted`.
4. Enter the host, username, and password for your Scrypted server, as well as a name and icon for the side panel link in the Home Assistant menu.

|Setting|Sample Configuration|
|-|-|
|Host|192.168.2.124:10443|
|Username|admin|
|Password|swordfish!|

::: tip
If Scrypted was installed as a Home Assistant Addon, there is no default login. A dedicated admin account will need to be created for the custom component. The `Host` will be `127.0.0.1:10443`.
:::

Scrypted can now be accessed in the Home Assistant side panel.

## Card Setup

Scrypted NVR provides Home Assistant cards that feature low latency playback and two way audio. The NVR app is also deeply integrated into the Home Assistant UI.

There are two types of cards available:

* Camera Card
* Event Reel Card

### Custom Card Installation

::: warning
The Custom Card Installation step only needs to be done one time to make the Custom Cards available for usage. Do not add the Resources to Home Assistant twice.
:::

To begin using the Scrypted NVR Cards, you must first register the Custom Card javascript and css `Resources` in Home Assistant. Prepare the following paths by replacing `<token>` as appropriate with the same value from the Custom Component setup.

JavaScript Resource:

```
/api/scrypted/<token>/endpoint/@scrypted/nvr/assets/web-components.js
```

CSS Resource:

```
/api/scrypted/<token>/endpoint/@scrypted/nvr/assets/web-components.css
```

Then [Register the Resources](https://developers.home-assistant.io/docs/frontend/custom-ui/registering-resources/) in Home Assistant.

### Add Custom Card

Follow the instructions below, and then substitute the card id appopriately.

1. Open Scrypted NVR inside Home Assistant using a **desktop browser**.
2. Navigate to the camera.
3. Open the the `Camera Settings`.
4. Copy the `Scrypted NVR Card id`. This id can be used in either the Camera or Event Reel Card.

::: warning
If the Home Assistant `Integrate` configuration is unavailable, verify the following:

1. Scrypted must be opened from **inside** Home Assistant. The Home Assistant integration configuration is only available from inside Home Assistant.
2. The [Custom Component](#install-custom-component) (and [Addon setup](#addon-setup), if applicable) **must correctly be completed** prior to setting up the cards.
3. The Integration URL is available within the camera's settings reachable by clicking the settings icon *under the camera playback view*. Not to be confused with the primary NVR app settings.
   :::

5) Add the following `Manual Card` in Home Assistant and replace/paste the previously copied `Scrypted NVR Card id` below:

```yaml
type: custom:scrypted-nvr-camera
id: 42
```

## Camera Card Options

The Scrypted NVR card behavior can be configured using yaml parameters.

### Auto Play

Play the card video on load.

```yaml[Auto Play]
type: custom:scrypted-nvr-camera
id: 42
live: true
```

### Image Click

The parameter `imageClick` can be used to customize how click events are handled when the snapshot is clicked.

|Value|Description|
|-|-|
|`ha`|Navigate to the camera inside Scrypted within the Home Assistant companion app when clicked.|
|`popup`|View the camera in a popup.|
|`popup-no-timeline`|View the camera in a popup with no recording playback timeline.|
|`app`|Open the Scrypted NVR app when clicked.|
|`none`|Do nothing when clicked.|

Example: Open Scrypted NVR Timeline in Home Assistant when the still image is clicked.

```yaml[Image Click]
type: custom:scrypted-nvr-camera
id: 42
imageClick: ha
```

### Video Click

The parameter `videoClick` can be used to customize how click events are handled when the live video is clicked.

|Value|Description|
|-|-|
|`ha`|Navigate to the camera inside Scrypted within the Home Assistant companion app when clicked.|
|`popup`|View the camera in a popup.|
|`popup-no-timeline`|View the camera in a popup with no recording playback timeline.|
|`app`|Open the Scrypted NVR app when clicked.|
|`none`|Do nothing when clicked.|

Example: Open Scrypted NVR Timeline in Home Assistant when the playing video is clicked.

```yaml[Video Click]
type: custom:scrypted-nvr-camera
id: 42
videoClick: ha
```

### Theme

The parameter `theme` can be used to customize the light or dark theme of the `popup` window.

|Value|Description|
|-|-|
|`light`|Light theme.|
|`dark`|Dark theme.|

```yaml[Video Click]
type: custom:scrypted-nvr-camera
id: 42
theme: dark
```

### Resolution

By default the Card live stream will dynamically assign a stream based on card size.  However, in most cases it's recommended to use the `low-resolution` stream: it loads fast, uses minimal resources, is thus best suited for a small frame. The resolution can be changed with the `destination` parameter. Supported destination values include `low-resolution`, `remote`, and `local`.

:::warning
Using the high resolution stream (`local`) for a Cards is not recommended, as it can cause the Home Assistant Dashboard to become sluggish with multiple cards.
:::

```yaml[Resolution]
type: custom:scrypted-nvr-camera
id: 42
destination: local
```

### Audio

By default the Card live stream will mute both the microphone and the speaker (two way audio).

::: warning
Browsers will prevent autoplay with audio playback and microphone access prior to user interaction via a click event. The dashboard must be set to Allow on [Chrome](https://support.google.com/chrome/answer/2693767?hl=en\&co=GENIE.Platform%3DDesktop) and Safari.
:::

```yaml[Audio]
type: custom:scrypted-nvr-camera
id: 42
speakerOn: true
microphoneOn: true
```

## Event Reel Card

The Event Reel shows the recent highlighted events in a scrollable reel. The Event Reel card has its own parameters that can be used to used to customize the cameras and events shown:

|Name|Default Value|Description|
|-|-|-|
|ids|`All Cameras`|The camera `ids` shown in the reel. The `ids` parameter is a comma separated list of device ids to display in the camera grid. If this parameter is ommitted, all are shown by default.|
|hiddenDetections|`Motion`|The detection types to hide in the reel. `Person`, `Vehicle`, `Animal`, etc. All except generic `Motion` are shown by default.|
|cols|`Responsive`|The number of columns in the event reel.|
|count|`cols`|The total number of items to show in an event reel page. Can be combined with `cols` to create a reel with multiple rows.|
|aspectRatio|`1/1`|The aspect ratio of a detection thumbnail.|
|click|`ha`|The app that will be opened when clicked. Valid values include `ha` (Home Assistant), `app` (Scrypted NVR App), or `none` (do nothing).|

For example, for a 5x2 grid of events that only shows Person and Animal detections:

```yaml
type: custom:scrypted-nvr-events-carousel
click: ha
count: 10
cols: 5
hiddenDetections:
  - Motion
  - Vehicle
```

Another example with all detections (unclassified Motion is filtered by default) but filtering events to specific cameras:

```yaml
type: custom:scrypted-nvr-events-carousel
click: ha
count: 10
cols: 5
ids:
  - 42
  - 43
```

### Click

The parameter `click` can be used to customize how click events are handled when the event reel is clicked.

|Value|Description|
|-|-|
|`ha`|Navigate to the camera inside Scrypted within the Home Assistant companion app when clicked.|
|`popup`|View the camera in a popup.|
|`popup-no-timeline`|View the camera in a popup with no recording playback timeline.|
|`app`|Open the Scrypted NVR app when clicked.|
|`none`|Do nothing when clicked.|

## Summary Reel Card

::: warning
This card is only available in the Scrypted NVR Beta plugin.
:::

The Summary Reel shows the recent camera summaries in a scrollable reel. The Summary Reel card has its own parameters that can be used to used to customize the cameras and summaries shown:

|Name|Default Value|Description|
|-|-|-|
|id|N/A|The primary camera `id` shown in the reel. Other cameras that were summarized alongside this camera will also be shown in the smaller thumbnails. The Scrypted NVR Card id.|
|click|`ha`|The app that will be opened when clicked. Valid values include `ha` (Home Assistant), `app` (Scrypted NVR App), or `none` (do nothing).|

```yaml
type: custom:scrypted-nvr-summary-carousel
id: 42
click: ha
```

## Sizing Cards

Sizing cards in Sections view can be done using `grid_options`. For exampe, to make the Event Reel Card above full width:

```yaml
type: custom:scrypted-nvr-events-carousel
click: ha
count: 10
cols: 5
hiddenDetections:
  - Motion
  - Vehicle
grid_options:
  columns: full
```

Note that the `grid_options` configuration contains the standard [Sections view sizing parameters](https://developers.home-assistant.io/docs/frontend/custom-ui/custom-card#sizing-in-sections-view).

## Styling Cards

Styles can be applied to cards using standard css styles. For example, applying a rounded border to the camera card:

```yaml
type: custom:scrypted-nvr-camera
id: 42
style: "border-radius: 16px; overflow: hidden; aspect-ratio: 16/9;"
```

## Notifications

::: warning
The [Custom Component](#install-custom-component) (and [Addon setup](#addon-setup), if applicable) **must correctly be completed** prior to setting up notifications.
:::

Scrypted NVR Notifications can be delivered to the Home Assistant Companion app.

1. Install and configure the Scrypted Cloud plugin. This is necessary to receive notification images.
2. Install the Home Assistant Plugin for Scrypted.
3. Configure the Home Assistant Long Lived Access Token (this is not the same token used in the previous steps) and Address in the Plugin Settings.
4. The Home Assistant `notify` (Notify Service) entities should sync.
5. Find the companion app `Notify Service` entity within the Home Assistant Plugin. It will be named something similar to `mobile_app_iphonex`.

* Enable the `Scrypted NVR Users` extension.

6. Configure the following settings within the `mobile_app_iphonex` device.

* Assign a `Scrypted User`.
* Paste the `Scrypted Token` used by the Home Assistant Custom Component.
* **Click Save**.

7. After the settings have been saved, click the Link Companion App button. A notification will be sent to the companion app.
8. Click the notification to complete linking and allow customization of notifications from the companion app.
9. The Notification options can also be configured in the Scrypted Management Console.

---

---
url: /home-assistant-legacy-cards.md
---
# Home Assistant Legacy Cards

::: warning
The documentation on this page is for the legacy Home Assistant Scrypted NVR cards that used the Webpage (iframe) card. Users are encouraged to use the [new cards](/home-assistant#card-setup) instead for improved performance and customization.
:::

## Card Setup

Scrypted NVR provides Home Assistant cards that feature low latency playback and two way audio. The NVR app is also deeply integrated into the Home Assistant UI.

There are several types of cards available:

* Single Camera Card
* Camera Grid Card
* Event Reel Card

:::tip
Configuring multiple cameras within a single `Camera Grid Card` dramatically improves performance and load times.
:::

Follow the instructions below, and then substitute the card URL appopriately.

1. Open Scrypted NVR inside Home Assistant using a **desktop browser**.
2. Navigate to the camera.
3. Open the the `Camera Settings`.
4. Copy the `Scrypted NVR Card Webpage URL`. (Substitute this with [Camera Grid](#camera-grid-card) or [Event Reel](#event-reel-card) URL if desired.)

::: warning
If the Home Assistant `Integrate` configuration is unavailable, verify the following:

1. Scrypted must be opened from **inside** Home Assistant. The Home Assistant integration configuration is only available from inside Home Assistant.
2. The [Custom Component](#install-custom-component) (and [Addon setup](#addon-setup), if applicable) **must correctly be completed** prior to setting up the cards.
3. The Integration URL is available within the camera's settings reachable by clicking the settings icon *under the camera playback view*. Not to be confused with the primary NVR app settings.
   :::

5) Add the following `Webpage Card` in Home Assistant and replace/paste the previously copied `Scrypted NVR Card Webpage URL` below:

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>
allow_open_top_navigation: true
layout_options:
  grid_columns: full
  grid_rows: 4.25
```

## Camera Card Options

The Scrypted NVR card behavior can be configured using query string parameters on the `Webpage URL`.

### Auto Play

Play the card video on load.

`live=true`

```yaml[Auto Play]
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?live=true
```

### Image Click

The parameter `imageClick` can be used to customize how click events are handled when the snapshot is clicked.

|Value|Description|
|-|-|
|`ha`|Open the Home Assistant companion app when clicked.|
|`app`|Open the Scrypted NVR app when clicked.|
|`none`|Do nothing when clicked.|

Example: Open Scrypted NVR Timeline in Home Assistant when the still image is clicked.

`imageClick=ha`

```yaml[Image Click]
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?imageClick=ha
```

### Video Click

The parameter `videoClick` can be used to customize how click events are handled when the live video is clicked.

|Value|Description|
|-|-|
|`ha`|Open the Home Assistant companion app when clicked.|
|`app`|Open the Scrypted NVR app when clicked.|
|`none`|Do nothing when clicked.|

Example: Open Scrypted NVR Timeline in Home Assistant when the playing video is clicked.

`videoClick=ha`

```yaml[Video Click]
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?videoClick=ha
```

### Resolution

By default the Card live stream will use the `low-resolution` stream: it loads fast, uses minimal resources, is thus best suited for a small frame. The resolution can be changed with the `destination` parameter. Supported destination values include `low-resolution`, `remote`, and `local`.

:::warning
Using the high resolution stream (`local`) for a Cards is not recommended, as it can cause the Home Assistant Dashboard to become sluggish with multiple cards.
:::

`destination=local`

`destination=remote`

```yaml[Resolution]
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?destination=local
```

### Audio

By default the Card live stream will mute both the microphone and the speaker (two way audio).

::: warning
Browsers will prevent autoplay with audio playback and microphone access prior to user interaction via a click event. The dashboard must be set to Allow on [Chrome](https://championcr.com/topic/enable-auto-play/) and [Safari](https://help.mixlr.com/en/articles/1665450-enabling-auto-play-in-safari).
:::

`microphone=on`

`speaker=on`

```yaml[Audio]
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?speaker=on&microphone=on
```

### Scrollable

By default the Camera Grid is not scrollable. Use the following to make it scrollable:

`scrollable=true`

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=1,2,3&scrollable=true
allow_open_top_navigation: true
```

### Multiple Parameters

Multiple parameters may be combined using `&`.

```yaml[Video Click]
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?imageClick=ha&videoClick=ha&live=true
```

## Camera Grid Card

Multiple cameras can be configured within a single `Webpage Card`. Configuration is similar to the single camera card, albeit a slightly different url format. The iframe url is:

|Card Type|URL Fragment|
|-|-|
|Single Camera (Reference)|`...#/iframe/<id>`|
|Camera Grid|`...#/iframegrid?ids=<id1>,<id2>`|

The `ids` parameter is a comma separated list of device ids to display in the camera grid. The grid card works best in a [Panel View](https://www.home-assistant.io/dashboards/panel/), but can be adjusted for [Masonry View](https://www.home-assistant.io/dashboards/masonry/) by using fixed column values.

For example:

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=<id1>,<id2>
allow_open_top_navigation: true
layout_options:
  grid_columns: full
  grid_rows: 9.5 # 4.25 * number of rows that will be shown

```

The Camera Grid card has additional parameters that can be used to used to customize the layout based on the device type and screen orientation:

|Name|Device Type|Screen Orientation|Default Value|
|-|-|-|-|
|phonePortraitCols|Phone|Portrait|`1`|
|phoneLandscapeCols|Phone|Landscape|`2`|
|tabletPortraitCols|Tablet|Portrait|`2`|
|tabletLandscapeCols|Tablet|Landscape|`3`|
|desktopMinWidth|Desktop Browser|N/A|`480` (pixels)|
|cols|All Devices|N/A|N/A|
|focus|All Devices|N/A|N/A|

Use `desktopMinWidth` to set the minimum width of a camera within the grid and controls the cell wrap behavior. For example, with the default value of `480`, if the screen is `960` pixels, the grid will be 2 columns. If the screen is `1920` pixels, the grid will be 4 columns.

Use `cols` to set a fixed number of columns for all screen sizes and orientations.

Use `focus` to focus on cameras that have ongoing motion. When there is no activity on the selected cameras, all cameras will be shown as the default state.

## Event Reel Card

The Event Reel shows the recent highlighted events in a scrollable reel. Configuration is similar to the single camera card, albeit a slightly different url format. The iframe url is:

|Card Type|URL Fragment|
|-|-|
|Single Camera  (Reference)|`...#/iframe/<id>`|
|Event Reel|`...#/iframeevents?ids=<id1>,<id2>`|

The Event Reel card has additional parameters that can be used to used to customize the cameras and events shown:

|Name|Default Value|Description|
|-|-|-|
|ids|`All Cameras`|The camera `ids` shown in the reel. The `ids` parameter is a comma separated list of device ids to display in the camera grid. If this parameter is ommitted, all are shown by default.|
|hiddenDetections|`Motion`|The detection types to hide in the reel. `Person`, `Vehicle`, `Animal`, etc. All except generic `Motion` are shown by default.|
|cols|`Responsive`|The number of columns in the event reel.|
|count|`cols`|The total number of items to show in an event reel page. Can be combined with `cols` to create a reel with multiple rows.
|aspectRatio|`1/1`|The aspect ratio of a detection thumbnail.|
|click|`ha`|The app that will be opened when clicked. Valid values include `ha` (Home Assistant), `app` (Scrypted NVR App), or `none` (do nothing).|

For example, for a 4x1 grid of events:

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframeevents?ids=<id1>,<id2>&cols=4
allow_open_top_navigation: true
type: iframe
url: >-
  /api/scrypted/3713673acab4bdd3214e673700fe48d4/endpoint/@scrypted/nvr/public/#/iframe/41?cols=1&videoClick=ha&live=true
allow_open_top_navigation: true
layout_options:
  grid_columns: full
  grid_rows: 2.3
```

---

---
url: /homekit.md
---
# HomeKit

Cameras imported into Scrypted can be streamed to the iOS/macOS Home App including support for [HomeKit Secure Video](https://support.apple.com/guide/icloud/set-up-homekit-secure-video-mm7c90d21583/icloud).

::: info
HomeKit Secure Video requires a HomePod or Apple TV. Detection of people, cars, and packages is done entirely on the Apple Home Hub. AI accelerators like Coral.ai are unnecessary.
:::

## HomeKit Setup

Install the `HomeKit Plugin`.

The `HomeKit Plugin` will automatically enable itself on all the devices currently integrated into Scrypted. In any case, Verify the `HomeKit Plugin` is enabled for the camera. If it is not, enable it, then `Reload` the `HomeKit Plugin`.

## HomeKit Pairing

Navigate to the Camera within Scrypted Management Console. View the `HomeKit` Settings and open the `Pairing` section. The pairing QR Code and manual codes can be found there. Each Camera will have [its own QR Code](#homekit-bridge-vs-accessory-mode). Use your iOS app to scan the QR Code and add it to the Home app.

## HomeKit Secure Video

HomeKit Secure Video (HKSV) requires cameras with motion sensors and specific codec settings. Both of these settings should have already been configured as part of the [Camera Configuration](/camera-preparation).

Enable `Stream and Recording` on the camera in the iOS Home app.

## HomeKit Bridge vs Accessory Mode

HomeKit can connect to two different types of devices: `Accessories` and `Bridges`. `Bridges` host multiple devices, while `Accessories` only host one. By default, cameras in Scrypted are paired in `Accessory Mode`. Each Camera in Scrypted will have its own QR Code. While this can be tedious to set up compared to Home Assistant and Homebridge which Bridge their cameras, Accessory Mode results in better performance:

When HomeKit connects to a Bridge, it can only send and receive one request and response at a time. That means if any device on that Bridge, requests to all other devices on that Bridge are delayed until the slow device sends a response. This delay can be particularly troublesome when the camera is slow to respond to snapshot requests.

For example, suppose a server has 10 cameras on a Bridge. When the Home app is opened on iOS, each camera is sent a snapshot request, one by one. If each camera takes 500 milliseconds to respond to the snapshot request to load the image, the Bridge may take up to 5 seconds to process further requests, like viewing a camera stream or turning on a light.

This is a architectural limitation in HomeKit that will likely never be resolved (as there are no official camera Bridges), so the Scrypted recommendation to use Accessory Mode,  like real HomeKit Cameras.

---

---
url: /homekit-troubleshooting.md
---
# HomeKit Troubleshooting

## Discovery and Pairing Issues

* Ensure all your Apple TV and Home Pods are online and updated. Power cycling them is recommended in case one is stuck.
* Ensure your Apple TV and Home Pods are on the same subnet as the Scrypted server.
* Ensure LAN/WLAN multicast is enabled on your router.
* Ensure the iOS device you are using for pairing is on the same network (pairing will fail on cellular).
* Ensure the Docker installation (if applicable) is using host networking. This configuration is the default if the official Scrypted Docker compose install script was used.
* Try switching the mDNS advertiser used in the HomeKit plugin settings.
* Try disabling IGMP Snooping on your router.
* Use the `Reset Pairing` option in the camera's HomeKit settings to start fresh.

### mDNS Advertiser Options

Scrypted uses mDNS-based to make your accessories discoverable by Apple devices.
There are 3 mDNS Advertisers that Scrypted can interface with to advertise itself on the local network:

* [Ciao](#ciao)
* [Bonjour](#bonjour)
* [Avahi](#avahi)

### Ciao

Ciao is the default advertiser that Scrypted uses.

For non-Linux users, `ciao` should provide the best experience. It fixes a lot of the deficiencies of the `bonjour` advertiser. However, you might experience issues in the following two scenarios.

#### Network Interface Selection

Ciao tries to be aware of multiple network interfaces.
On startup, it tries to evaluate which network interfaces to advertise on by default.
In certain circumstances, ciao is unable to properly determine the set of valid network interfaces (e.g., when dealing with virtual network interfaces on containerised environments).

#### Multiple Advertisers

On some systems, there is already a mDNS advertiser stack running (e.g. avahi on linux). There might be issues running multiple mDNS advertisers on the same host.

### Bonjour

Bonjour is a legacy advertiser. It is not as efficient in terms of system resource usage and network traffic when compared to the other options.

### Avahi

Avahi is a mDNS advertiser that is installed by default on many linux distributions.

For Linux users, Avahi should provide the best experience.
Note that your system must have the `avahi-daemon` and `dbus` services installed and running for this option to work.

If using Scrypted through `docker compose`, be sure to uncomment the volume mounts to expose Avahi to the container.

## Recording Failure

If recordings dont work, it's generally because of a few reasons, **follow the steps to determine where it is failing before asking for help**:

1. The motion wasn't triggered. You can view if there are motion events in the camera `Events` section (a small icon button next to the `Console` button. If no motion event was delivered to Scrypted this may be for several reasons which may depend on the camera type, including:

* Local cameras:
  * Motion detection is disabled in the camera. Enable in the camera manufacturer admin app/webpage. Unifi cameras must have motion recordings/events enabled in Protect.
  * There are no motion zone configured on the camera, and there is no default zone. Configure in the camera manufacturer admin app/webpage.
  * The camera may not support motion detection via that plugin (ie, an ONVIF camera not supporting the ONVIF-T profile). Using another delivery mechanism such as mail (SMTP) or webhook is an alernative and reliable option.
* Cloud cameras:
  * Motion delivery issue from the cloud service.

2. After a motion trigger, the home hub will start recording. Verify that HomeKit is requesting recording by looking in the Camera's Console: you will see logs such as `[HomeKit]: Camera recording session starting`. If you do not see this, there are a few possible causes and solutions:

* The Home Hubs are bugged out and have stopped responding to motion. Reboot all Home Hubs when this happens. **iPads and HomePods, which are wireless, are not reliable Home Hubs.** If you have an iPad as a Home Hub, remove it from acting as a Home Hub from within the iOS Home app. Unfortunately this is not possible to do with HomePods. As of iOS 18, it is possible to manually select the active hub in the Home app.
* Your iCloud account is in a bad state. Log out of iCloud on your iPhone, and log back in. Then disable and reenable HomeKit Secure Video on your cameras again.
* Your Scrypted server is on a different subnet from your home hub(s). This may work for live streaming, but home hubs will not initiate recording if they are on a different subnet. Ensure your Scrypted server is on the same subnet as the home hubs.

3. If HomeKit requested the video, but nothing showed up in the timeline:

* HomeKit may have decided the motion wasn't worth recording. Set your HomeKit recording options to all motion when testing.
* The recordings are in a bad format that can't be used by HomeKit. See below for optimal HomeKit Codec Settings. Enabling `Debug Mode` (select `Transcode Video` and `Transcode Audio`) in the HomeKit settings for that camera may fix this for testing purposes, but long term usage is not recommended as it reduces quality and increases CPU load.
* Try rebooting your Home Hubs (HomePods and AppleTVs). Make sure they are fully up to date.

## Live Streaming Timeout

Live streaming timeout where Recordings may be working is commonly a network issue.

This is always a issue with the network setup.

* Ensure you are not connected to a VPN.
* You may have multiple network interfaces, such as wired and wireless, and HomeKit is preferring the wireless interface. Configure the `Scrypted Server Address` setting in the sidebar and set it to the wired IP address manually.
* Flatten your network topology. If your camera/server/iOS are on a separate VLANs, try disabling VLANs to determine if that is the issue.
* You wifi network is saturated, resulting in heavy packet loss. Enabling Transcode Debug Mode in the HomeKit settings for that camera may fix this for testing purposes, but long term usage is not recommended as it reduces quality and increases CPU load.
* This is *may* be a codec issue (but as mentioned earlier, is usually a network issue). Try enabling Transcoding on both Live and Remote streams.

## Live Streaming stops after a few seconds on macOS

Live streaming may stop after 5-6 seconds in the macOS Home app if the Mac does not have a microphone input configured/available, even if you're viewing a camera without two-way audio. (This is most likely a macOS bug).

In the macOS "Sound" settings under the "Input" tab, ensure a working input option is selected.

## Remote Streaming Failure

This almost always due to your camera bitrate being too high for remote streaming through Apple's servers. Workarounds:

1. Use a lower bitrate substream for Remote Streaming.
2. Enable Transcoding on Remote Streaming.

Other things to check:

1. Ensure the Home app has cellular network permission.

---

---
url: /installation.md
---
# Install Scrypted

Scrypted can be installed on Windows, Mac, or Linux as a [desktop app](/install/desktop-app) or as a background service ([Mac](/install/mac-terminal), [Windows](/install/windows-powershell), [Proxmox VE](/install/proxmox-ve), [Linux - Docker](/install/linux-docker)).

::: tip
After selecting and completing installation, return to the docs to continue with [Camera Setup](/camera-preparation.md).
:::

## Recommended Servers

* [Mac/Windows Desktop App](/install/desktop-app)
  * The desktop app is also available for Linux but only recommended to be used as a viewer for [Scrypted NVR](/scrypted-nvr/).
* [Proxmox VE](/install/proxmox-ve)

## Docker Servers

::: danger
Scrypted will not work in Docker Desktop for Mac or Windows due to the unavailability of host networking via the `--network host` flag.
:::

* [Linux](/install/linux-docker)
* [Unraid](/install/unraid-docker.md)
* [ReadyNAS](https://github.com/koush/scrypted/wiki/Installation:-Docker-ReadyNAS)
* [Synology](https://github.com/koush/scrypted/wiki/Installation:-Docker-Synology-NAS)
* [QNAP](https://github.com/koush/scrypted/wiki/Installation:-Docker-QNAP-NAS)
* [Home Assistant OS](https://github.com/koush/scrypted/wiki/Installation:-Home-Assistant-OS)
  * Home Assistant OS is not recommended for use with Scrypted NVR due to limited storage capabilities.

## All Installation Options

* [Mac - Terminal](/install/mac-terminal): Install Scrypted via the terminal on macOS.
* Windows
  * [PowerShell Installation](/install/windows-powershell)
  * [WSL2 Installation](https://github.com/koush/scrypted/wiki/Installation:-WSL2-Windows)
* [Proxmox VE](/install/proxmox-ve)
* [Linux - Docker Compose](/install/linux-docker)
* [Unraid - Docker](/install/unraid-docker.md)
* [Home Assistant OS](https://github.com/koush/scrypted/wiki/Installation:-Home-Assistant-OS)
  * Home Assistant OS is not recommended for use with Scrypted NVR due to limited storage capabilities.
* [ReadyNAS: Docker](https://github.com/koush/scrypted/wiki/Installation:-Docker-ReadyNAS)
* [Synology: Docker](https://github.com/koush/scrypted/wiki/Installation:-Docker-Synology-NAS)
* [QNAP: Docker](https://github.com/koush/scrypted/wiki/Installation:-Docker-QNAP-NAS)

## Proxmox VE vs Docker

[Proxmox VE](https://www.proxmox.com) is preferred for Scrypted over Docker for several reasons:

* Superior networking capabilities. The Scrypted installation on Proxmox will have a dedicated IP on the local network. Scrypted requires host networking on Docker, **which cause conflicts when running alongside other host networking services like Pi-hole or Homebridge.**
* Simple storage setup with Scrypted NVR. Proxmox provides a web interface for formatting new drives and adding them to containers like Scrypted.
* Automatic iGPU passthrough for hardware accelerated decoding and detection when using the installation script.
* Proxmox provides a web interface by default, which is great for headless/dedicated services. The OS is lightweight and designed for running containers and VMs.

After the chosen installation method is complete, return to this page to continue with [Camera Setup](/camera-preparation.md).

---

---
url: /llm.md
---
# Large Language Models

Scrypted supports integrating with large language models running in the cloud or locally.

## LLM Plugin

Install the LLM plugin in Scrypted to get started. then click `Add New` to add a cloud or local large language model.

## Cloud Provider

The LLM Plugin supports ChatGPT, Claude, and Gemini. You will need to bring your own API key, which requires setting up a billing account or pay as you go account with the provider. Choose the provider and enter the key.

The following models are recommended for price and performance considerations:

| Provider | Model |
|----------|-------|
| OpenAI | `gpt-5.4-nano` |
| Anthropic | `claude-haiku-4-5` |
| Gemini | `gemini-3.1-flash-lite` |

## Local Model

::: warning
Ollama and LM Studio do not provide fully compliant OpenAI endpoints and may not work correctly. Using the LLM Plugin hosted llama.cpp is preferred. vLLM and SGLang are also recommended.
:::

Local models will require capable hardware:

* Mac (16GB RAM, Apple Silicon)
* NVIDIA GPU (12GB RAM)
* AMD GPU (12GB RAM)
* AMD AI MAX

::: tip
Models can be run in [Cluster Mode](/maintenance/cluster.md) and and offloaded to a GPU running on another machine or a Mac.
:::

Local models are hosted using [llama.cpp](https://github.com/ggerganov/llama.cpp). The LLM plugin will install llama.cpp automatically when a new model is added to Scrypted.

The model the server can run is dependent on how much VRAM is available on the system.

| Model | Min VRAM | Model ID |
|-------|----------|------------------|
| Qwen3.5-4B | 5 GB | `unsloth/Qwen3.5-4B-GGUF` |
| Qwen3.5-9B | 8 GB | `unsloth/Qwen3.5-9B-GGUF` |
| Gemma 4 E4B | 8 GB | `unsloth/gemma-4-E4B-it-GGUF` |
| Qwen3.5-27B | 20 GB | `unsloth/Qwen3.5-27B-GGUF` |
| Gemma 4 26B-A4B | 21 GB | `unsloth/gemma-4-26B-A4B-it-GGUF` |
| Gemma 4 31B | 24 GB | `unsloth/gemma-4-31B-it-GGUF` |
| Qwen3.5-35B-A3B | 26 GB | `unsloth/Qwen3.5-35B-A3B-GGUF` |

Larger models generally provide better results, but have diminishing returns.

::: warning
Selecting a model that is too large for the available memory will cause system instability.
:::

---

---
url: /install/linux-docker.md
---
# Linux - Docker

Linux + Docker installations should refer to the [System Requirements](/server-hardware#scrypted-host-operating-system) for host OS recommendations. Docker Desktop on Windows/Mac is [not supported](https://github.com/koush/scrypted/wiki/Installation:-Docker-Desktop).

This script below will download and configure the the docker-compose.yml and install Scrypted as a service.

Use the Copy button in the snippet below to copy the entire script, and then paste the contents into Terminal to install Scrypted.

```sh
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/docker/install-scrypted-docker-compose.sh > ~/install-scrypted-docker-compose.sh 
sudo SERVICE_USER=$USER bash ~/install-scrypted-docker-compose.sh
rm ~/install-scrypted-docker-compose.sh
```

There will be a prompt to install Docker and set up external storage for Scrypted NVR. External storage is completely optional and can be set up later.

## docker-compose.yml

The [docker-compose.yml](https://github.com/koush/scrypted/blob/main/install/docker/docker-compose.yml) that contains the Scrypted configuration can be found at `~/.scrypted/docker-compose.yml`. Modification is typically not necessary. Alternate docker images are available:

|Image|Description|
|-|-|
|`ghcr.io/koush/scrypted`|The default image.|
|`ghcr.io/koush/scrypted:nvidia`|Image that includes full NVIDIA CUDA support for hardware accelerated transcoding and detection. The host must have CUDA, cuDNN, and NVIDIA container runtime installed. Then [modify the docker-compose.yml](https://github.com/koush/scrypted/blob/9a8034eb4ce35cff08201698110335a8fbafb0fc/install/docker/docker-compose.yml#L41) with the necessary changes for NVIDIA.|
|`ghcr.io/koush/scrypted:nvidia-legacy`|Image that includes full NVIDIA CUDA support for hardware accelerated transcoding and detection. The host must have CUDA, cuDNN, and NVIDIA container runtime installed. Then [modify the docker-compose.yml](https://github.com/koush/scrypted/blob/9a8034eb4ce35cff08201698110335a8fbafb0fc/install/docker/docker-compose.yml#L41) with the necessary changes for NVIDIA.|

::: tip
NVIDIA devices older than the Turing Series, ie, the 10 series and older, should use the `nvidia-legacy` image.
:::

---

---
url: /maintenance/lost-password.md
---
# Lost Password

If you have lost your Scrypted username or password but still have administrator access on the hosting server, you can reset all users by doing the following:

Using the terminal, create an empty file depending on your platform:

::: code-group

```[Docker Compose]
touch ~/.scrypted/volume/reset-login
```

```[Proxmox]
touch ~/.scrypted/volume/reset-login
```

```[Linux]
touch ~/.scrypted/volume/reset-login
```

```[Mac]
touch ~/.scrypted/volume/reset-login
```

```[Windows Command Prompt]
type nul > %USERPROFILE%\.scrypted\volume\reset-login
```

:::

Reload the Scrypted login page to be prompted to create a new administrator account.

These steps will keep your configuration intact, and only reset the users.

---

---
url: /install/mac-terminal.md
---
# Mac - Terminal

Scrypted NVR on Mac must install the [Install](/desktop-application) or [Migrate](/maintenance/migration.md#migrating-to-the-desktop-application) to the [Desktop Application](/install/desktop-app.md). The Desktop App has GPU acceleration, is fully self contained with zero dependencies, and requires a license. The free version of Scrypted may be installed using the Terminal Installation below.

This script below will download all the dependencies, including node, python, and install Scrypted as a service.

1. Install [Homebrew](https://brew.sh).
2. Use the Copy button in the snippet below to copy the entire script, and then paste the contents into Terminal to install Scrypted.

```sh
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/local/install-scrypted-dependencies-mac.sh > ~/install-scrypted-dependencies-mac.sh 
bash ~/install-scrypted-dependencies-mac.sh
rm ~/install-scrypted-dependencies-mac.sh
```

---

---
url: /scrypted-nvr/storage/mac.md
---
# Mac Storage

::: danger
When creating a NVR Recordings folder on macOS, the folder name must end with `.noindex`. This prevents macOS Spotlight from indexing the folder. Spotlight's indexing of NVR Recordings will cause system instability and crashes. For example, if the NVR Recordings folder is currently `/Volumes/MyExternalDrive/scrypted-nvr`, rename it to `/Volumes/MyExternalDrive/scrypted-nvr.noindex` and then update the setting in the NVR plugin.

Additionally, a directory should be created on the storage disk for video use.  MacOS will not honor the `.noindex` directive on the mount point itself.  The NVR Recording folder should be `/Volumes/MyExternalDrive/scrupted-nvr.noindex` and not `/Volumes/MyexternalDrive.noindex`

Alternatively, add the drive or folder to the `Search Privacy` list in [macOS Spotlight settings](https://support.apple.com/guide/mac-help/prevent-spotlight-searches-in-files-mchl1bb43b84/mac).
:::

1. The storage disk must be formatted as `APFS`.

---

---
url: /markdown-examples.md
---
# Markdown Extension Examples

This page demonstrates some of the built-in markdown extensions provided by VitePress.

## Syntax Highlighting

VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:

**Input**

````
```js{4}
export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}
```
````

**Output**

```js{4}
export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}
```

## Custom Containers

**Input**

```md
::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::
```

**Output**

::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::

## More

Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).

---

---
url: /detection/motion-detection.md
---
# Motion Detection

Motion Detection plugins analyze the camera stream for motion. This is useful if the camera does not have a motion sensor or the motion sensor is sub par.

## Accelerated Motion Detection

Available only to [Scrypted NVR](/scrypted-nvr/) users. Uses OpenCL or SIMD for hardware acceleration.

1. Enable the `Accelerated Motion Sensor` Extension on the camera.
2. Optional: Configure motion zones to filter out windy trees or busy roads.

## OpenCV

Accurate and customizeable motion detector.

1. Install the `OpenCV Plugin`.
2. Enable the `OpenCV Motion Sensor` Extension on the camera.
3. Optional: Configure motion zones to filter out windy trees or busy roads.

---

---
url: /scrypted-nvr/nearby-devices.md
---
# Nearby Devices

Scrypted NVR can link cameras to smart home devices to add sensor events to the NVR timeline or control them from the camera view.

## Linked Sensors

Sensors and locks linked to a camera in will create timeline events and notifications.

Linking a sensor or lock is done in the `Scrypted Management Console`, under the `Recording` settings for the camera.

## Control Devices

Scrypted NVR can integrate with nearby smart home devices to allow controlling them while viewing a camera.

::: tip
Currently lights, locks, and sirens are supported.
:::

Linking a device is done in the `Scrypted Management Console`, within the per user `NVR Preferences`. Each user may customize which devices are available in their NVR app.

---

---
url: /detection/object-detection.md
---
# Object Detection

Object Detection plugins analyze the camera stream for recognizable objects (people, cars, animals, packages). These plugins are only used by [Scrypted NVR](/scrypted-nvr/) for smart detections.

There are several Object Detection Plugins available. Choose the best one for your [Scrypted NVR Server](/server-hardware).

## CoreML

Uses the [Neural Engine](https://www.makeuseof.com/what-is-a-neural-engine-how-does-it-work/) only available on Apple Silicon.

## OpenVINO

Can use Intel CPU, GPU, and NPU for hardware acceleration. The `Console` will show the available hardware. Recommended for AMD and Intel systems.

## ONNX

Available for Proxmox/Docker (using the `nvidia` image tag) or Windows. Can use NVIDIA GPU for hardware acceleration. ONNX requires CUDA drivers to be installed on the host. Windows users must also install cuDNN. The `Console` will show the available hardware. Recommended for use on NVIDIA GPUs.

## Tensorflow Lite

Available on all platforms. Can use [Coral.ai](https://coral.ai) TPU for hardware acceleration.

To use a Coral EdgeTPU within docker:

1. The docker host must install the appropriate EdgeTPU drivers:

* EdgeTPU USB Drivers: https://coral.ai/docs/accelerator/get-started/
* EdgeTPU M.2 or PCIe Drivers: https://coral.ai/docs/m2/get-started/

2. Modify `~/.scrypted/docker-compose.yml` on the host to pass throug the appropriate USB or PCI devices.
3. Then recreate the docker container:

```sh
cd ~/.scrypted
docker compose down
docker compose up -d
```

4. Upon successful installation, the `Tensorflow Lite` Plugin will report the device in Settings and the `Console` log.

```
edge tpus [{'type': 'pci', 'path': '/dev/apex_0'}]
model: yolov8n_full_integer_quant_320
added tpu {'type': 'pci', 'path': '/dev/apex_0'}
```

---

---
url: /scrypted-nvr/camera-ai.md
---
# Onboard Camera AI

Some camera hardware provides onboard AI that detects people, animals, and vehicles. Those detections can be used by Scrypted NVR to reduce server load. There are a few caveats:

* The camera provided detections do not provide bounding boxes around the object. As a result, notifications and thumbnails will be full frame images, unlike the rich notifications provided by `Scrypted NVR Object Detection`.
* Enabling the camera's AI features [may disable some substreams](/camera-preparation.md#stream-setup). This would reduce the available streams from 3 to 2, resulting in degraded timelapse and streaming performance.
* Detections are not searchable in the Scrypted NVR app.
* AI and Zone filtering can not be used.

With those limitations in mind, the Onboard Camera AI can be utilized by disabling the `Scrypted NVR Object Detection` extension on the camera.

---

---
url: /parts/cluster-setup-env.md
---
Create and edit Scrypted `.env` configuration file:

::: code-group

```sh[Docker Compose]
# open this file in the Docker host shell
nano ~/.scrypted/volume/.env
```

```sh[Proxmox]
# open this file in the LXC Console
nano ~/.scrypted/volume/.env
```

```sh[Linux]
nano ~/.scrypted/volume/.env
```

```sh[Mac]
touch ~/.scrypted/volume/.env
open -a TextEdit ~/.scrypted/volume/.env
```

```[Windows Command Prompt]
notepad %USERPROFILE%\.scrypted\volume\.env
```

:::

Paste the following into the editor, and make the necessary changes.

---

---
url: /scrypted-nvr/policies/privacy.md
---
# Privacy Policy

Last updated: February 22, 2024

This Privacy Policy describes Our policies and procedures on the collection, use and disclosure of Your information when You use the Service and tells You about Your privacy rights and how the law protects You.

We use Your Personal data to provide and improve the Service. By using the Service, You agree to the collection and use of information in accordance with this Privacy Policy.

## Interpretation and Definitions

### Interpretation

The words of which the initial letter is capitalized have meanings defined under the following conditions. The following definitions shall have the same meaning regardless of whether they appear in singular or in plural.

### Definitions

For the purposes of this Privacy Policy:

* **Account** means a unique account created for You to access our Service or parts of our Service.

* **Affiliate** means an entity that controls, is controlled by or is under common control with a party, where "control" means ownership of 50% or more of the shares, equity interest or other securities entitled to vote for election of directors or other managing authority.

* **Application** refers to Scrypted, the software program provided by the Company.

* **Company** (referred to as either "the Company", "We", "Us" or "Our" in this Agreement) refers to Vysor, Inc.

* **Cookies** are small files that are placed on Your computer, mobile device or any other device by a website, containing the details of Your browsing history on that website among its many uses.

* **Country** refers to: Washington, United States

* **Device** means any device that can access the Service such as a computer, a cellphone or a digital tablet.

* **Personal Data** is any information that relates to an identified or identifiable individual.

* **Service** refers to the Application or the Website or both.

* **Service Provider** means any natural or legal person who processes the data on behalf of the Company. It refers to third-party companies or individuals employed by the Company to facilitate the Service, to provide the Service on behalf of the Company, to perform services related to the Service or to assist the Company in analyzing how the Service is used.

* **Usage Data** refers to data collected automatically, either generated by the use of the Service or from the Service infrastructure itself (for example, the duration of a page visit).

* **Website** refers to Scrypted, accessible from <https://scrypted.app>

* **You** means the individual accessing or using the Service, or the company, or other legal entity on behalf of which such individual is accessing or using the Service, as applicable.

## Collecting and Using Your Personal Data

### Types of Data Collected

#### Personal Data

While using Our Service, We may ask You to provide Us with certain personally identifiable information that can be used to contact or identify You. Personally identifiable information may include, but is not limited to:

* Email address

* Usage Data

#### Usage Data

Usage Data is collected automatically when using the Service.

Usage Data may include information such as Your Device's Internet Protocol address (e.g. IP address), browser type, browser version, the pages of our Service that You visit, the time and date of Your visit, the time spent on those pages, unique device identifiers and other diagnostic data.

When You access the Service by or through a mobile device, We may collect certain information automatically, including, but not limited to, the type of mobile device You use, Your mobile device unique ID, the IP address of Your mobile device, Your mobile operating system, the type of mobile Internet browser You use, unique device identifiers and other diagnostic data.

We may also collect information that Your browser sends whenever You visit our Service or when You access the Service by or through a mobile device.

#### Tracking Technologies and Cookies

We use Cookies and similar tracking technologies to track the activity on Our Service and store certain information. Tracking technologies used are beacons, tags, and scripts to collect and track information and to improve and analyze Our Service. The technologies We use may include:

* **Cookies or Browser Cookies.** A cookie is a small file placed on Your Device. You can instruct Your browser to refuse all Cookies or to indicate when a Cookie is being sent. However, if You do not accept Cookies, You may not be able to use some parts of our Service. Unless you have adjusted Your browser setting so that it will refuse Cookies, our Service may use Cookies.
* **Web Beacons.** Certain sections of our Service and our emails may contain small electronic files known as web beacons (also referred to as clear gifs, pixel tags, and single-pixel gifs) that permit the Company, for example, to count users who have visited those pages or opened an email and for other related website statistics (for example, recording the popularity of a certain section and verifying system and server integrity).

Cookies can be "Persistent" or "Session" Cookies. Persistent Cookies remain on Your personal computer or mobile device when You go offline, while Session Cookies are deleted as soon as You close Your web browser. You can learn more about cookies on [TermsFeed website](https://www.termsfeed.com/blog/cookies/#What_Are_Cookies) article.

We use both Session and Persistent Cookies for the purposes set out below:

* **Necessary / Essential Cookies**

  Type: Session Cookies

  Administered by: Us

  Purpose: These Cookies are essential to provide You with services available through the Website and to enable You to use some of its features. They help to authenticate users and prevent fraudulent use of user accounts. Without these Cookies, the services that You have asked for cannot be provided, and We only use these Cookies to provide You with those services.

* **Cookies Policy / Notice Acceptance Cookies**

  Type: Persistent Cookies

  Administered by: Us

  Purpose: These Cookies identify if users have accepted the use of cookies on the Website.

* **Functionality Cookies**

  Type: Persistent Cookies

  Administered by: Us

  Purpose: These Cookies allow us to remember choices You make when You use the Website, such as remembering your login details or language preference. The purpose of these Cookies is to provide You with a more personal experience and to avoid You having to re-enter your preferences every time You use the Website.

For more information about the cookies we use and your choices regarding cookies, please visit our Cookies Policy or the Cookies section of our Privacy Policy.

### Use of Your Personal Data

The Company may use Personal Data for the following purposes:

* **To provide and maintain our Service**, including to monitor the usage of our Service.

* **To manage Your Account:** to manage Your registration as a user of the Service. The Personal Data You provide can give You access to different functionalities of the Service that are available to You as a registered user.

* **For the performance of a contract:** the development, compliance and undertaking of the purchase contract for the products, items or services You have purchased or of any other contract with Us through the Service.

* **To contact You:** To contact You by email, telephone calls, SMS, or other equivalent forms of electronic communication, such as a mobile application's push notifications regarding updates or informative communications related to the functionalities, products or contracted services, including the security updates, when necessary or reasonable for their implementation.

* **To manage Your requests:** To attend and manage Your requests to Us.

* **For business transfers:** We may use Your information to evaluate or conduct a merger, divestiture, restructuring, reorganization, dissolution, or other sale or transfer of some or all of Our assets, whether as a going concern or as part of bankruptcy, liquidation, or similar proceeding, in which Personal Data held by Us about our Service users is among the assets transferred.

* **For other purposes**: We may use Your information for other purposes, such as data analysis, identifying usage trends, determining the effectiveness of our promotional campaigns and to evaluate and improve our Service, products, services, marketing and your experience.

We may share Your personal information in the following situations:

* **For business transfers:** We may share or transfer Your personal information in connection with, or during negotiations of, any merger, sale of Company assets, financing, or acquisition of all or a portion of Our business to another company.
* **With Your consent**: We may disclose Your personal information for any other purpose with Your consent.

### Retention of Your Personal Data

The Company will retain Your Personal Data only for as long as is necessary for the purposes set out in this Privacy Policy. We will retain and use Your Personal Data to the extent necessary to comply with our legal obligations (for example, if we are required to retain your data to comply with applicable laws), resolve disputes, and enforce our legal agreements and policies.

The Company will also retain Usage Data for internal analysis purposes. Usage Data is generally retained for a shorter period of time, except when this data is used to strengthen the security or to improve the functionality of Our Service, or We are legally obligated to retain this data for longer time periods.

### Transfer of Your Personal Data

Your information, including Personal Data, is processed at the Company's operating offices and in any other places where the parties involved in the processing are located. It means that this information may be transferred to — and maintained on — computers located outside of Your state, province, country or other governmental jurisdiction where the data protection laws may differ than those from Your jurisdiction.

Your consent to this Privacy Policy followed by Your submission of such information represents Your agreement to that transfer.

The Company will take all steps reasonably necessary to ensure that Your data is treated securely and in accordance with this Privacy Policy and no transfer of Your Personal Data will take place to an organization or a country unless there are adequate controls in place including the security of Your data and other personal information.

### Delete Your Personal Data

You have the right to delete or request that We assist in deleting the Personal Data that We have collected about You.

Our Service may give You the ability to delete certain information about You from within the Service.

You may update, amend, or delete Your information at any time by signing in to Your Account, if you have one, and visiting the account settings section that allows you to manage Your personal information. You may also contact Us to request access to, correct, or delete any personal information that You have provided to Us.

Please note, however, that We may need to retain certain information when we have a legal obligation or lawful basis to do so.

### Disclosure of Your Personal Data

#### Business Transactions

If the Company is involved in a merger, acquisition or asset sale, Your Personal Data may be transferred. We will provide notice before Your Personal Data is transferred and becomes subject to a different Privacy Policy.

#### Law enforcement

Under certain circumstances, the Company may be required to disclose Your Personal Data if required to do so by law or in response to valid requests by public authorities (e.g. a court or a government agency).

#### Other legal requirements

The Company may disclose Your Personal Data in the good faith belief that such action is necessary to:

* Comply with a legal obligation
* Protect and defend the rights or property of the Company
* Prevent or investigate possible wrongdoing in connection with the Service
* Protect the personal safety of Users of the Service or the public
* Protect against legal liability

### Security of Your Personal Data

The security of Your Personal Data is important to Us, but remember that no method of transmission over the Internet, or method of electronic storage is 100% secure. While We strive to use commercially acceptable means to protect Your Personal Data, We cannot guarantee its absolute security.

## Children's Privacy

Our Service does not address anyone under the age of 13. We do not knowingly collect personally identifiable information from anyone under the age of 13. If You are a parent or guardian and You are aware that Your child has provided Us with Personal Data, please contact Us. If We become aware that We have collected Personal Data from anyone under the age of 13 without verification of parental consent, We take steps to remove that information from Our servers.

If We need to rely on consent as a legal basis for processing Your information and Your country requires consent from a parent, We may require Your parent's consent before We collect and use that information.

## Links to Other Websites

Our Service may contain links to other websites that are not operated by Us. If You click on a third party link, You will be directed to that third party's site. We strongly advise You to review the Privacy Policy of every site You visit.

We have no control over and assume no responsibility for the content, privacy policies or practices of any third party sites or services.

## Changes to this Privacy Policy

We may update Our Privacy Policy from time to time. We will notify You of any changes by posting the new Privacy Policy on this page.

We will let You know via email and/or a prominent notice on Our Service, prior to the change becoming effective and update the "Last updated" date at the top of this Privacy Policy.

You are advised to review this Privacy Policy periodically for any changes. Changes to this Privacy Policy are effective when they are posted on this page.

---

---
url: /install/proxmox-ve.md
---
# Proxmox VE

::: warning
Scrypted NVR servers with NVIDIA GPUs must create an Ubuntu 24.04 VM inside Proxmox VE and pass through the GPU. Then continue with the [Linux - Docker](linux-docker) installation. NVIDIA hardware is not supported inside the Scrypted Proxmox VE LXC.
:::

Scrypted can be installed on a Proxmox VE by pasting the following script on the Proxmox VE **host**. This script will download and restore a Scrypted container backup. The script prompts to pass through GPUs and Coral Edge TPUs. Hosts with Coral Edge TPUs must also install the driver using the steps below.

```sh
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/proxmox/install-scrypted-proxmox.sh > install-scrypted-proxmox.sh
bash install-scrypted-proxmox.sh
```

The Scrypted container uses 16GB memory and all CPU cores by default. Configure the `Resources` tab to suit the server specs and workload. `Scrypted NVR` servers should assign at least 4 cores and 16GB of memory (the more the better). After configuration has been completed, start the container.

Scrypted is now running at: `https://scrypted:10443/`

Note that it is `https` and that you'll be asked to approve/ignore the website certificate.

::: tip
The default `root` password on the LXC is `scrypted` and there will be a prompt to change it on first login.
:::

## Coral Drivers

The Coral Edge TPU driver build step is optional and intended for servers running Scrypted NVR.

### Coral M.2/PCI Drivers

The Proxmox VE host requires building the [gasket-dkms](https://github.com/google/gasket-driver.git) driver from source. First ensure that the `pve-no-subscription`/`No Subscription` Proxmox apt repository has been added to your host. Then run the following on the Proxmox VE host to build and install the `gasket-dmks` M.2/PCI driver:

```sh
apt remove -y gasket-dkms
apt install -y git devscripts dh-dkms dkms pve-headers-$(uname -r)
cd /tmp
rm -rf gasket-driver
git clone https://github.com/google/gasket-driver.git
cd gasket-driver/
debuild -us -uc -tc -b
dpkg -i ../gasket-dkms_1.0-18_all.deb 
```

### Coral USB Drivers

The Proxmox VE host can use the USB driver provided by Google. Run the following on the Proxmox VE host to install the USB driver:

```sh
curl -fsSL https://packages.cloud.google.com/apt/doc/apt-key.gpg | gpg --dearmor -o /usr/share/keyrings/coral-edgetpu-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/coral-edgetpu-archive-keyring.gpg] https://packages.cloud.google.com/apt coral-edgetpu-stable main" | tee /etc/apt/sources.list.d/coral-edgetpu.list
apt-get -y update
apt-get -y install libedgetpu1-max
```

## Intel NPU Drivers

The Proxmox VE host can use the NPU (Neural Processing Unit) driver for Core Ultra processors provided by Intel. Run the following on the Proxmox VE host to install the NPU driver:

```sh
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/docker/install-intel-npu.sh > install-intel-npu.sh
INTEL_FW_NPU=true bash install-intel-npu.sh
```

## Proxmox VE Container Reset

::: tip
Older Proxmox VE Scrypted installations ran as a systemd service in the container. The new installation process moves the service into a docker container inside the LXC. Legacy installations must update the LXC by using the [Host Reset](#host-reset) script.
:::

Modifying the Proxmox VE Container can lead to unexpected behavior. The container can be reset using either the [LXC reset](#lxc-reset) (in container reinstall) or the [Host Reset](#host-reset) (total reinstall).

All data (and NVR recordings if applicable) will be preserved, but creating a backup from within Scrypted is highly recommended.

### LXC Reset

The Scrypted service within the container can be reset by running the docker installation script with `SCRYPTED_LXC=true` environment variable.

::: warning
This script must be run in the Scrypted LXC (usually container id 10443) `Console`, not the Proxmox Host Shell/Terminal.
:::

```sh
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/docker/install-scrypted-docker-compose.sh > ~/install-scrypted-docker-compose.sh 
SCRYPTED_LXC=true bash ~/install-scrypted-docker-compose.sh
```

### Host Reset

The container can be reset on the host by running the installation script with the `SCRYPTED_RESTORE=true` environment variable.

::: warning
This script must be run in the Proxmox VE Host `Shell`, not the Scrypted LXC Console/Terminal.
:::

```sh
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/proxmox/install-scrypted-proxmox.sh > install-scrypted-proxmox.sh
SCRYPTED_RESTORE=true bash install-scrypted-proxmox.sh
```

---

---
url: /scrypted-nvr/storage/proxmox.md
---
# Proxmox VE Volume

Proxmox VE can add a storage device to Scrypted through the Proxmox VE web interface. There are a few steps: adding the storage to Proxmox VE and passing the storage through to Scrypted.

::: tip
The Recordings Directory should **not** be manually configured in the NVR plugin when using the process described below. Clear any manual Recordings Directory configuration inside the NVR plugin prior to usage of this script.
:::

::: warning
If adding multiple storage devices beyond the first, see the [Proxmox VE Disk Setup Notes](#disk-setup-notes) for additional notes on the script.
:::

## Prepare Storage

1. Open the Proxmox VE web interface.
2. Select the server (aka `node`) from the `Datacenter` drawer on the left.
3. Select the `Disks` section in the secondary drawer.
4. Find the Device in the list. The disk's Device will typically be something like `/dev/sda` or `/dev/sdb`.
5. Click `Wipe Disk`.
6. Select the `Directory` section in the secondary drawer.
7. Click `Create: Directory`.

* For `Filesystem` select `ext4`.
* Name the new storage something recognizable like `nvr-storage` (remember this for later).

## Add Storage

1. Select the server (aka `node`) from the `Datacenter` drawer on the left.
2. Select the `Shell` section in the secondary drawer.
3. Enter the following to download the storage setup script:

```sh
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/proxmox/setup-scrypted-nvr-volume.sh > setup-scrypted-nvr-volume.sh
```

Adjust the the previously named `nvr-storage` if necessary, and run the script:

```sh
bash setup-scrypted-nvr-volume.sh nvr-storage
```

This command will stop Scrypted, add the storage, and start the Scrypted.

Continue on to [Enable Camera Recording](/scrypted-nvr/camera-recording).

::: info
Reference: [Proxmox VE Disk Setup Notes](#disk-setup-notes) has information about the script, including using multiple disks or arbitrary host paths.

Reference: [Proxmove VE Mount Point](#mount-point) has information about using standard Proxmox Mount points, which are not recommended due to issues with backup and snapshots.
:::

***

## Mount Point

For example, as seen in the screenshot below, inside the container `Resources`:

1. Click `Add` and select `Mount Point`.
2. Set the size to 1000GB (adjust accordingly).
3. Set the mount to `/mnt/crucial` (the name can be any preference in place of "crucial").
4. The `/mnt/crucial` path can then be provided to the NVR Plugin after restarting the container.

::: warning
The Proxmox VE Mount Points **MUST** set the path to be inside `/mnt` in the container.
:::

![](/img/scrypted-nvr/proxmox-mount-point.png)

## Disk Setup Notes

The disk setup adds the disk as a directory on the host system. The setup script modifies the lxc conf file (`/etc/pve/lxc/10443.conf`) to mount the directory into the container. It also creates a hidden `.nvr` file to the storage folder to earmark it for NVR usage. This method allows for fast snapshots, replications, and backups.

Environment variables can be set to change the setup script behavior:

::: warning
Read more about [Multiple Storage Devices](/scrypted-nvr/recording-storage.md#multiple-storage-devices) before running these advanced commands.
:::

Additional disks can be added by setting the `ADD_DISK=true` environment variable:

```sh
ADD_DISK=true bash setup-scrypted-nvr-volume.sh another-nvr-storage
```

A `Fast Disk` can be added by setting the `FAST_DISK=true` environment variable:

```sh
FAST_DISK=true bash setup-scrypted-nvr-volume.sh fast-nvr-storage
```

The script also supports mounting a host path as a volume within the Scrypted LXC. For example, if you have an existing zfs array at `/my-raid-device`, you can create a directory for NVR recordings at `/my-raid-device/scrypted-nvr/` and then use the script as follows:

```sh
bash setup-scrypted-nvr-volume.sh nvr-storage /my-raid-device/scrypted-nvr/
```

---

---
url: /scrypted-nvr/policies/fulfillment.md
---
# Purchase Policy

## Manage or Cancel Subscriptions

The Scrypted NVR subscription can be managed at the [billing portal](https://billing.scrypted.app). This includes adding or removing licenses from an account, or cancelling the subscription.

## Free Trial

Scrypted NVR's has a free trial that can be used to test drive the product. Set the subscription to cancel to avoid being billed when the trial ends. It is highly recommended to set up and verify the cameras in the free version of Scrypted prior to starting the Scrypted NVR trial.

## Supported Server Configurations

## Supported Cameras

**Subscriptions intended for unsupported hardware are not eligible for technical assistance or refunds.**

See the [Buyer's Guide](/buyers-guide/cameras) for recommended camera hardware.

## Cancellation Policy

All sales are final and non-refundable. The free version and free trial are available to thoroughly test the product.

Scrypted NVR subscribers will be sent a payment reminder email one week prior to being billed to provide a lead time for cancellations. Cancelled subscriptions will end on the next renewal date; they will not be prorated. The subscription benefits will be available until the renewal date. The subscription will not be billed further.

Additional billing questions (such as lost email access) can be directed to <billing@scrypted.app> or raised in the [Scrypted Discord](https://discord.gg/DcFzmBHYGq) to the server administrator.

## Support

Support issues related to the Scrypted NVR product can be raised in the Discord, Reddit, or Github communities linked above.

Support issues unrelated to the Scrypted NVR product (HomeKit, Google Home, etc) are only eligible for community support. Support for subscribers is only for the Scrypted NVR product.

---

---
url: /scrypted-nvr/camera-recording.md
---
# Record Cameras

## Camera Setup

1. [Configure the Camera](/camera-preparation).
2. [Add the Camera to Scrypted](/add-camera.md).
3. [Verify the Motion Sensor](/camera-validation) is working. Scrypted waits for the camera to report motion to trigger video analysis.
   :::warning
   If the Camera's Motion Sensor is disabled, detections will be unavailable on the NVR timeline.
   :::
4. Enable Recording in the Camera Settings by selecting `Scrypted NVR` in the `Integrations and Extensions` list.

## Cameras and Recordings

After the Scrypted NVR Plugin has been installed, `Cameras and Recordings` can be viewed on your local network by visiting the address of this Scrypted server.

Cloud access must be enabled for remote access via [browser, iOS, Android, and Desktop Apps](apps).

![](/img/scrypted-nvr/cameras-and-recordings.png)

---

---
url: /api-examples.md
---

# Runtime API Examples

This page demonstrates usage of some of the runtime APIs provided by VitePress.

The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:

```md
<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>
```

## Results

### Theme Data

### Page Data

### Page Frontmatter

## More

Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

---

---
url: /scrypted-nvr.md
---
# Scrypted NVR

## What is Scrypted NVR?

[Scrypted NVR](https://demo.scrypted.app/#/demo) is a `Scrypted Plugin` that provides 24/7 recording and smart detections, with accompanying mobile and desktop applications.

## 24/7 Recording

Scrypted NVR records your camera 24 hours a day, 7 days a week. The fluid user interface provides quick and easy access to all your recordings.

## Scrypted NVR Demo

---

---
url: /scrypted-nvr/installation.md
---
# Scrypted NVR Setup

Install Scrypted using the one of the [installation options](/installation).

After installation, the Scrypted NVR can be installed from the `Plugins` section of the `Scrypted Management Console`.

## Purchase and Manage Subscription

This Scrypted NVR Plugin is in a *paid* plugin. A [live demo server](https://demo.scrypted.app/#/demo) and free trial is available to test the product.

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

::: tip
Scrypted NVR on Mac and Windows must [Install](https://docs.scrypted.app/desktop-application.html) or [Migrate](https://docs.scrypted.app/maintenance/migration.html#migrating-to-the-desktop-application) to the Desktop Application.
:::

## Remove Defunct Plugins

Scrypted NVR contains improved motion sensor and video decoder components. The following plugins can be removed, if they are installed:

* Python Codecs
* OpenCV
* PAM-Diff

## Configure Object Detection

::: warning
Most systems require no further configuration. Changing defaults is not recommended.
:::

For common hardware setups found in the buyer's guide, like Intel iGPU or Apple Silicon, no further configuration is necessary. However, uncommon hardware configurations will need additional setup:

* Windows + NVIDIA
  * [ONNX dependencies](/detection/object-detection.md#onnx) must be installed.
  * Set the Scrypted NVR Default Object Detector to ONNX.
* Proxmox/Docker + NVIDIA
  * Installation must use the `nvidia` docker [tag](/detection/object-detection.md#onnx).
* Coral EdgeTPU
  * EdgeTPU drivers [must be installed](/detection/object-detection.md#tensorflow-lite).
  * Set the Scrypted NVR Default Object Detector to Tensorflow Lite.

---

---
url: /buyers-guide/servers.md
---
# Server Hardware

## Base Recommendations

Cameras that have good motion sensors, plugin support, and the necessary codecs dramatically reduce the server requirements: Scrypted will have no problem streaming to the various supported [Platforms](/platforms) on low power hardware like a Raspberry Pi 4 or Synology NAS.

**The latest server hardware is NOT always the best.** Newer hardware may not have full/stable hardware acceleration support in kernel/drivers/software. Being 2 generations behind the latest release is generally recommended for hassle free setup and compatibility.

::: warning Raspberry Pi 4
From a current price to performance standpoint, the Raspberry Pi 4b is a poor choice compared to similarly priced Intel thin clients and NUCs. A used Dell Wyse 5070 can be found on eBay for half the price of a Raspberry Pi 4b.
:::

## NVR Recommendations

However, if motion detection is necessary, or the server will be running Scrypted NVR for 24/7 recording and [Smart Detections](/scrypted-nvr/features#smart-detections), running it on a more capable system than a Raspberry Pi 4 is recommended. A good CPU, GPU, and TPU/NPU (Tensor/Neural Processing Unit, aka AI chip) all contribute towards video stream detection performance.

While a TPU/NPU can improve performance, a capable GPU can also fill the gap.

|Processor|Video Decode|Motion Detection|Object Detection|
|-|-|-|-|
|CPU|🥈|🥈|🥉|
|GPU|🥇|🥇|🥈|
|TPU/NPU|❌|❌|🥇|

❌ Not applicable.

## System Comparison

|Name|General Compute|Video Decode|Object Detection|Cameras|
|-|-|-|-|-|
|Apple Mac Mini|🥇|🥇|🥇|30+|
|Intel Core Ultra 125H|🥇|🥇|🥇|30+|
|NVIDIA 4XXX|❌|🥇|🥇|30+|
|Intel 12600H|🥈|🥈|🥈|20+|
|Intel N100|🥉|🥉|🥉|12|

❌ Not applicable.

## Object Detection Comparison

::: danger
Coral EdgeTPU devices are not recommended. While these TPUs were fast on initial release in 2020, they are now outclassed by both modern Intel and Apple Silicon chips. Furthermore, the aging chips have not seen a single hardware or software refresh. The software (Tensorflow) is no longer in use at Google. For all intents and purposes, the Coral EdgeTPU is now Google abandonware.

Coral EdgeTPU only supports basic object detection with Scrypted NVR. It does not support face recognition, license plate recognition, or enhanced search.
:::

::: tip
The [Object Detection Benchmark](https://scripts.scrypted.app/object-detection-benchmark.html#reference-times) script has collected results from many common systems.
:::

|Type|Name|Rating|Notes|
|-|-|-|-|
|NPU|Apple Mac Mini|🥇|Low power consumption, fast, and expensive. Can easily handle a large number of cameras.|
|NPU|Intel Core Ultra 125H|🥇|The GPU on the H series Intel chips have 2-3x the typical number of cores. The Core Ultra series includes Intel's new NPU. Low power consumption, fast, and moderately priced. Can easily handle a large number of cameras.|
|GPU|Intel 12600H|🥈|The GPU on the H series Intel chips have 2-3x the typical number of cores. They are blazing fast at low power. Highly recommended.|
|GPU|Intel N100|🥉|Fantastic Object Detection Performance in a tiny package. Highly recommended.|
|GPU|NVIDIA|🥇|The NVIDIA 3000 and 4000 series has incredible decode and detect performance but at a high price and power consumption. Generally not recommended for purchase, great if on hand.|
|TPU|M.2/PCI Coral|🥉|The M.2 dual TPU model is is not supported by many systems. **Google Abandonware. Do not buy if purchasing new hardware**.|
|TPU|USB Coral|🥉|High latency and crash prone. Google Abandonware. **Google Abandonware. Do not buy if purchasing new hardware**.|

# Server Recommendations

All servers are recommended to have at least 8GB of RAM, 16GB preferred.

## Apple Mac Mini

This system contains a CPU, GPU, and a TPU (neural cores).

## Intel Core Ultra 125H

This Intel 12th generation NUC contains a CPU and laptop class GPU and  NPU in a tiny package. The H series chip has 80 GPU cores compared to the 24 on the Intel N100. The Intel Core Ultra 125H is the top recommendation for large scale deployments.

## Intel 12600H

This Intel 12th generation NUC contains a CPU and laptop class GPU in a tiny package. The H series chip has 80 GPU cores compared to the 24 on the Intel N100.

## Intel N100

This Intel 12th generation NUC contains a CPU and capable GPU in a tiny package.

***

# Storage

## Disk Drive

Scrypted NVR recommends using a direct attached storage drive (internal or USB). A surveillance rated drive is preferred, but not strictly necessary. SSD storage will only marginally improve performance. Flash Storage (USB Stick) and SD Cards are not recommended, as they are prone to data corruption and failure.

|Recommended Drives|
|-|
|Western Digital WD Purple|
|Seagate Skyhawk|

::: warning
There are many [fake drives](https://www.youtube.com/watch?v=QOhLlvNlI20) for sale that misreport their actual storage capacity. Buy from a reputable retailer and manufacturer. If a deal seems too good to be true, it probably is.
:::

## External Enclosure

When using an external enclosure, it is recommended to connect a dedicated enclosure directly to the server. Multifunction enclosures (which have additional USB ports, network ports, or card readers) have been known to cause issues. Daisy chaining the USB connection through a secondary USB hub can cause connectivity issues as well.

::: tip
Macs can be quite picky about USB drive bays and may disconnect them randomly. Using a brand that advertises itself as Mac compatible, such as OWC, is advised. Read the Amazon reviews from Mac users. All drive bays tend to be trouble free on Linux and Windows.
:::

|Mac Drive Bays|
|-|
|OWC miniStack|
|OWC Drive Dock USB-C Dual Drive Bay Solution|

## Network Attached Storage

::: tip
Using [Cluster Mode](/maintenance/cluster.md) is recommended when storing Recordings on a NAS.
:::

Storing video on a NAS is a reasonable option if one is available, however timelapse scrubbing may suffer from poor performance over the network.

---

---
url: /detection/smart-motion-sensor.md
---
# Smart Motion Sensor

## Setup

Scrypted can create a `Smart Motion Sensor` to report when a object is detected on a camera. This feature can be used with supported cameras that report smart detection events or [Scrypted NVR Object Detection](/scrypted-nvr/).

1. Install the `Video Analysis Plugin`.
2. Click `Add New`.
3. Select a camera to create a sensor.
4. Select the desired detections to report.
5. This sensor can be synced to other platforms to be used within automations.

::: tip
When using Smart Motion Sensor with detections from Scrypted NVR (and supported camera plugins like Unifi), the sensor can also provide a snapshot of the most recent event.
:::

## License Plate Recognition

Scrypted can create a `Smart Motion Sensor` that triggers on specific license plates. This feature requires camera hardware with native LPR support (Unifi AI Cameras) or via software with Scrypted NVR Object Detection. License Plate Recognition is *highly* dependent on lighting conditions, vehicle speed, camera angle, and video quality. Refer to the manufacturers documentation for optimal setup.

## Face Recognition

Scrypted can create a `Smart Motion Sensor` that triggers on specific people. This feature requires requires Scrypted NVR Object Detection (currently no camera/plugin supports this on hardware). Face Recognition is *highly* dependent on lighting conditions and face capture angle.

---

---
url: /detection/smart-occupancy-sensor.md
---
# Smart Occupancy Sensor

## Setup

Scrypted can create a `Smart Occupancy Sensor` that remains active while a specific object is detected on a camera. For example, the sensor can determine if a parking spot is utilized or a baby's crib is empty, and trigger automations.

Smart Occupancy Sensor requires [Scrypted NVR Object Detection](/scrypted-nvr/) or any of the other object detection plugins like CoreML, OpenVINO, ONNX, or TensorFlow-lite.

1. Install the `Video Analysis Plugin`.
2. Click `Add New`.
3. Select a camera to create a sensor.
4. Select the desired detections to report.
5. This sensor can be synced to other platforms to be used within automations.

## License Plate Recognition

Scrypted can create a `Smart Occupancy Sensor` that triggers on specific license plates. This feature requires Scrypted NVR Object Detection. License Plate Recognition is *highly* dependent on lighting conditions, vehicle speed, camera angle, and image quality.

## Face Recognition

Scrypted can create a `Smart Occupancy Sensor` that triggers on specific people. This feature requires requires Scrypted NVR Object Detection (currently no camera/plugin supports this on hardware). Face Recognition is *highly* dependent on lighting conditions and face capture angle.

---

---
url: /scrypted-nvr/recording-storage.md
---
# Storage Setup

Scrypted NVR requires a disk that can store at least 3 days of video for the cameras in the system. The storage requirement will vary based on the camera count and camera resolution. The following table provides a rough estimate for one week retention with a given number of cameras.

::: warning

* All storage disks must be 1TB minimum in size.
* External hard drives must use an enclosure that provides power. USB powered enclosures will result in data loss.
* Storage must be dedicated to Scrypted NVR. [Scrypted NVR will not record to a NAS or drive that is mostly full with data from other applications.](#storage-utilization).
* Scrypted NVR will not work with filesystem quota features. Use a separate filesystem partition to restrict how much space is available.
  :::

::: warning
NAS storage should also refer to the [NAS notes](#nas).
:::

| Resolution | 4 Cameras | 6 Cameras | 10 Cameras | 16 Cameras |
|------------|-----------|-----------|------------|------------|
| 1080P      | 1TB       | 1TB       | 1.5TB      | 2.4TB      |
| 2K         | 1.2TB     | 1.8TB     | 3TB        | 4.8TB      |
| 4K         | 2.4TB     | 3.6TB     | 6TB        | 9.6TB      |

## Host Setup

To configure storage, select the server installation platform below:

* [Proxmox VE](/scrypted-nvr/storage/proxmox.md)
* [Windows](/scrypted-nvr/storage/windows.md)
* [Mac](/scrypted-nvr/storage/mac.md)
* [Docker](/scrypted-nvr/storage/docker.md)
* [Unraid](/scrypted-nvr/storage/unraid.md)

After configuring storage, continue on to [Enable Camera Recording](/scrypted-nvr/camera-recording).

## Multiple Storage Devices

Multiple Recording Storage directories can be added to Scrypted NVR (`Large Disks`). This can be used to improve loading performance, particularly when recording a large number of cameras. Multiple Recording Storage directories is not the same as [RAID](https://en.wikipedia.org/wiki/RAID), but it is a form of redundancy: main and sub streams are distributed across all storage devices. If a Storage disk goes offline or fails, the specific camera stream stored on that disk will be unavailable. The other streams will be available on other Storage disk(s).

Scrypted NVR setups recording to Network Attached Storage (NAS) will result in reduced performance due to network latency as well as an increased surface area for recording failure. This configuration is not recommended. To mitigate the performance issues, Scrypted NVR can utilize a direct attach disk (as a `Fast` disk) in addition to the NAS disk. The NAS (`Large`) disk will store the main stream while `Fast` disk will store medium and low resolution (scrubbing, event lookup).

::: danger
Do not use `Fast` storage unless the Scrypted NVR server is primarily recording to a NAS (a separate storage server); it will not improve performance at all.

The `Fast` disk must be a direct attached disk (SATA or USB) and at least 1TB in size. The ideal ratio for `Fast` and `Large` disks is **1 to 6**.

E.g.: If the `Large` storage is located on a NAS with 18TB available, the `Fast` disk must be at least 3TB.
:::

The Default Recording Storage is designated as `Large`.

RAID disks can be assigned to Recording Storage as a storage directory for servers that need true redundancy.

## Storage Utilization

Scrypted NVR will begin deleting recordings when the disk reaches 15% free space and potentially stop recording if the disk reaches 10% free space or only has 10GB free space remaining. This is to ensure there is sufficient space available for OS updates and optimal filesystem performance (defragmentation/reallocation). Disk performance decreases as the utilization approaches 90%. The system may become unresponsive if disk is filled completely, potentially by other programs writing to the disk. Approaching these limits will show as alerts.

For best performance, provide an entire disk or partition to Scrypted NVR. Volumes that share disk space with others is not recommended as it may cause issues with recording retention periods. A constant work load consisting of writes requires a decent overhead on free space to ensure inode availability - regardless of volume size. Refer to this link for more information: [Why filling a volume is bad](https://chatgpt.com/share/6855f16d-068c-800c-b109-3f0e716e1b6a)

## NAS

::: warning

* When the storage device is a NAS Share, ensure that the NAS `Recycle Bin` feature is disabled, or the old recordings can not be properly deleted by Scrypted NVR and the disk will fill up.
* Storing video on a NAS is a reasonable option if one is available, however timelapse scrubbing may suffer from poor performance over the network.
* NAS must be dedicate a drive to Scrypted NVR. Using a NAS path that is mostly full with data from other applications will not work.
  :::

---

---
url: /scrypted-nvr/storage/synology.md
---
# Synology Storage

1. Configure a Recordings storage path in the Scrypted container inside Synology (`Volume Mapping`). The `Host Path` is the path to the storage on the Synology host. The provided `Container Path` (a chosen path in the container like `/nvr` or `/recordings`) will be used for the recordings storage directory.

---

---
url: /server-hardware.md
---
# System Requirements

## Host Operating System

Scrypted can run on Mac, Windows, Proxmox VE, and Linux (via Docker).

Linux + Docker installations should use `Ubuntu Server 64bit 24.04 LTS Noble` as the host, including Raspberry Pi.

## Base System Requirements

Scrypted can run on low power devices such as a Raspberry Pi 4 or more powerful devices like an Intel NUC or Mac Mini. Most users will be just fine with a low powered device. However, if running software [Motion Sensors](/detection/motion-detection) or [Scrypted NVR](/scrypted-nvr/), the performance requirements will increase per camera.

::: warning
The server must be connected to the network with a wired network connection. If the server has a wireless connection, disabling it altogether is recommended.
:::

::: tip
When choosing cameras or a server, consult the [Buyers's Guide](/buyers-guide/) for recommendations that will work together to perform best with Scrypted.
:::

## NVR System Requirements

### Server

The Raspberry Pi 4 and low performance NAS are not recommended for use with Scrypted NVR. Here are the baseline hardware recommendations:

|Operating System|CPU Generation|
|-|-|
|Windows|9th Generation (or equivalent for AMD)|
|Linux|6th Generation (or equivalent for AMD)|
|macOS|Apple Silicon|

The following chart is a rough idea of the capabilities of a few such systems.

|Hardware|Operating System|Number of Cameras|Notes|
|-|-|-|-|
|Dell Wyse 5070|Proxmox/Docker|5|Available cheap on eBay.|
|Intel N100|Proxmox/Docker|12|New Intel NUC that has a fantastic iGPU for accelerated transcode and detection.|
|Mac Mini 16GB|macOS|20+|Scrypted NVR can leverage Apple Silicon's [Neural Engine](https://www.makeuseof.com/what-is-a-neural-engine-how-does-it-work/).|
|Intel Core Ultra 125h|Proxmox/Docker|20+|Scrypted NVR can leverage Intel's [NPU](https://www.intel.com/content/www/us/en/products/details/embedded-processors/core-ultra.html).|

### Cameras

### Storage

::: warning
A drive of at least 1TB is required for NVR to function properly.
:::

Any hard drive will work, surveillance hard drives are recommended. Flash drives and SD cards should not be used, as they will corrupt quickly due to the high write volume.

---

---
url: /system-validation.md
---
# System Validation

After Scrypted has been installed, install the `Diagnostics` plugin and run `System Validation` to validate the environment. This tool can also be used to verify cameras after they have been added.

System validation will check network settings and server hardware properties:

```
============================================
System Validation
============================================
Scrypted Installation    Running
                         OK
IPv4 (jsonip.com)        Running
                         66.219.189.10
IPv6 (jsonip.com)        Running
                         2002:559:76c::3cf
IPv4 (wtfismyip.com)     Running
                         66.219.189.10
IPv6 (wtfismyip.com)     Running
                         2002:559:76c::3cf
Scrypted Server Address  Running
                         192.168.2.130, 2002:559:76c::3cf
                         OK
CPU Count                Running
                         12
Memory                   Running
                         31 GB
GPU Passthrough          Running
                         OK
Cloud Plugin             Running
                         OK
OpenVINO Plugin          Running
                         OK
GPU Decode               Running
                         OK
Deprecated Plugins       Running
                         OK
============================================
System Validation Complete
============================================
```

## Validation Resolutions

### IPv6

IPv6 on the network and Scrypted server is recommended for optimal performance when streaming from cellular networks.

### Scrypted Server Address

Specifying the `Scrypted Server Address` will affect how Scrypted advertises devices via the `HomeKit` plugin and how it communicates with other devices on the local network. Selecting a pair of wired ethernet addresses (one IPv4 and one IPv6) is recommended.

### GPU Passthrough and GPU Decode

If this fails, it is usually due to the system not properly passing through GPU due to installation via an unsupported method. Or the system may not have a GPU at all. Resolving this is recommended for `Scrypted NVR` systems.

---

---
url: /scrypted-nvr/troubleshooting.md
---
# Troubleshooting

Choose from the following troublehsooting guides. If your issue is not listed, please join [Discord](https://discord.gg/DcFzmBHYGq) and report the bug in the `#nvr` channel.

Troubleshoot:

* [Object Detection](#object-detection)
* [Recording](#recording)
* [Event Debug Tool](#event-debug-tool)
* [High CPU Usage](#high-cpu-usage)
* [Notification Delivery Failures](#notification-delivery-failures)

## Object Detection

### Detection Flow Chart

```mermaid
stateDiagram
    classDef cameraClass fill:blue
    classDef runningClass fill:green

    direction LR
    camera: Wait for Camera Motion
    camera2: Wait for Camera Motion
    motion: Camera Reports Motion
    running: Run Object Detection
    running2: Run Object Detection
    detected: Objects Detected
    decode: Wait For Video Frame
    analyze: Analyze Frame
    motionstopped: Camera Reports Motion Stopped
    detectionstopped: Stop Object Detection

    running2 --> decode
    camera --> motion
    motion --> running
    decode --> analyze
    analyze --> detected
    detected --> running2
    detected --> Notifications
    detected --> Timeline/Events
    running2 --> motionstopped
    motionstopped --> detectionstopped
    detectionstopped --> camera2

   class camera, camera2 cameraClass
   class running, running2 runningClass
```

Object Detection failure is typically due to the camera hardware not properly supplying motion events. The camera's hardware motion sensor will trigger the object detection process when motion is detected, allowing the system to remain idle.

View the camera in the NVR and verify there are motion events in the `Timeline`. Detected Motion will be denoted with a thin and solid blue line, as seen below.

If there is no motion visible on the timeline, the camera is misconfigured and not reporting motion properly. Enable the camera's hardware [Motion Sensor](/camera-preparation#motion-sensor-setup) via the manufacturer admin webpage or app. Ensure there are no zones filtering the motion.

In some cases, the camera motion sensor may be unreliable or non functional. Scrypted NVR provides software motion detection options to fill this gap. [Enable a Motion Detection Extension](/detection/motion-detection) on the camera.

If the motion sensor is functional, the Object Detection itself can be tested by dropping an image into it. Save the following image and dropping it into `Scrypted NVR Object Detection`:

## Recording

Recording issues typically stem from the storage directory or device not being properly configured.

1. In the `Scrypted NVR Plugin` Settings, verify the storage directory is configured and is reporting the correct disk size and free space. The drive should ideally be at least 1 terabyte.
2. Refer to the [Recording Storage](/scrypted-nvr/installation.html#recording-storage) docs to properly format the drive with the correct filesystem and, if applicable, mount it into Docker.

## Event Debug Tool

The event debug tool provides insight into what objects and motion was detected during an event. The tool is accessible via a **desktop browser only**. Click the camera label to go to the Event Debug Tool.

## Reducing False Positives

Object detection zones on the camera can be used to reduce false positives or remove uninteresting detections. Create a zone in the Object Detection Settings for the camera. The zone should accomodate the bounding box that may spill into the zone. E.g., the zone may need to be set back further than would seem intuitive since the bounding box for an object may be larger than may seem obvious:

Although the car is fully on the street, if a zone ends at the edge of the lawn, the car's bounding box would **intersect** the lawn.

An `intersect` zone will filter only detections that intersect (even a single pixel) the zone. A `contain` zone will filter detections that are completely encompassed by the zone.

The default zone type is `include`; a zone can be set to `exclude` to remove all detections of the matching type from being detected (such as problematic stationary cars).

## High CPU Usage

Scrypted NVR will use considerable CPU and GPU while performing object detection on [cameras that have reported motion](#object-detection). The following will help diagnose unusual system activity.

### Verify GPU

Improperly configured systems may not be able to access the GPU when performing object detection. The official install scripts will typically set up the system correctly.

* GPU usage for decoding can be verified by installing the `Diagnostics Plugin` and running `System Validation`.
* GPU usage for detection can be verified by checking the `OpenVINO` or `ONNX` plugins.

### Camera Activity

Cameras that are actively performing object detection can be viewed in the `Video Analysis Plugin`. There are two sections:

#### Active Motion Detection

There should generally not be any cameras that are using software motion detection. All cameras that are officially supported by Scrypted NVR have functional hardware motion sensors. If there are cameras listed in this section, please review the [motion sensor setup](/camera-preparation#motion-sensor-setup) to confirm that [enabling software motion detection](/detection/motion-detection) was necessary. The software motion sensor should be disabled.

#### Active Object Detection

There may be multiple cameras listed in this seciton if the high cpu usage is persistent. This may be due to cameras that are constantly reporting motion and never going idle. For example, trees blowing in the wind will trigger object detection. To resolve this issue, use [motion zones on the camera](/camera-preparation#motion-sensor-setup) to reduce unimportant motion that is reported to Scrypted. For example, zoning the camera to only perform motion detection on walkways and driveways, rather than on landscaping features.

## Notification Delivery Failures

When troubleshooting notification delivery failures, first ensure that object detection is working by navigating to the camera timeline in the NVR app and ensuring that people, vehicles, and animals are being detected and recorded. If there are no events there, the use the [Object Detection](#object-detection) troubleshooting.

### No Images in Notifications

If notifications are working, but there are no images in notifications, this is likely due to a `Scrypted Cloud` plugin misconfiguration. Perform the following steps:

1. Ensure the Scrypted Cloud plugin is installed.
2. Log into the Scrypted Cloud plugin again.

This should resolve most notification image failures.

If the server is using a Cloudflare domain, ensure hotlink protection protection is disabled in Cloudflare.

If the server is using self hosted SSL termination or port forwarding, the error may be due to to improper SSL termination or reverse proxy. To diagnose, delete and reinstall the Scrypted Cloud plugin to verify notification image delivery works on the Default settings.

## Notification Testing

1. In the Scrypted NVR app, go to Settings -> Notifications.
2. Click Send Test Notification. If no notification is received, continue on to [Complete Notification Failure](#complete-notification-failure).

When the detection is visible in the camera timeline and test notifications are being delivered to the the phone, the issue is most likely to be a notification filter in the app.

1. In the Scrypted NVR app, view the camera.
2. Click Settings -> AI, Zones, and Schedules
3. Delete all filters.

### Complete Notification Failure

If notifications are not being delivered at all, this is likely due to an issue with the device itself. Perform the following steps:

1. If the device is Android or iOS, **reboot the device**.
2. Search for the notification device in `Scrypted Management Console` and send it a test notification.
3. Observe any errors in the `Console`.

If no notification was received, and the `Console` indicates there were no errors, then the notification was delivered successfully to the Apple/Google backend notification service. If it was not delivered, the issue may be with their service's ability to deliver to your device. On iOS this can sometimes be resolved by **uninstalling and reinstalling the iOS app**.

## Recordings Lost After Restart

If restarting the Proxmox LXC or Docker container results in all recordings being lost, this is because the storage mount was not correctly passed into the container. The recordings are being written into the container rather than the drive, and the container is being reset (including the recordings) on restart. First remove any existing configuration for the recording storage. Then follow the [Storage Setup](/scrypted-nvr/recording-storage) guide to correctly configure the NVR Recordings Directory.

## Management Console Persistently Disconnecting

On November 12th, an update to docker caused Watchtower in Proxmox LXCs to fail. This failure causes Scrypted's Proxmox LXC to continually restart. The symptom is the management console disconnecting and reconnecting every few seconds. Use the [Proxmox LXC Reset](/install/proxmox-ve.md#lxc-reset) to resolve this issue.

---

---
url: /maintenance/uninstallation.md
---
# Uninstallation

Uninstallation instructions vary depending on how Scrypted was installed. Find the installation method for your server below.

After uninstallation is complete, and the Scrypted service has been stopped, [Delete the Scrypted Configuration](#delete-scrypted-configuration).

## Desktop App

* Quit the app from the task bar to ensure it is not running in the background.
* Delete the app by dragging it into the Trash (Mac/Linux) or running the Uninstallation from the Installed Applications list (Windows).

## Background Service

If Scrypted was not installed using the Desktop app, and the background service was installed using the Terminal, it must be uninstalled using the Terminal.

::: code-group

```sh [Docker Compose]
cd ~/.scrypted
docker compose down
```

```sh [Linux]
sudo systemctl stop scrypted.service
sudo rm /etc/systemd/system/scrypted.service
```

```sh [Mac]
launchctl unload ~/Library/LaunchAgents/app.scrypted.server.plist 
rm ~/Library/LaunchAgents/app.scrypted.server.plist
```

```powershell [Windows]
sc.exe stop scrypted.exe
sc.exe delete scrypted.exe
```

:::

## Delete Scrypted Configuration

After Scrypted is stopped, the local configuration files can be found and removed:

::: code-group

```sh [Docker Compose]
sudo rm -rf ~/.scrypted
```

```sh [Linux]
sudo rm -rf ~/.scrypted
```

```sh [Mac]
sudo rm -rf ~/.scrypted
```

```sh [Windows]
deltree %HOMEDRIVE%%HOMEPATH%\.scrypted
```

:::

---

---
url: /install/unraid-docker.md
---
# Unraid - Docker

1. Install `Scrypted` from `Unraid Apps`.
2. Configure `Appdata`. This path will contain the Scrypted database.

::: warning
Paths shown in screenshots are examples and should be configured specific to your system preferences and drive setup.
:::

---

---
url: /scrypted-nvr/storage/unraid.md
---
# Unraid Storage

::: warning Filesystem Requirement
Scrypted NVR requires storage on an `ext4` or `xfs` filesystem (see [Docker Volume](/scrypted-nvr/storage/docker.html#manual-docker-setup)). Unraid's default `/mnt/user/` share paths use `shfs`, a FUSE userspace filesystem that pools multiple disks. Although the underlying disks may be formatted as XFS, Scrypted sees the FUSE layer rather than the native filesystem. This can cause recording failures due to how FUSE handles file operations used by the NVR recording system. See [koush/scrypted#2015](https://github.com/koush/scrypted/issues/2015) for details.
:::

1. Configure a Recordings storage path within Unraid. The `Host Path` is the path to the storage on the Unraid host. The provided `Container Path` (a chosen path in the container like `/nvr` or `/recordings`) will be used for the recordings storage directory.

---

---
url: /README.md
---
Visit [docs.scrypted.app](https://docs.scrypted.app).

---

---
url: /desktop-application.md
---


---

---
url: /parts/camera-preparation.md
---
## Camera Configuration

Complete [Camera Configuration](/camera-preparation) and [Add the Camera](/add-camera) to Scrypted continuing with this setup. **Verify the camera streams are working properly within Scrypted**. There will be less moving parts when trying to troubleshoot issues.

---

---
url: /parts/scrypted-nvr-face.md
---
### Scrypted NVR Setup

When using Scrypted NVR, label some faces in the Detections overview tab to start recognizing the people of interest.

### Face Recognition Sensor Setup

1. Set up a smart motion sensor as described in the steps above.
2. In the Detection dropdown, select `face` (Scrypted NVR). The `person` detection type will not work, as that detects the entire person and not specfically the face.
3. Navigate to the `Recognition` tab.
4. Type the name of person to detect as labeled in the prior step. Press enter to add it to the list. Multiple names may be provided, repeat this process for as many people are desired.
5. Set the `Label Distance` to `0` so the name must exactly match.
6. Click `Save`.

---

---
url: /parts/proxmox-tip.md
---
::: tip
[Proxmox VE](/installation.md#proxmox-ve) is the recommended installation host for dedicated Intel/AMD servers, and is [preferred over Docker](/installation#proxmox-ve-vs-docker).
:::

---

---
url: /parts/scrypted-nvr-lpr.md
---
### Scrypted NVR Setup

When using Scrypted NVR, license plate recognition must first be enabled on the camera. Be aware that this will use reduce the camera's overall detection performance to also accomodate license plate recognition:

1. Navigate to the camera in the Scrypted Management Console.
2. Click the Object Detection Settings.
3. Add `plate` to the detection list.
4. Click `Save`.

### LPR Sensor Setup

1. Set up a smart sensor as described in the steps above.
2. In the Detection dropdown, select `plate` (Scrypted NVR) or `licensePlate` (Unifi). The `vehicle` or `car` detection type will not work, as that detects the entire vehicle and not specfically the license plate.
3. Navigate to the `Recognition` tab.
4. Type the license plate to detect. Press enter to add it to the list. Multiple license plates may be provided, repeat this process for as many plates are desired.
5. Click `Save`.

::: tip
License plate character recognition can be inaccurate depending on conditions. Changing the `Label Distance` setting will configure the detector to allow a number of missing or incorrect characters when attempting to match a specific plate.  Ie, a distance of 1 will match `ABCDE` to `ABCBE` or `ABCD`.
:::

---

---
url: /scrypted-nvr/parts/nas-tip.md
---
::: tip
Scrypted NVR users recording to NAS storage are encouraged to use [Cluster Mode](/maintenance/cluster.md) instead for optimal reliability and performance. The NAS should run the `server`, and the existing hardware should become a Cluster Mode `client` to handle detections and transcoding.
:::

---

---
url: /scrypted-nvr/parts/nvr-camera-requirements.md
---
Only local RTSP Cameras are officially supported by Scrypted NVR. This is typically any camera that implements the `ONVIF` and `RTSP` protocol and uses the `H.264` video codec.

Unsupported hardware (which may work to varying degrees) includes:

* Cloud cameras like Ring, Google/Nest, and Arlo.
* Non-native RTSP Cameras like Wyze.
* Non manufacturer provided custom firmware like Thingino.
* Battery powered cameras.

---

---
url: /scrypted-nvr/parts/nvr-server-requirements.md
---
The following server configurations are supported by Scrypted NVR:

### Platforms

* Docker or Proxmox (with supported CPU).
* Apple Silicon running the Scrypted NVR Desktop app.
* Windows running the Scrypted NVR Desktop app.

### Hardware

* Apple Silicon
* Intel 9th generation or later CPUs and iGPU.
  * Note: the newest generation CPU may NOT have full support due to kernel/driver support not being available out of the box in Proxmox or Ubuntu. One generation AFTER the latest is generally recommended for stability.
* AMD 5000 series or later CPUs. iGPU is not supported, and inference will be CPU only.
* NVIDIA 30 series or later GPUs.

These are the most common configurations, are known to be reliable and performant. However, Scrypted NVR can run on much more than is listed here, but when running into issues support may be limited.

---

---
url: /scrypted-nvr/storage/nvr-plugin-storage-settings.md
---
2. The recordings storage directory can be configured within the `Scrypted NVR Plugin` Settings. [Multiple Storage Devices](/scrypted-nvr/recording-storage.md#multiple-storage-devices) can also be added.
3. Continue on to [Enable Camera Recording](/scrypted-nvr/camera-recording).

---

---
url: /server-port.md
---
Scrypted is now running at: `https://localhost:10443/`

Note that it is `https` and that you'll be asked to approve/ignore the website certificate. Replace `localhost` with your server/container IP.

---

---
url: /maintenance/access.md
---
# Users and Remote Access

## Additional User Accounts

Additional local user accounts can be added in the Scrypted Management Console.

By default, non-admin users can not to view/edit any devices, install plugins, or otherwise have access to anything on the server. Enable the `Scrypted NVR Users` extension to allow the user access to `Scrypted NVR`, then grant the account permissions to specific cameras.

## Remote Access

For turnkey remote access, install the `Scrypted Cloud` plugin and click `Login` to link an email account. The email account linked with `Scrypted Cloud` can only be used to *reach* the server. A local account, as provisioned above, can then be used to log into the server.

::: info
The email account linked with Scrypted Cloud does not provide Single Sign-On (SSO) access to a server. Otherwise a compromise in any service providing authentication (ie, Scrypted Cloud, Gmail, Apple Sign In, lost email password, etc) could provide other parties the ability to view to cameras or modify server settings. Similarly, a connection routing or caching issue could also make cameras accessible to other users of Scrypted Cloud. A separate local login (which is not controlled by a cloud provider) provides a backstop for malicious or accidental server access.
:::

## Share Server

First, create an [additional local user account](#additional-user-accounts) and grant access to the desired cameras in `Scrypted NVR`.

1. Open [home.scrypted.app](https://home.scrypted.app) and log in with the [Remote Access](#remote-access) configured above.
2. Click the `Share` icon.
3. Add the user email to the list that can access the server.
4. Copy the `Invite Code`.
5. Save.
6. Send the user the following information:
   * The previously copied `Invite Code`.
   * The local user account credentials.

::: tip
The user will not be automatically notified by email they have access to the server.
:::

## Join Server

1. Open [home.scrypted.app](https://home.scrypted.app) and log in with your email.
2. Provide the above email to the admin of the server.
3. Enter the invite code provided by the admin.
4. The browser will continue to the local login for the newly added server.
5. Log in with the local account credentials that was also provided by the admin. **This is not the email you used to sign in from the cloud.**

---

---
url: /platforms.md
---
# What are Plugins?

`Plugins` are how Scrypted imports and exports camera streams. Camera Plugins include `ONVIF`, `Hikvision`, `Amcrest`, `Ring`, and more.

`Platforms` are external home automation services that support cameras but may not support *your* camera. Scrypted's `Platform Plugins` function as a bridge to those services.

`Platforms` include [Homekit](/homekit), [Google Home](/google-home), [Alexa](/alexa), and [Home Assistant](/home-assistant).

## Scripts

Similar to `Plugins`, `Scripts` are a lightweight user editable way to add powerful automations, devices, and features to Scrypted. Visit the [Scripts](https://scripts.scrypted.app) site for popular user contributed tools.

---

---
url: /install/windows-powershell.md
---
# Windows - PowerShell

Scrypted NVR on Windows must install the [Install](/desktop-application) or [Migrate](/maintenance/migration.md#migrating-to-the-desktop-application) to the [Desktop Application](/install/desktop-app.md). The Desktop App has GPU acceleration, is fully self contained with zero dependencies, and requires a license. The free version of Scrypted may be installed using the PowerShell Installation below.

This [script](https://github.com/koush/scrypted/blob/main/install/local/install-scrypted-dependencies-win.ps1) will download all the dependencies, including Node.js, Additional Tools for Node.js, Python, and install Scrypted as a service.

Open a **PowerShell Terminal** by clicking Start, type "Windows PowerShell" and click "Run as Administrator" option

Use the Copy button in the snippet below and paste it into Powershell to [allow execution of unsigned scripts](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3).

```powershell
Set-ExecutionPolicy Unrestricted
```

Press "y" to accept execution policy change

Use the Copy button in the snippet below to copy and paste it into Powershell to install Scrypted.

```powershell
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/koush/scrypted/main/install/local/install-scrypted-dependencies-win.ps1'))
```

After installation, a firewall permission dialog may be shown. This must be set to allow all networks, including public networks.

* If this prompt does not show up, you **must** go to the Windows Firewall settings and allow `Node.js JavaScript Runtime` and `Python` to communicate with `Private` and `Public` networks as shown below.

---

---
url: /scrypted-nvr/storage/windows.md
---
# Windows Storage

1. The storage disk must be formatted as `NTFS`.