![Eufy Security WS]()
Eufy Security WS
Container
Eufy Security Web Socket. Edit container and add username & password.
Image details
Source details
Configuration
TypeContainerlinuxbropat/eufy-security-ws:latest3993:3000/tcp/data : /portainer/Files/AppData/Config/eufy-security-wsUSERNAME=InputUSER-emailPASSWORD=InputPWDunless-stoppedTemplate by xneo1
Standalone Install
Select an install method, to see config/commands for deploying Eufy Security WS
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Eufy Security WS, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see bropat/eufy-security-ws for app-specific guidance.
eufy-security-ws
eufy-security-ws
Small server wrapper around eufy-security-client library to access it via a WebSocket.
The development of this server was inspired by the following project:
Credits go to them as well.
If you appreciate my work and progress and want to support me, you can do it here:
This project is not affiliated with Anker and Eufy (Eufy Security). It is a personal project that is maintained in spare time.
Get started
To try it out or for more information, such as API documentation, Docker image, etc., please see here.Serve Eufy Security WS on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying eufy-security-ws.example.com to http://eufy-security-ws:3000
Add this to your Caddyfile
eufy-security-ws.example.com {
reverse_proxy http://eufy-security-ws:3000
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs eufy-security-ws - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:3993 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :3993 - Stop the other service, or pick a different host port. In
3993:3000only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:3993. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, eufy-security-ws can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 3993
Permission denied on volumes
If the logs show "permission denied", the app can't write to its data folder on the host.
- Fix the ownership:
sudo chown -R 1000:1000 /portainer/Files/AppData/Config/eufy-security-ws
Image won't pull
Test the pull directly on the host: docker pull bropat/eufy-security-ws:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm/v7, arm/v6 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect eufy-security-ws --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on bropat/eufy-security-ws
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Eufy Security WS runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Eufy Security WS needs bundled into one download. This template pulls bropat/eufy-security-ws:latest, which Docker fetches once (about 62 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Eufy Security WS's comes from Docker Hub, published by bropat.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 3.1. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 3993:3000 means it's reachable on port 3993 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3993 in a browser. It opens:
3993:3000, likely the web interface
Volumes
A volume is where Eufy Security WS keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/datafrom/portainer/Files/AppData/Config/eufy-security-wson the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Eufy Security WS takes 2 of them, all with defaults you can leave alone or tweak:
USERNAME, defaults toInputUSER-emailPASSWORD, defaults toInputPWD
Restart policy
The restart policy here is unless-stopped, so Docker restarts Eufy Security WS after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so Eufy Security WS sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container eufy-security-ws. That's what you'll spot in the containers list and use in commands like docker logs eufy-security-ws.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
Eufy Security WS is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Eufy Security WS up. Add the template list to Portainer once, then deploying Eufy Security WS is a click rather than a wall of config.