Home

BirdNET-Go Documentation

This page is generated. It is published automatically from doc/wiki/index.md in the BirdNET-Go repository. Do not edit it here; changes are overwritten on the next sync. To propose a change, open a pull request against the source file.

Welcome to the BirdNET-Go documentation. This index will help you navigate through all available resources for installing, configuring, and using BirdNET-Go.

Getting Started

• Frequently Asked Questions - Common questions, problems, and quick fixes
• BirdNET-Go Guide - Overview and basic concepts
• Installation Guide - Comprehensive installation instructions for all methods
• Recommended Hardware - Hardware recommendations for optimal performance

Installation Methods

• Docker Installation (Linux) - Using the automated install.sh script
• Docker Compose Installation - Setting up BirdNET-Go with Docker Compose
• Manual Docker Installation - Advanced Docker setup
• Manual Binary Installation - Windows, macOS, and Linux binary installation

Note: Docker images are available from both GitHub Container Registry and Docker Hub.

Advanced Features

• External Media (USB, SD, File Shares) - Mounting removable and network storage for import and backup
• Detection Pipeline Architecture - How audio flows through multi-model inference, filtering, and action dispatch
• ONNX Runtime Installation - Installing the default inference backend library for native/binary installs
• OpenVINO Acceleration - Enabling Intel iGPU offload and OpenVINO CPU acceleration on containers and native installs
• BirdNET Detection Pipeline - Understanding how settings affect detections
• BirdNET Range Filter - Location and time-based species filtering
• Web Dashboard - Using the visualization dashboard
• Remote Internet Access - Exposing BirdNET-Go to the internet securely
• Weather Integration - Connecting to weather data providers
• Audio Processing - Advanced audio processing capabilities
• Deep Detection - Improving detection reliability
• Live Audio Streaming - Streaming audio from the web interface
• Species-Specific Settings - Customized detection rules for specific species

Integration & Security

• Push Notifications - Discord, Telegram, Slack, and 20+ services
• Discord Setup Guide - Step-by-step Discord webhook configuration with rich embeds
• MQTT Integration - Connecting to IoT systems
• BirdWeather API - Sharing data with BirdWeather.com
• Authentication - Securing your BirdNET-Go instance
• Cloudflare Tunnel Setup - Detailed guide for secure internet access

Privacy & Telemetry

• Error Tracking & Telemetry - Optional privacy-first error tracking system
• Privacy & Data Collection - Detailed privacy information and data protection
• Telemetry Setup Guide - Step-by-step configuration instructions

Troubleshooting & Support

• Frequently Asked Questions - Common questions, problems, and quick fixes
• RTSP Troubleshooting - Comprehensive guide for RTSP camera issues and configuration
• Docker Troubleshooting - Resolving common Docker issues
• Support Script - Generating diagnostic information
• Reporting Issues - How to effectively report bugs

Reference

• Configuration Reference - Complete reference of every config.yaml setting with types and descriptions (auto-generated from source)
• Non-Bird Species List - Complete list of non-bird species detected by BirdNET
• Command Line Interface - Available commands and options
• Detection Pipeline Flow - How settings interact and affect detection results
• Range Filter Commands - CLI commands for inspecting range filter results
• Supported Languages - Language options for species labels
• Log Rotation - Managing log files