Documentation Site
The documentation site is an optional component that serves the BirdNET-NG docs as a browsable website using Express and markdown-it.
Docker Deployment
The docs site is included in the standard docker-compose.yml stack as the docs container. It runs automatically alongside the hub.
No additional configuration is needed beyond setting the FQDN.
Configuration
Set the documentation site FQDN in your .env file:
BNG_DOCS_FQDN=docs.birdnet.example.com
Traefik routes HTTPS traffic for this FQDN to the docs container automatically via Docker labels in docker-compose.yml.
Standalone Deployment
The docs site can also be run independently:
cd docs
npm install
node server.js
By default it listens on port 80 (configurable via the PORT environment variable).