Scrypted Docs

Appearance

Installation ​

Scrypted can be installed on Windows, Mac, or Linux as a desktop app or as a background service (Mac, Windows, Proxmox VE, Linux).

TIP

Proxmox VE is the recommended installation host for dedicated Intel/AMD servers, and is preferred over Docker.

After the chosen installation method is complete, return to this page to continue with Camera Setup.

Desktop App ​

The recommended installation method for Mac and Windows is the Desktop App. 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.

Ubuntu/Debian Repository ​

TIP

Scrypted servers running on Linux should typically use the 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.

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.

Proxmox VE ​

TIP

Proxmox VE is the recommended installation host for dedicated Intel/AMD servers, and is preferred over Docker.

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/local/install-scrypted-proxmox.sh > install-scrypted-proxmox.sh
bash install-scrypted-proxmox.sh

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

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.

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 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
echo "deb https://packages.cloud.google.com/apt coral-edgetpu-stable main" | tee /etc/apt/sources.list.d/coral-edgetpu.list
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add -
apt-get -y update
apt-get -y install libedgetpu1-max

Proxmox VE vs Docker ​

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

Linux - Docker ​

Linux + Docker installations should refer to the System Requirements for host OS recommendations. Docker Desktop on Windows/Mac is not supported.

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.

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.

docker-compose.yml ​

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

ImageDescription
ghcr.io/koush/scryptedThe default image.
ghcr.io/koush/scrypted:nvidiaImage that includes full NVIDIA CUDA support for hardware accelerated transcoding and detection.

Mac - Terminal ​

Scrypted NVR on Mac must install the Install or Migrate to the Desktop Application. 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.
  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

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.

Windows - PowerShell ​

Scrypted NVR on Windows must install the Install or Migrate to the Desktop Application. 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.

All Installation Options ​