mirror of
https://github.com/koush/scrypted.git
synced 2026-02-09 16:52:18 +00:00
d7e2177eeb46aa92d184cb1d19d4e4ae2f9ed178
Scrypted Home Automation
Discord
Supported Platforms
- Google Home
- Apple HomeKit
- Amazon Alexa
Supported accessories:
Installation
Run on Docker
Docker images are published on Docker Hub. The images will not work properly on Mac or Windows, because the --network host argument does not work for those platforms.
# pull the image
sudo docker pull koush/scrypted
# run the image, saving the database and configuration files in a subdirectory named "scrypted"
sudo docker run --network host -v $(pwd)/scrypted:/server/volume koush/scrypted
Run Locally
Prerequisites
- Node v16 (older versions seem to have issues with the cluster module)
- Windows is not supported, but may work.
Linux Prerequisites
sudo apt install libavahi-compat-libdnssd-dev
Run in Terminal
# checkout source
git clone https://github.com/koush/scrypted.git
# npm install and run
cd scrypted/server
npm install
npm run serve
# visit https://localhost:9443/ in a browser
Debug in VSCode
Follow the steps for running locally above.
# in directory with the scrypted git checkout
cd scrypted/server
# open this directory in VSCode
code .
You can now launch Scrypted in VSCode.
Plugin Development Documentation
https://developer.scrypted.app
HomeKit Secure Video Setup
- Install Scrypted
- Open https://localhost:9443/
- Install the HomeKit Plugin from the available plugins tab
- Install the Unifi or Amcrest camera plugin
- (optional/recommended) Install the Prebuffer plugin to keep a short video loop of the stream leading up to the motion.
- Pair with the Scrypted Hub accessory using your HomeKit app on iOS or Mac.
Description
Languages
TypeScript
79.8%
Python
16.3%
JavaScript
2.3%
Shell
1.4%
PowerShell
0.1%