Twarner491
2ec45b9138
Restructures the install so users run ONE command. The fork's newinstaller.sh clones this repo (instead of upstream Nachtzuster) and runs BirdNET-Pi's installer. install_services.sh symlinks the avian/ overlay into the Caddy site root, so http://birdnet.local/avian/ comes up after reboot with no Caddy config needed. Reviewer-flagged fixes: Frontend (avian/frontend/apt.js) - Switch all API paths from /api/*.json (which didn't route) to relative action-based URLs (./api/birdnet-api.php?action=recent etc.). - Fetch ./masks.json + ./dims.json relatively (were /avian/*.json). - Replace every innerHTML user-content sink with createElement + textContent + setAttribute — species labels are user-editable in BirdNET-Pi, so untrusted. - Add esc() helper for the few remaining innerHTML attribute contexts. - fetchJson throws on non-200 (was silently parsing 404 HTML as JSON). - Defensive null-check in loadMask if MASKS hasn't loaded. Backend (avian/api/*.php) - birdnet-api.php now derives DB_PATH from dirname(__DIR__, 3) so any BirdNET-Pi install user works (no hardcoded /home/birdnet). - recording/spectrogram/cutout use getenv('HOME') for the same reason. - cutout.php reworked as the canonical image resolver: bundled illustration → bundled cutout → cached rembg → fresh Wikipedia+rembg, with the binomial regex guard and atomic rename on cache write. Wikipedia URL host pinned to wikimedia.org / wikipedia.org to block SSRF. - Stale 'X-BirdNET-Proxy-Token' auth claims removed everywhere. Pregen (avian/scripts/pregen.py) - Gemini key moved from URL query to x-goog-api-key header. - Model bumped to gemini-2.5-flash-image-preview. - Bounded retry on 429 + 5xx with Retry-After honoured. - Default --sleep raised from 1s to 4s (under free-tier RPM). - Unified parser handles |/_/comma in all three input modes. - responseModalities now [TEXT, IMAGE] (was IMAGE-only). - --poses validated against POSES keys. - ASCII [ok]/[fail] markers (was ✓/✗ — Windows console crash). - Surfaces finishReason + blockReason on safety blocks. Prompt template - 'Two placeholders' typo → three. - 'warm paper' / 'transparent background' contradiction resolved. Forwarding - mqtt-bridge.py: paho-mqtt 2.x CallbackAPIVersion compat shim. - avian-mqtt.service: dropped broken %i, set User=birdnet + %h path. - forwarding/README.md uses the actual action-based URLs. README - One-line install via curl … newinstaller.sh. - No more 'install BirdNET-Pi separately' step (our fork does it). - License section uses absolute github.com links. - bird.onethreenine.net replaces the not-yet-existent project writeup. - docs/thumb.png replaced with the 24-bird Twitter capture. Removed - avian/caddy/ and avian/scripts/install.sh — no longer needed; the overlay symlink in install_services.sh handles everything.
90 lines
2.8 KiB
Markdown
90 lines
2.8 KiB
Markdown
# Optional: forwarding the collage off your local network
|
|
|
|
Default install hosts the collage at `http://birdnet.local/avian/` on
|
|
your LAN with no auth. If you want it accessible from anywhere — or
|
|
piped into Home Assistant / MQTT — pick one of the recipes below.
|
|
|
|
Each recipe is independent. Skip what you don't need.
|
|
|
|
---
|
|
|
|
## 1. Cloudflare Tunnel — public HTTPS, no port forwarding
|
|
|
|
Free Cloudflare account required.
|
|
|
|
Install `cloudflared`:
|
|
|
|
```bash
|
|
sudo apt install -y lsb-release
|
|
curl -fsSL https://pkg.cloudflare.com/cloudflare-main.gpg \
|
|
| sudo tee /usr/share/keyrings/cloudflare-main.gpg >/dev/null
|
|
echo "deb [signed-by=/usr/share/keyrings/cloudflare-main.gpg] https://pkg.cloudflare.com/cloudflared $(lsb_release -cs) main" \
|
|
| sudo tee /etc/apt/sources.list.d/cloudflared.list
|
|
sudo apt update && sudo apt install -y cloudflared
|
|
```
|
|
|
|
Authenticate + create the tunnel:
|
|
|
|
```bash
|
|
cloudflared tunnel login
|
|
cloudflared tunnel create birds
|
|
cloudflared tunnel route dns birds birds.your-domain.com
|
|
```
|
|
|
|
Configure + start the tunnel:
|
|
|
|
```bash
|
|
sudo cp ~/BirdNET-Pi/avian/forwarding/cloudflared.yml /etc/cloudflared/config.yml
|
|
# Edit /etc/cloudflared/config.yml — set `tunnel:` to your tunnel UUID
|
|
sudo cloudflared service install
|
|
sudo systemctl restart cloudflared
|
|
```
|
|
|
|
To password-protect the public URL, set up Cloudflare Access (free
|
|
tier: up to 50 users). The LAN URL stays open. If you'd rather use HTTP
|
|
Basic auth, see [`caddy-auth.caddy`](caddy-auth.caddy).
|
|
|
|
---
|
|
|
|
## 2. Home Assistant — surface latest detection as a sensor
|
|
|
|
Add to `configuration.yaml`:
|
|
|
|
```yaml
|
|
rest:
|
|
- resource: http://birdnet.local/avian/api/birdnet-api.php?action=recent&hours=1
|
|
scan_interval: 60
|
|
sensor:
|
|
- name: "Latest Bird"
|
|
value_template: "{{ value_json.species[0].com if value_json.species else 'none' }}"
|
|
json_attributes_path: "$.species[0]"
|
|
json_attributes:
|
|
- sci
|
|
- n
|
|
- last_seen
|
|
- best_conf
|
|
```
|
|
|
|
`birdnet-api.php?action=recent` already returns `species` ordered by
|
|
count desc; if you want most-recent first, replace the value_template
|
|
with a sort filter.
|
|
|
|
---
|
|
|
|
## 3. MQTT — fan out detections to other services
|
|
|
|
```bash
|
|
sudo pip3 install paho-mqtt --break-system-packages
|
|
cp ~/BirdNET-Pi/avian/forwarding/mqtt-bridge.py ~/avian-mqtt.py
|
|
# Edit ~/avian-mqtt.py — broker host, topic prefix, credentials
|
|
sudo cp ~/BirdNET-Pi/avian/forwarding/avian-mqtt.service /etc/systemd/system/
|
|
# Edit /etc/systemd/system/avian-mqtt.service — set User= to your username
|
|
sudo systemctl daemon-reload
|
|
sudo systemctl enable --now avian-mqtt
|
|
```
|
|
|
|
The bridge polls `/avian/api/birdnet-api.php?action=recent&hours=1`
|
|
once a minute and publishes new species under `birdnet/<slug>` with the
|
|
full record as a JSON payload. Dedup is in-memory only — downstream
|
|
consumers should be idempotent.
|