README.md

Scrypted

Scrypted is a high performance home video integration and automation platform.

• Video load instantly, everywhere: Demo
• HomeKit Secure Video Support
• Google Home support: "Ok Google, Stream Backyard"
• Alexa Support: Streaming to Alexa app on iOS/Android and Echo Show.

Installation

Select the appropriate guide. After installation is finished, remember to visit HomeKit Secure Video Setup.

• Raspberry Pi
• Linux
  • Docker Compose - This is the recommended method. Local installation may interfere with other server software.
  • Docker - Use Docker Compose. This is a reference documentation.
  • Local Installation - Use this if Docker scares you or whatever.
• Mac
  • Local Installation

• Windows
  • Local Installation
  • WSL2 Installation

• ReadyNAS: Docker
• Synology: Docker
• QNAP: Docker
• Unraid: Docker

Discord

Chat on Discord for support, tips, announcements, and bug reporting. There is an active and helpful community.

Join Scrypted Discord

Wiki

There are many topics covered in the Scrypted Wiki sidebar. Review them for documented support, tips, and guides before asking for assistance on GitHub or Discord.

Supported Platforms

• Google Home
• Apple HomeKit
• Amazon Alexa

Supported accessories:

• https://github.com/koush/scrypted/tree/main/plugins

Development

Debug the Scrypted Server in VSCode

# check out the code
git clone https://github.com/koush/scrypted
cd scrypted
# get the dependencies for the server and various plugins
./npm-install.sh
# open server project in VS Code
code server

You can now launch Scrypted in VSCode.

Debug Scrypted Plugins in VSCode

# this is an example for homekit.
# check out the code
git clone https://github.com/koush/scrypted
cd scrypted
# get the dependencies for the server and various plugins
./npm-install.sh
# open the homekit project in VS Code
code plugins/homekit

You can now launch (using the Start Debugging play button) the HomeKit Plugin in VSCode. Please be aware that you do not need to restart the Scrypted Server if you make changes to a plugin. Edit the plugin, launch, and the updated plugin will deploy on the running server.

If you do not want to set up VS Code, you can also run build and install the plugin directly from the command line:

# currently in the plugins/homekit directory.
npm run build && npm run scrypted-deploy 127.0.0.1

Plugin Development

Want to write your own plugin? Full documentation is available here: https://developer.scrypted.app