search

ep1cman / unifi-protect-backup

Python tool to backup unifi event clips in realtime
MIT License
576 stars 25 forks source link

Update docs for ignoring cameras #134

Closed adriankeenan closed 3 months ago

adriankeenan commented 3 months ago

First off, thanks for this amazing tool. This fixes my main gripe with Unifi cameras - no offsite backups :slightly_smiling_face:

Some context: I wanted to use the --ignore-camera option to exclude a couple of indoor cameras that I have, and it took me a few minutes to find the IDs in the logs, so I thought it would be useful to document how to parse these.

I did have a look at adding a command to dump the camera IDs, however, I then realized that you can just use a Unifi user with a role restricted to only a subset of cameras to achieve the same thing. To be honest, I can't see why you wouldn't go this route rather than block-listing clientside, but I guess it's nice to have the option. This option wasn't immediately obvious to me, so I wanted to document it for others benefit.

ep1cman commented 3 months ago

Thanks for contributing, both details are definitely useful to document.

I would ask for one minor change: I suspect not everyone is running via docker and some folks might not understand what sed is doing. I think it would be useful to add a note above that section explain where to find the IDs in the log manually without the use of sed or grep etc

adriankeenan commented 3 months ago

That's totally reasonable. I did consider this, but went with it anyway because the docs seem to strongly suggest usage of the container. Being more generic is probably better though as you said.

I've made a commit to hopefully fix this, though please feel free to edit it.

ep1cman commented 3 months ago

Thanks!

adriankeenan commented 3 months ago

Thanks for the merge :smile: