Skip to content

Scrypted HKSV

Patrick Haney edited this page Aug 22, 2024 · 4 revisions

Scrypted is a high performance home video integration platform. While Homebridge can be used to add non-HomeKit enabled cameras to your Home, Scrypted provides much better support and have very low latency.

Installing Docker and Scrypted

If your Raspberry Pi is also running Homebridge, it's important to install Scrypted through a Docker instance to separate the dependencies between the two services. Otherwise you can stick with the standard Local Installation instructions.

Run the Docker Compose Script

The following will download all the dependencies required, including Docker (which can be optionally skipped) and the docker-compose.yml, and then install Scrypted as a service.

First we create a directory for the Scrypted install file:

mkdir -p ~/.scrypted

Then we fetch the install file from the Scrypted repo:

curl -s https://raw.githubusercontent.com/koush/scrypted/main/docker/install-scrypted-docker-compose.sh > ~/.scrypted/install-scrypted-docker-compose.sh

And finally we run the Scrypted install script:

sudo SERVICE_USER=$USER bash ~/.scrypted/install-scrypted-docker-compose.sh

There will be a prompt to install Docker, which you'll need to do if your Pi is also running Homebridge. During installation, there will be another prompt to edit docker-compose.yml to add external storage for Scrypted NVR (only necessary if you plan on paying for the NVR recording option, and can be setup later).

The rest of the setup process will take some time (45 minutes on my Raspberry Pi 4), but you'll be able to see the progress on the console.

Scrypted Install Script

Verify Scrypted Docker Container

To ensure that both the watchtower and scrypted Docker containers were successfully created, run the following command:

docker ps -a

Which will display all Docker containers and their status. If neither container is shown (which can happen if there is a timeout during the Scrypted install process), you can retry the install script:

sudo SERVICE_USER=$USER bash ~/.scrypted/install-scrypted-docker-compose.sh

You'll be asked to install Docker again, which you can skip, and will then download and setup the watchtower and scrypted containers again.

Helpful Docker Commands

Though you shouldn't need to, Docker includes several commands to handle itself and its containers. To restart your Scrypted container for any reason, just run:

docker restart scrypted

You can also use the stop and start parameters if necessary. To update Docker and force a refresh of the system, run:

docker compose pull
docker compose up -d

Completing Setup Using the Web Interface

Once setup is complete, visit the Scrypted web interface to create a user account at https://192.168.x.x:10443 (where the IP address is that of the Raspberry Pi on your network). The browser will give a warning due to the invalid SSL certificate:

Scrypted Website Not Private

Show details and proceed to the website (different in each browser):

Scrypted Website Continue Anyway

Once the Scrypted Management Console loads, you'll be presented with a form to create your user account:

Scrypted Create User Account

Now you can use the Scrypted Management Console to install plugins, create automations, and more.

Scrypted Management Console

Note: To run the Scrypted Management Console over SSL, see the official documentation on adding a Custom SSL Certificate.

Adding Devices

Scrypted allows for multiple devices to be added to your home through both Plugins and Platforms. Plugins include those for Ring cameras and doorbells, Amcrest cameras, and more. Platform Plugins bridge compatible devices in Scrypted to other platforms such as HomeKit, Google Home, and Alexa.

Add Camera to Scrypted

Details coming soon...

Setup HomeKit Support

Details coming soon...

Buy Me a Coffee?

When I first started tinkering with my Raspberry Pi, I had no idea how much time I would invest in getting it up and running. I'm happy to share my findings with the community here for free, but if you'd like to say thanks, a free coffee (or beer) is always welcome.

ko-fi

Clone this wiki locally