Skip to content

INSTALLATION.md

Latest commit

 

History

History
131 lines (86 loc) · 2.41 KB

INSTALLATION.md

File metadata and controls

131 lines (86 loc) · 2.41 KB

BirdNET-PiPy Installation Guide

Table of Contents

Prerequisites

Hardware

Component Requirement
Raspberry Pi Model 4 or newer (Pi 5 recommended), 2GB+ RAM
Storage 128GB+ SD card (V30) or NVMe SSD
Microphone USB microphone

Software

  • OS: Raspberry Pi OS or Raspberry Pi OS Lite (64-bit, Bookworm+)

Installed Components

The installer automatically sets up:

  • Git
  • PulseAudio (system-wide on Lite)
  • Docker
  • BirdNET-PiPy containers
  • Systemd service for auto-start

Quick Install

Run this command to install BirdNET-PiPy:

curl -fsSL https://raw.githubusercontent.com/Suncuss/BirdNET-PiPy/main/install.sh | sudo bash

Installation time: 10–30 minutes depending on hardware and network speed.

Review Script First

curl -fsSL https://raw.githubusercontent.com/Suncuss/BirdNET-PiPy/main/install.sh > install.sh
less install.sh
sudo bash install.sh

Post-Installation

The system reboots automatically after installation.

Verify Installation

Check that the service is running:

sudo systemctl status birdnet-pipy

You should see active (running) in the output.

View system service logs:

journalctl -u birdnet-pipy -f

Microphone Volume

To adjust your microphone gain, run the ALSA mixer from the terminal:

alsamixer
  • Press F6 to select your USB sound card
  • Press F4 to switch to the Capture view
  • Use the arrow keys to adjust the volume
  • Press Esc to exit

Changes take effect immediately — no restart required.

Troubleshooting & Advanced Config

For detailed logs, advanced configuration, and architecture details, see the System Administration Guide.

Web Interface

Access the dashboard from any device on the same network:

Using hostname (mDNS):

http://<hostname>.local

For example, if your Pi's hostname is raspberrypi, use http://raspberrypi.local

Using IP address:

http://<ip-address>

Find your Pi's IP by running hostname -I on the Pi.

From the Pi directly:

http://localhost

Uninstallation

To remove BirdNET-PiPy:

cd ~/BirdNET-PiPy
./uninstall.sh

Enjoy BirdNET-PiPy!