Skip to content

Local Installation (Advanced)

Austin Drummond edited this page Jan 29, 2022 · 7 revisions

Prerequisites

Run in Terminal (Linux/Mac)

# Verify node version ~v16.13.0
node -v

# node should come with "npx".
# install and start the scrypted server
npx -y scrypted serve

# visit https://localhost:10443/ in a browser

Running on Boot

Linux (including Raspberry Pi)

The Linux installation script above does this automatically. This is simply here for reference.

Create scrypted.service in /etc/systemd/system/ with the following contents (replace the service user pi as appropriate):

[Unit]
Description=Scrypted service
After=network.target

[Service]
User=pi
Group=pi
Type=simple
KillMode=process
ExecStart=/usr/bin/npx -y scrypted serve
Restart=on-failure
RestartSec=3

[Install]
WantedBy=multi-user.target

Enable the service with:

sudo systemctl enable scrypted.service && sudo systemctl start scrypted.service

Mac

Create a login script:

echo npx -y scrypted serve > ~/scrypted-serve.sh
chmod +x ~/scrypted-serve.sh

# older Macs (Catalina and prior), may need to name the file scrypted-serve.command

Users___Groups

Installation Notes

npx scrypted serve will install scrypted to your $HOME/.scrypted, and will contain the following directories:

  • volume - the database
  • node_modules - the app