avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-05-28 11:24:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README_standalone.md

Browse Source
This commit is contained in:
Alexandre
2025-03-02 22:16:42 +01:00
committed by GitHub
parent 8e0cbf4fa6
commit 4e4f28d739
1 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
birdnet-pi/README_standalone.md
View File

@@ -2,6 +2,8 @@
This guide provides instructions on how to install and run the BirdNET-Pi container using Docker Compose without dependency on HomeAssistant. This guide provides instructions on how to install and run the BirdNET-Pi container using Docker Compose without dependency on HomeAssistant.
Thanks to @gotschi for the initial Docker Compose
## Prerequisites ## Prerequisites
Ensure you have the following installed on your system: Ensure you have the following installed on your system:
@@ -23,6 +25,8 @@ Ensure you have the following installed on your system:
Copy and paste the following configuration: Copy and paste the following configuration:
```yaml ```yaml
version: '3.8'
services: services:
birdnet-pi: birdnet-pi:
container_name: birdnet-pi container_name: birdnet-pi
@@ -32,20 +36,20 @@ Ensure you have the following installed on your system:
- "8001:8081" # Used to access WebUI - "8001:8081" # Used to access WebUI
- "80:80" # Optional: set to 80 to use Caddy's automatic SSL. Can otherwise be set to null to avoid opening an additional port - "80:80" # Optional: set to 80 to use Caddy's automatic SSL. Can otherwise be set to null to avoid opening an additional port
environment: environment:
- TZ=Europe/Vienna # Optional, for timezone setting - TZ=Europe/Vienna # Optional: Set your timezone
- BIRDSONGS_FOLDER=/config/BirdSongs # Where songs are stored - BIRDSONGS_FOLDER=/config/BirdSongs # Folder to store bird songs
- LIVESTREAM_BOOT_ENABLED=false # If true - LIVESTREAM_BOOT_ENABLED=false # Enable/disable livestream on boot
- ssl=false # In lowercase - ssl=false # Enable/disable SSL
- certfile=fullchain.pem # Should be located in /ssl/ to use external certificates - certfile=fullchain.pem # SSL certificate file (located in /ssl/)
- keyfile=privkey.pem # Should be located in /ssl/ to use external certificates - keyfile=privkey.pem # SSL key file (located in /ssl/)
- pi_password= # Optional, set the user password in SSH - pi_password= # Optional: Set SSH user password
- MQTT_HOST_manual= # Optional, allows automatic MQTT - MQTT_HOST_manual= # Optional: Manual MQTT host
- MQTT_PASSWORD_manual= # Optional, allows automatic MQTT - MQTT_PASSWORD_manual= # Optional: Manual MQTT password
- MQTT_PORT_manual= # Optional, allows automatic MQTT - MQTT_PORT_manual= # Optional: Manual MQTT port
- MQTT_USER_manual= # Optional, allows automatic MQTT - MQTT_USER_manual= # Optional: Manual MQTT user
volumes: volumes:
- ./config:/config - ./config:/config # Configuration files
- ./ssl:/ssl - ./ssl:/ssl # SSL certificates
- /dev/shm:/dev/shm # Shared memory - /dev/shm:/dev/shm # Shared memory
``` ```