Skip to content

WoofyIO/unifi-protect-video-downloader

 
 

Repository files navigation

UniFi Protect Video Downloader

Tool to download footage from a local UniFi Protect system

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

📦 Releases

Latest release: https://github.com/unifi-toolbox/unifi-protect-video-downloader/releases/latest
Docker image: https://hub.docker.com/r/unifitoolbox/protect-archiver

➡️ Getting started

For CloudKey-based Protect installations

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 UDM-based Protect installations

The protect-archiver can access UDM-based Protect installations by using @Silvenga's unifi-udm-api-proxy.

Download the project files

git clone https://github.com/unifi-toolbox/unifi-protect-video-downloader.git
or
git clone [email protected]:unifi-toolbox/unifi-protect-video-downloader.git

Start the UniFi UDM API Proxy

Enter the project directory

cd unifi-protect-video-downloader

Start the proxy

UDM_URI=https://192.168.0.1 docker-compose up -d

(replace 192.168.0.1 with the IP address of your UDM)

Hint: To stop the UniFi UDM API Proxy, run docker-compose down from within the project directory.

Run the protect-archiver

docker run --network=unifi-protect-video-downloader_default --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). The API proxy's address/hostname is unifi-udm-api-proxy.)

Example: docker run --network=unifi-protect-video-downloader_default --volume /path/on/host/machine:/downloads unifitoolbox/protect-archiver download --address="unifi-udm-api-proxy" [OPTIONS] /downloads

🔗 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/

⚠️ 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.

About

Tool to download footage from a local UniFi Protect system

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.7%
  • Other 1.3%