✨ [REQUEST] BirdNET-Pi Improved support for standalone usage outside of Home Assistant

[DavidValeri]

Checked

• If a new addon, I have checked on Google that such as addon doesn't already exists
• If a new feature, I have searched in the discussions & issues that it was not already covered

Which addon?

Birdnet-Pi

Is your feature request related to a problem? Please describe

tl;dr - It took too much tinkering to get BirdNET-Pi running in Docker outside of Home Assistant.

I got the container running on a Docker installation outside of Home Assistant, but there was definitely some tinkering. The tinkering was due to some places where it seems to be tied to Home Assistant's ingress architecture and some other cases of configurations not coming out right when running outside of Home Assistant. There's no documentation indicating this is a supported setup other than mcguirepr89/BirdNET-Pi#211 (comment). I filed this as a feature request since it is only implied this deployment pattern is a feature, but the description is going to read more like a bug report.

Describe the solution you'd like

• Some minimal documentation for the deployment process / configuration. An example compose file with the most critical settings defined and an indication of which ports are expected to be used in this deployment pattern.
• nginx and avahi should not throw errors or should otherwise be disabled if not necessary or desired.
• Various BirdNet-Pi services should auto-start after boot, if enabled.

Here's some context from my tinkering. I will add more to this issue if I dig deeper.

Additional context

• Site HTML
  • The title is <title>buildkitsandbox</title>. Not sure if this is from the upstream or introduced in the containerization / customization.
• nginx
  • It is unclear if nginx should be the point of entry when outside of Home Assistant. Nonetheless, tokens in the ingress.conf were not replaced properly and nginx fails to start. 91-nginx_ingress.sh seems to test for $ingress_entry but there's no test to prevent nginx from starting based on this same variable. Example locations follow.

    • hassio-addons/birdnet-pi/rootfs/etc/nginx/servers/ingress.conf

      Line 2 in a71764f

      listen %%interface%%:%%port%% default_server;

    • hassio-addons/birdnet-pi/rootfs/etc/nginx/servers/ingress.conf

      Lines 37 to 44 in a71764f

      	sub_filter /spectrogram %%ingress_entry%%/spectrogram;
      	sub_filter /By_Date/ %%ingress_entry%%/By_Date/;
      	sub_filter /Charts/ %%ingress_entry%%/Charts/;
      	sub_filter /todays %%ingress_entry%%/todays;
      	sub_filter href=\"/ href=\"%%ingress_entry%%/;
      	sub_filter src=\"/ src=\"%%ingress_entry%%/;
      	sub_filter hx-get=\"/ hx-get=\"%%ingress_entry%%/;
      	sub_filter action=\"/ action=\"%%ingress_entry%%/;

  • I solved by disabling nginx and using the Caddy ports directly instead.
• avahi
  • Fails to start. Have not investigated why. Temporarily solved by disabling it as I don't need its functionality.
• Services
  • I've never deployed BirdNET-Pi on a Pi so I don't know if services likst Chart Viewer, Spectrogram Viewer, Live Audio Stream, etc. are intended to start automatically on boot, but from what I can tell, they do not start automatically or if they do, there is an appreciable time delay after boot before they start. I've clicked Enable on all these to get them running as I explored the application but it has always been a manual process after boot.

[alexbelgium]

Thanks for your comment! Indeed my love docker image is currently very much linked to ha. I'll see to make an image that would support both ha and standalone building on your experience