nannyapi

NannyAPI

NannyAPI is the central control plane for Nanny Agents. It handles agent registration, authentication, investigation orchestration, and patch management.

Documentation

We have reorganized our documentation to help you get started quickly.

• Quick Start: Get started in 5 minutes.
• Installation Guide: Instructions for Docker, binary installation, systemd services, and building from source.
• Deployment Guide: Production deployment, configuration, monitoring, security hardening, and troubleshooting.
• Architecture: System components, authentication flows, database schema, AI integration (TensorZero), and observability (ClickHouse).
• API Reference: Complete API documentation with all endpoints, request/response examples, and authentication.
• Patch Management: Automated patching workflow, script verification, exception handling, and dry-run mode.
• Proxmox Integration: Agentless LXC container management and Proxmox VE support.
• Security Policy: Reporting vulnerabilities and AI safety.
• Contributing: Development setup, guidelines, and contributor information.

Quick Start

Docker (Recommended)

# Create data directory for persistence
mkdir -p ./pb_data

# Run NannyAPI
docker run -d \
  --name nannyapi \
  -p 8090:8090 \
  -v $(pwd)/pb_data:/app/pb_data \
  docker.io/nannyagent/nannyapi:latest

⚠️ Important: NannyAPI uses SQLite. You must mount /app/pb_data to persist data. See Installation Guide for details.

Binary Installation (Linux)

curl -sL https://raw.githubusercontent.com/nannyagent/nannyapi/main/install.sh | sudo bash