From 6726ea147194ad19f80a0539b4cee9cf2290e4c4 Mon Sep 17 00:00:00 2001 From: Koushik Dutta Date: Tue, 26 Nov 2024 10:11:54 -0800 Subject: [PATCH] support --- maintenance/experimental.md | 59 +------------------ parts/cluster-setup-env.md | 29 +++++++++ scrypted-nvr/parts/nvr-camera-requirements.md | 7 +++ scrypted-nvr/policies/fulfillment.md | 9 +-- server-hardware.md | 4 ++ 5 files changed, 44 insertions(+), 64 deletions(-) create mode 100644 parts/cluster-setup-env.md create mode 100644 scrypted-nvr/parts/nvr-camera-requirements.md diff --git a/maintenance/experimental.md b/maintenance/experimental.md index ea53059..6ede274 100644 --- a/maintenance/experimental.md +++ b/maintenance/experimental.md @@ -14,34 +14,7 @@ A machine can operate in either `server` or `client` mode. There can only be one The Cluster server will ingest the camera streams and save them to the NVR storage. -Create and edit Scrypted `.env` configuration file: - -::: code-group - -```sh[Docker Compose] -nano ~/.scrypted/volume/.env -``` - -```sh[Proxmox] -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. + ```sh # Set worker type. There can only be one server. @@ -63,35 +36,7 @@ A Cluster client will perform video decoding and detection. When adding a client, install Scrypted as usual (and switch to the beta tag). Account creation is not necessary. Once the server is running, create and edit Scrypted `.env` configuration file: - -Create and edit Scrypted `.env` configuration file: - -::: code-group - -```sh[Docker Compose] -nano ~/.scrypted/volume/.env -``` - -```sh[Proxmox] -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. + ```sh # Set worker type. There can be multiple clients. diff --git a/parts/cluster-setup-env.md b/parts/cluster-setup-env.md new file mode 100644 index 0000000..0231fd7 --- /dev/null +++ b/parts/cluster-setup-env.md @@ -0,0 +1,29 @@ + +Create and edit Scrypted `.env` configuration file: + +::: code-group + +```sh[Docker Compose] +nano ~/.scrypted/volume/.env +``` + +```sh[Proxmox] +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. diff --git a/scrypted-nvr/parts/nvr-camera-requirements.md b/scrypted-nvr/parts/nvr-camera-requirements.md new file mode 100644 index 0000000..6912694 --- /dev/null +++ b/scrypted-nvr/parts/nvr-camera-requirements.md @@ -0,0 +1,7 @@ + +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. + * Battery powered cameras. diff --git a/scrypted-nvr/policies/fulfillment.md b/scrypted-nvr/policies/fulfillment.md index 17a7215..6dd1c8d 100644 --- a/scrypted-nvr/policies/fulfillment.md +++ b/scrypted-nvr/policies/fulfillment.md @@ -8,14 +8,9 @@ The Scrypted NVR subscription can be managed at the [billing portal](https://bil 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 Hardware +## Supported Cameras -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. - * Battery powered cameras. + **Subscriptions intended for unsupported hardware are not eligible for technical assistance or refunds.** diff --git a/server-hardware.md b/server-hardware.md index 3b9981f..8366570 100644 --- a/server-hardware.md +++ b/server-hardware.md @@ -40,6 +40,10 @@ The following chart is a rough idea of the capabilities of a few such systems. |Intel N100|Ubuntu + 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/).| +### Cameras + + + ### Storage 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.