Skip to content

Commit

Permalink
support
Browse files Browse the repository at this point in the history
  • Loading branch information
koush committed Nov 26, 2024
1 parent a4b3af6 commit 6726ea1
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 64 deletions.
59 changes: 2 additions & 57 deletions maintenance/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<!--@include: ../parts/cluster-setup-env.md-->

```sh
# Set worker type. There can only be one server.
Expand All @@ -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.
<!--@include: ../parts/cluster-setup-env.md-->

```sh
# Set worker type. There can be multiple clients.
Expand Down
29 changes: 29 additions & 0 deletions parts/cluster-setup-env.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions scrypted-nvr/parts/nvr-camera-requirements.md
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 2 additions & 7 deletions scrypted-nvr/policies/fulfillment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<!--@include: ../parts/nvr-camera-requirements.md-->

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

Expand Down
4 changes: 4 additions & 0 deletions server-hardware.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!--@include: ./scrypted-nvr/parts/nvr-camera-requirements.md-->

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

0 comments on commit 6726ea1

Please sign in to comment.