Skip to content

Commit

Permalink
nas
Browse files Browse the repository at this point in the history
  • Loading branch information
koush committed Dec 31, 2024
1 parent 6823039 commit dca9c66
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 12 deletions.
6 changes: 5 additions & 1 deletion buyers-guide/servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,8 @@ Macs can be quite picky about USB drive bays and may disconnect them randomly. U

## Network Attached Storage

Storing video on a NAS is a reasonable option if one is available, however timelapse scrubbing may suffer from poor performance over the network.
::: 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.
6 changes: 2 additions & 4 deletions maintenance/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

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

::: tip
Scrypted NVR users recording to NAS storage are encouraged to use `Cluster Mode` instead, for recording reliability. The `server` should be migrated to the NAS and the current server would migrate to `client` mode to handle detections and transcoding.
:::
<!--@include: ../scrypted-nvr/parts/nas-tip.md-->

A machine 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`).
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 Server Setup

Expand Down
3 changes: 3 additions & 0 deletions scrypted-nvr/parts/nas-tip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
::: tip
Scrypted NVR users recording to NAS storage are encouraged to use [Cluster Mode](/maintenance/cluster.md) instead for optimal reliability and performance. The `server` should be migrated to the NAS and the current server would migrate to `client` mode to handle detections and transcoding.
:::
20 changes: 13 additions & 7 deletions scrypted-nvr/recording-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,12 @@
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.
* All storage disks must be 1TB minimum in size.
* Scrypted NVR will not work with filesystem quota features. Use a separate filesystem partition to restrict how much space is available.
:::

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

::: warning
Scrypted NVR will not work with filesystem quota features. Use a separate filesystem partition to restrict how much space is available.
NAS storage should also refer to the [NAS notes](#nas).
:::

| Resolution | 4 Cameras | 6 Cameras | 10 Cameras | 16 Cameras |
Expand All @@ -21,7 +18,7 @@ Scrypted NVR will not work with filesystem quota features. Use a separate filesy
| 4K | 2.4TB | 3.6TB | 6TB | 9.6TB |


## Storage Setup
## Host Setup

To configure storage, select the server installation platform below:

Expand Down Expand Up @@ -55,3 +52,12 @@ RAID disks can be assigned to Recording Storage as a storage directory for serve
Scrypted NVR will delete recordings 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.

For best performance, provide an entire disk or partition to Scrypted NVR. Volumes that share disk space other is not recommended as it may cause issues with recording retention periods.

## NAS

<!--@include: ./parts/nas-tip.md-->

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

0 comments on commit dca9c66

Please sign in to comment.