scrypted v0.1.0

Automation

Scrypted — a high-performance home video integration and automation platform that bridges cameras and devices to HomeKit, Google Home and Alexa with fast, low-latency streaming. Deployed as a single host-networked Nomad service.

nomad-pack run scrypted --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- scrypted

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 6k ⚑ Report an issue

1 task https 10443http 11080 1 volume image ghcr.io/koush/scrypted:latest tracks :latest image bumped today

Variables 9

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run scrypted -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "scrypted"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Scrypted container image. Pin a tag in production.
image = "ghcr.io/koush/scrypted:latest"

# Host port for the Scrypted management console (HTTPS).
port = 10443

# Host port for the Scrypted HTTP endpoint.
http_port = 11080

# Named volume for the Scrypted server state and plugins (/server/volume).
data_volume = "scrypted_volume"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true". Pin to the node on the camera LAN.
constraints = []

# The task resources. Camera transcoding benefits from more CPU.
resources = {
    cpu    = 2000
    memory = 2048
  }

Name	Type	Default	Description
job_name	string	"scrypted"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"ghcr.io/koush/scrypted:latest"	The Scrypted container image. Pin a tag in production.
port	number	10443	Host port for the Scrypted management console (HTTPS).
http_port	number	11080	Host port for the Scrypted HTTP endpoint.
data_volume	string	"scrypted_volume"	Named volume for the Scrypted server state and plugins (/server/volume).
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true". Pin to the node on the camera LAN.
resources	object	{ cpu = 2000 memory = 2048 }	The task resources. Camera transcoding benefits from more CPU.

Back up this pack

This pack stores data in one Docker named volume: scrypted_volume

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/scrypted_volume/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/scrypted_volume/_data backup:<bucket>/scrypted_volume

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

scrypted

Scrypted is a high-performance home video integration and automation platform. It connects your IP cameras and smart devices and exposes them to Apple HomeKit, Google Home and Amazon Alexa with fast, low-latency (including HomeKit Secure Video) streaming and hardware transcoding. A huge plugin ecosystem covers cameras, NVR, doorbells, lights and more.

This pack runs Scrypted as a single host-networked Nomad service. Host networking is required for camera discovery and HomeKit/mDNS.

Deploy

nomad-pack run scrypted --registry=nomploy

Open https://<node-ip>:10443 (self-signed certificate) and create the admin account, then install plugins for your cameras and platforms.

Configuration

Variable	Default	Description
`image`	`ghcr.io/koush/scrypted:latest`	Container image (pin a tag in production).
`port`	`10443`	Host port for the HTTPS management console.
`http_port`	`11080`	Host port for the HTTP endpoint.
`data_volume`	`scrypted_volume`	Volume for server state and plugins.
`constraints`	none	Pin to the node on the camera LAN.
`resources`	2000 MHz / 2048 MB	CPU and memory (transcoding wants CPU).

All server state and installed plugins persist in data_volume under /server/volume. Because Scrypted uses host networking, avoid co-locating it with other host-networked services that bind the same ports.