Minimal config in installation guide #11339
Conversation
✅ Deploy Preview for frigate-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
This could maybe be pointed towards master but actually the next version of frigate (0.14) will create a minimal config file automatically if it does not exist |
|
Also in general I think a link to the getting started guide would be better as that goes step by step through the minimal config creation. We wouldn't want another config example to maintain |
|
Thanks @NickM-27 , so just to clarify,
|
|
I think it may be better to remove the yaml example and instead say that a config is required, link to the getting started guide creating the config section. With this PR pointed towards master, we can later adjust it to say recommended instead of required before 0.14 releases. |
lachlanmacphee
force-pushed
the
patch-1
branch
2 times, most recently
from
fb18fc2
to
c98dcf7
Compare
|
Will need to rebase 👍 |
|
Yep, on it now, apologies :) |
+ Adds a subsection to the installation guide that mentions the requirement for a minimal config to start Frigate successfully. + Adds a warning not to proceed any further into the guide without this valid config
|
Done, TIL the |
docs/docs/frigate/installation.md
Outdated
| @@ -78,6 +81,12 @@ $ python -c 'print("{:.2f}MB".format(((1280 * 720 * 1.5 * 9 + 270480) / 1048576) | |||
|
|
|||
| The shm size cannot be set per container for Home Assistant add-ons. However, this is probably not required since by default Home Assistant Supervisor allocates `/dev/shm` with half the size of your total memory. If your machine has 8GB of memory, chances are that Frigate will have access to up to 4GB without any additional configuration. | |||
|
|
|||
| :::warning | |||
There was a problem hiding this comment.
This seems redundant to me given the first addition
There was a problem hiding this comment.
My thinking was it's easy to gloss over those sections and doesn't hurt to have a warning banner? If disagree, happy to remove 👍
There was a problem hiding this comment.
Right. Let's make the first one a warning instead of a header section and remove the second.
There was a problem hiding this comment.
Sounds good 👍
Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>
Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>
Hi all,
Firstly, thanks for such an amazing piece of software! I was going through the installation guide tonight to get my first Frigate setup going and encountered errors starting the container due to a missing config file, though this wasn't immediately clear, as I initially thought it was a
go2rtcproblem due to only seeing the bottom part of the logs in Portainer.The error for the missing config wasn't explicit about it being a requirement too, it simply said it couldn't be found, so my assumption was a minimal config would be created automatically.
I think it'd be great to mention the requirement for a minimal configuration in order for the container to start. This is in the Getting Started guide already, but that's further down the page than Installation, so people might miss it.
Specific changes:
Potential concerns:
I hope this PR helps. I did a search to see if there were any duplicates in PRs/Issues and couldn't find anything.
I apologise if I've missed something obvious and any of my assumptions here are incorrect, I come from a constructive place and just trying to make future Frigate installers' lives easier.
Regards,
Lachlan