BirdNET-Go
Realtime soundscape analyser for birds, wildlife, and bats.
Self-hosted, 24/7, local AI inference. BirdNET-Go ingests soundcard input or network audio streams, runs multi-model classification, and presents detections in a fast web UI. Runs on a Raspberry Pi.
Highlights
- Multi-model AI gallery: install BirdNET v2.4, Google Perch v2, BattyBirdNET regional bat classifiers, and the BirdNET Geomodel v3.0 from inside the app, no rebuild needed.
- Run multiple models in parallel against separate audio sources and let cross-model agreement boost confidence on shared detections.
- Live spectrogram streaming and detection heatmaps rendered straight in the browser.
- Alert rules engine that routes detections to Discord, Slack, Telegram, ntfy, Pushover, Gotify, Matrix, webhooks, browser push, MQTT (with Home Assistant discovery), shell scripts, and BirdWeather.
- Production-ready ops: onboarding wizard, OIDC/SSO, TLS certificate management, hot-reload settings, system health page, database doctor, and one-click support dumps.
- Installable as a PWA, with a multilingual UI and species names in 40+ languages.
- Local-only by default. Optional Sentry telemetry is strictly opt-in.
Quick install
Debian, Ubuntu, and Raspberry Pi OS:
curl -fsSL https://github.com/tphakala/birdnet-go/raw/main/install.sh -o install.sh
bash ./install.sh
Docker Compose, Portainer, Unraid and plain docker run users should start from the host-network configurations described in the installation guide (Portainer: the BirdNET-Go (host network, recommended) template or the stack file Docker/docker-compose.host.yml, see the Docker Compose guide; Unraid: the Unraid README); the bridge configurations remain supported. The Unraid host template is untested on real Unraid.
Docker images are published for linux/amd64 and linux/arm64. Pre-built binaries for Linux, Windows, and macOS ship with each release. See the installation guide, hardware recommendations, and security guide for details.
Web Dashboard
Features
Detection
- BirdNET v2.4 (default, embedded, 6,500+ bird species)
- Google Perch v2 via ONNX (14,795 species across birds, insects, amphibians, and mammals) with taxonomy-based species names
- BattyBirdNET bat classifiers, 11 regional models covering Africa, the Americas, East Asia, Europe, the Middle East, South Asia, Southeast Asia, and the USA (Linux + ultrasonic-capable device)
- BirdNET Geomodel v3.0 for location-based range filtering (12,012 species)
- Cross-model detection consensus: agreement between models strengthens confidence and flags disagreements for review
- Custom classifiers: bring your own TFLite model and label set
- Configurable false-positive filtering for accurate results: Deep Detection (repeat-confirmation within a 15-second window), per-species dynamic thresholds, location-based range filter, privacy and dog-bark filters, and per-classifier bat false-positive levels (guide)
- Per-model and per-source confidence thresholds
- Soundcard capture and RTSP / RTSPS streams, including multiple sources in parallel with independent model assignment
- Sample rates up to 256 kHz for ultrasonic bat detection
- Audio liveness watchdog with tiered recovery for flaky streams
- Stream sample-rate probing and per-model recommendation banners in the UI
- Audio equalizer, per-source quiet hours, daylight filter, and extended capture mode
- Offline analysis of audio files
Interface
- Svelte 5 + TypeScript single-page app
- Installable as a Progressive Web App (PWA)
- Onboarding wizard for first-run setup
- Live spectrogram visualization for active streams (live audio streaming)
- Detection heatmaps with ONNX-accelerated rendering
- Customizable dashboard layout, color schemes, and a “Currently Hearing” card
- Multiselect and bulk actions on the detections list
- Browser terminal (xterm.js over WebSocket PTY) for in-app administration
- UI languages: English, German, French, Spanish, Portuguese, Dutch, Polish, Italian, Czech, Slovak, Hungarian, Finnish, Swedish, Danish, Norwegian (Bokmål), Latvian
- Species names in 40+ languages
Alerts and integrations
- Configurable alert rules engine with per-rule conditions, schedules, and delivery targets
- Multi-target delivery via shoutrrr: Discord, Slack, Telegram, ntfy, Pushover, Gotify, Matrix, Bark, IFTTT, and more
- Webhooks with custom templates, shell-script hooks, and browser push notifications
- MQTT publishing with Home Assistant auto-discovery
- BirdWeather.com API integration
- Prometheus metrics endpoint
- Live spectrogram and realtime log output for OBS overlays on bird-feeder streams
Storage and data
- SQLite (default) or MySQL/MariaDB with retry-aware write paths for contention;
only the tested LTS releases are supported (MySQL 8.4 and 9.7; MariaDB 10.11,
11.4, 11.8 or 12.3), and MySQL Innovation releases are not supported
- Automatic backups with real-time status polling
- Format-aware audio clip export
- Embedded eBird/Clements taxonomy (2,374 genera, 254 families, 11,145 species) for fast offline lookups
Operations
- System Health diagnostics page covering audio pipeline, models and inference, network, and the datastore
- Database doctor for diagnosis and schema repair
- Help & Support page with guided bug reporting and one-click support dumps
- OIDC / SSO with Google, GitHub, and generic providers, including RP-Initiated Logout
- TLS certificate management UI with transactional writes and backup/restore
- Hot-reload for settings, model installs, and per-source model assignments (no restart)
- Optional, opt-in Sentry telemetry with strict privacy filtering
- Linux, Windows, and macOS
- Single static binary with the BirdNET TFLite model embedded
- Optional ONNX Runtime for Perch, BattyBirdNET, and BirdNET Geomodel v3.0 (install guide)
- Multi-arch Docker images
- Runs comfortably on a Raspberry Pi 4 or equivalent 64-bit single-board computer
Documentation
Development setup
See CONTRIBUTING.md for the full guide.
git clone https://github.com/tphakala/birdnet-go.git
cd birdnet-go
# Install Task (if not already installed)
# Linux: sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
# macOS: brew install go-task
task setup-dev # installs Go 1.25, Node LTS, build tools, linters, Playwright
task # build
task dev_server # hot-reload dev server (or: air realtime)
Join the Discord server for support, discussions, and updates.
Core and extensions
- birda: fast CLI for offline bird species detection on existing audio files, using BirdNET and Perch AI models
- birda-gui: desktop GUI for birda (Electron + Svelte 5) for audio analysis, detection browsing, and species visualization
System integration
- BirdNET-Pi2Go: database converter for migrating from BirdNET-Pi (deprecated, not compatible with the current BirdNET-Go database schema; a native import is planned)
Hardware solutions
Mobile apps
- Perch: open-source Android/iOS companion app. Connects to BirdNET-Go via the BirdWeather API. Live detection feed, audio playback, species browser, 14-day chart, and notifications for favourite species. MIT licensed.
- BirdFeeder: open-source Android streaming app. Publishes real-time RTSP audio for consumption as a BirdNET-GO stream.
Contributing
Contributions are welcome.
For setup, workflow, and quality gates, see CONTRIBUTING.md:
All contributions must follow privacy-by-design principles, the automated code-quality gates, and the CC BY-NC-SA 4.0 license terms.
Data sources
Taxonomy data
BirdNET-Go embeds taxonomy data derived from the eBird/Clements Checklist:
- Source: eBird API v2
- Copyright: © Cornell Lab of Ornithology
- License: used under eBird API Terms of Use for non-commercial purposes
- Attribution: taxonomy data powered by eBird.org
- Coverage: 2,374 genera, 254 families, 11,145 species
For more information, see the eBird Taxonomy.
License
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.
Authors and acknowledgements
Created and maintained by Tomi P. Hakala.
A growing list of community contributors keeps the project moving forward. The current list lives on the GitHub contributors page.
The BirdNET AI model is by the K. Lisa Yang Center for Conservation Bioacoustics at the Cornell Lab of Ornithology in collaboration with Chemnitz University of Technology (Stefan Kahl, Connor Wood, Maximilian Eibl, Holger Klinck).
Google Perch v2 ONNX conversion by Justin Chuby. BattyBirdNET bat classifier models by R.D. Zinck. BirdNET label translations by Patrick Levin for the BirdNET-Pi project by Patrick McGuire.
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)
评论