Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App Submission: Frigate #843

Merged
merged 8 commits into from Feb 23, 2024
Merged

App Submission: Frigate #843

merged 8 commits into from Feb 23, 2024

Conversation

arguser
Copy link
Contributor

@arguser arguser commented Nov 11, 2023

App Submission

Frigate

256x256 SVG icon

(Submit an icon with no rounded corners as it will be dynamically rounded with CSS. GitHub doesn't allow uploading SVGs directly, so please upload your icon to an alternate service, like https://svgur.com, and paste the link below.)

https://raw.githubusercontent.com/blakeblackshear/frigate/d11c1a20668bca48413fe37895d905b854bc675b/web/images/favicon.svg

Gallery images

(Upload 3 to 5 high-quality gallery images (1440x900px) of your app in PNG format, or just upload 3 to 5 screenshots of your app and we'll help you design the gallery images.)

I have tested my app on:

@arguser arguser changed the title Frigate Umbrel App App Submission: Frigate Nov 16, 2023
@arguser arguser marked this pull request as draft November 29, 2023 14:05
@arguser arguser marked this pull request as ready for review November 29, 2023 14:06
@nmfretz
Copy link
Contributor

nmfretz commented Dec 12, 2023

Wonderful, thank you @arguser! I will attempt to review this week.

@arguser
Copy link
Contributor Author

arguser commented Jan 30, 2024

Hello @nmfretz, do you think we can move this forward?

@nmfretz
Copy link
Contributor

nmfretz commented Jan 30, 2024

Yes, thanks for the ping! I'm working my way up from the earlier submissions and am now here.

Copy link
Contributor

@nmfretz nmfretz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again for the submission @arguser!

I don't have a camera to thoroughly test Frigate, so I'll need your help testing as we go back and forth.

I've left a review below. Let me know if anything is unclear. And sorry if I've confused anything, I'm not familiar with Frigate.

Comment on lines 1 to 14
mqtt:
enabled: False

cameras:
name_of_your_camera: # <------ Name the camera
ffmpeg:
inputs:
- path: rtsp://10.0.10.10:554/rtsp # <----- The stream you want to use for detection
roles:
- detect
detect:
enabled: False # <---- disable detection until you have a working camera feed
width: 1280 # <---- update for your camera's resolution
height: 720 # <---- update for your camera's resolution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm glad to see this file can be edited in the app's UI so users don't have to manually do this from the terminal!

Maybe we should note this in the app description and also have one of the gallery images be the config editor screen with text at the top like
Manage your camera configuration within the app

image

When I quickly look online for frigate install/setup tutorials I see they all show editing this file manually outside of the app so users may be confused.

frigate/docker-compose.yml Outdated Show resolved Hide resolved
frigate/docker-compose.yml Show resolved Hide resolved
frigate/docker-compose.yml Outdated Show resolved Hide resolved
network_mode: host
restart: unless-stopped
image: ghcr.io/blakeblackshear/frigate:stable@sha256:bb7f7e76a13eccef0b12704e5851cc774a12af1f12df387d6a70a796a3e938c3
shm_size: "128mb" # update for your cameras based on calculation above
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know if there is a recommended share size that will work for almost everyone? Ideally users should be able to install the app and not have to worry about editing the compose file.

frigate/docker-compose.yml Outdated Show resolved Hide resolved
frigate/docker-compose.yml Show resolved Hide resolved
frigate/umbrel-app.yml Outdated Show resolved Hide resolved
@nmfretz
Copy link
Contributor

nmfretz commented Feb 23, 2024

Gallery assets are ready:
icon
1
2
3

@nmfretz
Copy link
Contributor

nmfretz commented Feb 23, 2024

@arguser let me know when you can test with a camera!

@arguser
Copy link
Contributor Author

arguser commented Feb 23, 2024

@nmfretz Tested camera, working! Google Coral Edge TPU also working!

Screenshot 2024-02-23 at 17-55-22 Frigate
Screenshot 2024-02-23 at 17-55-01 Frigate

@nmfretz
Copy link
Contributor

nmfretz commented Feb 23, 2024

Excellent, thanks @arguser. Are you okay with going live to the app store now? If so, I'll edit the app description slightly to add a bit more detail on configuring a camera and then merge!

@arguser
Copy link
Contributor Author

arguser commented Feb 23, 2024

@nmfretz I think we are OK. Would be good to have more flexibility on shm_size but as I understand with this value Frigate should be able to manage up to 4 cameras.

Reference
https://docs.frigate.video/frigate/installation#calculating-required-shm-size

@nmfretz
Copy link
Contributor

nmfretz commented Feb 23, 2024

Would be good to have more flexibility on shm_size but as I understand with this value Frigate should be able to manage up to 4 cameras.

Thanks for looking into this. Let's start with shm_size of 128bm then. We can always modify in an app update if we get user feedback suggesting we should change this value.

Thanks again for all your hard work submitting Frigate! Going live to the app store now.

@nmfretz
Copy link
Contributor

nmfretz commented Feb 23, 2024

Actually, @arguser are you able to give me temporary permission to push to your fork so that I can quickly make the final changes?

image

@arguser
Copy link
Contributor Author

arguser commented Feb 23, 2024

@nmfretz done!

@nmfretz
Copy link
Contributor

nmfretz commented Feb 23, 2024

Thanks @arguser! You can now remove my permissions if you'd like. I added some set-up instructions to the app description, made it so that a default deterministic password is shown to the user in the app store for Frigate's RTSP password, and also moved around the file structure a tad so that it is the same as other apps on Umbrel.

We're live!

image

@nmfretz nmfretz merged commit ba57bc9 into getumbrel:master Feb 23, 2024
zapomatic pushed a commit to zapomatic/umbrel-apps that referenced this pull request Mar 13, 2024
Co-authored-by: nmfretz <nmfretz@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants