danielfernau / unifi-protect-video-downloader

Tool for downloading footage from a local UniFi Protect system
https://ui-protect-dl-docs.danielfernau.com/
MIT License
482 stars 55 forks source link

UniFi Protect Video Downloader

Tool to download footage from a local UniFi Protect system

GitHub release (latest by date) GitHub release (latest by date) GitHub Workflow Status GitHub repo size GitHub stars GitHub issues Docker image size Docker pulls License Codecov

:package: Releases

Releases: https://github.com/danielfernau/unifi-protect-video-downloader/releases
Docker images: https://hub.docker.com/r/unifitoolbox/protect-archiver

:file_folder: Version 1.x code: https://github.com/danielfernau/unifi-protect-video-downloader/tree/2165204442d30676f3f48ad445c0211c6e5c00c1

:arrow_right: Getting started

For Protect servers with UniFi OS

docker run --volume /path/on/host/machine:/downloads unifitoolbox/protect-archiver --help

(replace /path/on/host/machine with an absolute path to your download directory and --help with one of the supported commands and its parameters as documented here: wiki/Usage-(v2.x))

Example:

docker run --volume /path/on/host/machine:/downloads unifitoolbox/protect-archiver download [OPTIONS] /downloads

For Protect systems with older firmware

To use the tool with older systems, just add the --not-unifi-os flag to your options list.

Example:

docker run --volume /path/on/host/machine:/downloads unifitoolbox/protect-archiver download --not-unifi-os [OPTIONS] /downloads

:thought_balloon: Questions, ideas, support and more...

For everything that isn't a bug, issue or error, feel free to use the project's Discussions tab:
https://github.com/danielfernau/unifi-protect-video-downloader/discussions

:hammer_and_wrench: Development and Build Instructions

If you want to make changes, build you own version, test things or contribute to the project, you can find all the relevant Development and Build Instructions in the BUILD.md file. Pull requests are welcome!

:link: Links

Community post:
https://community.ui.com/questions/Tool-for-downloading-footage-from-UniFi-Protect/47057c1d-112b-4092-b488-a380286933df

Reddit post:
https://www.reddit.com/r/Ubiquiti/comments/dhaxcq/tool_for_downloading_footage_from_unifi_protect/

:warning: Important Information

This tool is neither supported nor endorsed by, and is in no way affiliated with Ubiquiti Inc.
It is not guaranteed that it will always run flawlessly, so use this tool at your own risk.
The software is provided without any warranty or liability, as stated in the license.