# Eufy Security WS

Eufy Security WS is a small server wrapper around the eufy-security-client library that exposes Eufy device functions over WebSocket, giving homelab users a local API for custom integrations, including live streaming. It is open source and self-hosted, installable on Docker Hub, ZimaOS and Unraid.

Canonical page: https://ourlocalhost.com/app/741/eufy-security-ws

## Description

Eufy Security WS is a small server wrapper around the eufy-security-client library that exposes Eufy device functions over WebSocket, giving homelab users a local API for custom integrations, including live streaming.

## Platform availability

Available on 2 of 9 platforms: Unraid, ZimaOS.

## Health score

15/100 (Low), based on 2 of 4 factors.
- Maintained: 0 (GitHub repository no longer exists)
- Easy to install: 45 (2 install platforms, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/bropat/eufy-security-ws/
- ZimaOS: https://github.com/bigbeartechworld/big-bear-casaos/tree/master/Apps/eufy-security-ws
- Unraid: https://ca.unraid.net/apps/eufy-security-ws-0656oou0np4sv6?q=Eufy-Security-WS
- GitHub: https://github.com/bropat/eufy-security-ws

## Common questions

### What Eufy account details must I provide for eufy-security-ws to sign in?

Provide your country, Eufy email, and password, and be ready to enter a one-time two-factor code from Eufy if asked. Without these details, the app cannot sign in or see your cameras.

### What package does eufy-security-ws depend on to connect to Eufy devices?

The client package is installed with npm install eufy-security-client. Without this package installed, the app cannot connect to Eufy devices.

### Which device identifier should I use when configuring cameras, locks, or trackers?

Use the device's serial number, often shown as sn, when pointing the app at a camera, lock, or tracker. If the serial number is missing or wrong, events, livestreams, or actions will not work.

### How do I install the official Home Assistant add-on for eufy-security-ws?

Open the Add-On store, select eufy-security-ws, and fill in the configuration before starting it. For a develop version, select eufy-security-ws-dev and set the GitHub URL and branch if requested.

### Why might eufy-security-ws create only a persistent.json file and no video recordings?

A Docker user reports that eufy-security-ws can connect to Eufy cameras but does not create video recordings, producing only a persistent.json file.

---
Source: Our Local Host (https://ourlocalhost.com/app/741/eufy-security-ws), the self-hosted and open-source app directory.