Home

BirdNET-Go Documentation

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

• 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

Advanced Features

• 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

• 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

Troubleshooting & Support

• Docker Troubleshooting - Resolving common Docker issues
• Support Script - Generating diagnostic information
• Reporting Issues - How to effectively report bugs

Reference

• 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