🐙 Octofleet

Open-source endpoint management platform
Monitor your fleet, deploy software, track vulnerabilities, manage patches, and control devices from a single dashboard.

Quick Start • Features • Documentation • Contributing • Roadmap

🎯 Why Octofleet?

• 🚀 5-Minute Setup — Docker Compose up and you're running
• 💯 100% Self-Hosted — Your data stays on your infrastructure
• 🔓 Fully Open Source — No license fees, no vendor lock-in
• 🪶 Lightweight Agents — < 20MB footprint, minimal resource usage
• 🔌 API-First — 509 endpoints accessible via REST API
• 🌐 Cross-Platform — Windows and Linux support
• 🌙 Dark Mode — Full dark mode across all pages

✨ Features

🚀 Quick Start

Option 1: Docker (Recommended)

git clone https://github.com/BenediktSchackenberg/octofleet.git
cd octofleet
docker compose up -d

Open http://localhost:3000 — Login: admin / admin

Option 2: Install Agent

Windows (PowerShell as Admin — one-liner):

irm https://github.com/BenediktSchackenberg/octofleet/releases/latest/download/Install-OctofleetAgent.ps1 | iex

Then configure C:\ProgramData\Octofleet\service-config.json:

{
  "InventoryApiUrl": "http://your-server:8080",
  "InventoryApiKey": "your-api-key",
  "GatewayUrl": "http://your-server:18789",
  "GatewayToken": "your-gateway-token",
  "DisplayName": "MY-SERVER",
  "AutoPushInventory": true,
  "ScheduledPushEnabled": true,
  "ScheduledPushIntervalMinutes": 30
}

Restart the service after config changes:

Restart-Service OctofleetNodeAgent

Linux:

API_URL="http://your-server:8080" API_KEY="your-api-key" \
  curl -sSL https://raw.githubusercontent.com/BenediktSchackenberg/octofleet/main/linux-agent/install.sh | sudo -E bash

Then configure /opt/octofleet-agent/config.env:

API_URL="http://your-server:8080"
API_KEY="your-api-key"

📖 Full Agent Setup Guide → · Installation Wiki →

🏗️ Architecture

┌─────────────────────────────────────────────────────────────┐
│                        Frontend                              │
│                    (Next.js + React)                        │
│                     localhost:3000                          │
└─────────────────────┬───────────────────────────────────────┘
                      │ REST API
┌─────────────────────▼───────────────────────────────────────┐
│                        Backend                               │
│            (FastAPI + Python 3.12 — 22 Routers)            │
│              509 endpoints · localhost:8080                 │
└─────────────────────┬───────────────────────────────────────┘
                      │ SQL
┌─────────────────────▼───────────────────────────────────────┐
│                       Database                               │
│               (PostgreSQL 16 + TimescaleDB)                 │
│                     localhost:5432                          │
└─────────────────────────────────────────────────────────────┘

         ┌──────────┐  ┌──────────┐  ┌──────────┐
         │ Windows  │  │ Windows  │  │  Linux   │
         │  Agent   │  │  Agent   │  │  Agent   │
         │ (.NET 8) │  │ (.NET 8) │  │  (Bash)  │
         └────┬─────┘  └────┬─────┘  └────┬─────┘
              │             │             │
              └─────────────┴─────────────┘
                    HTTPS to Backend

📚 Documentation

🔌 API Endpoints (~450 total)

The backend exposes a full REST API with automatic OpenAPI documentation:

# Interactive API docs (Swagger UI)
open http://localhost:8080/docs

# Alternative: ReDoc
open http://localhost:8080/redoc

# OpenAPI JSON spec
curl http://localhost:8080/openapi.json

Key Endpoint Groups: | Category | Endpoints | Description | |----------|-----------|-------------| | /api/v1/nodes | 15 | Node inventory, search, tree view | | /api/v1/inventory/* | 17 | Hardware, software, hotfixes, security | | /api/v1/jobs | 10 | Job creation, scheduling, results | | /api/v1/packages | 12 | Package management, winget/choco | | /api/v1/vulnerabilities | 6 | CVE tracking, suppression | | /api/v1/remediation | 23 | Auto-remediation, health checks | | /api/v1/services | 10 | Service orchestration | | /api/v1/deployments | 8 | Software deployment | | /api/v1/patches | 20 | Patch catalog, rings, deployments, compliance | | /api/v1/patches/explorer | 10 | Patch Explorer tree, deploy, SSE stream, verify, history | | /api/v1/baselines | ~25 | Config baselines, rules, evaluations, drift, templates, remediation | | /api/v1/content | 22 | Content repos, items, snapshots, environments, promotion | | /api/v1/query | 4 | Query engine (execute, schema, templates, live) | | /api/v1/metering | ~20 | Software catalog, licenses, compliance, reclamation | | /api/v1/hardware | 2 | Hardware fleet aggregation & export | | /api/v1/security/* | 34 | Security monitoring, events, findings, evidence, audit |

🛠️ Development

# Backend (FastAPI)
cd backend && python -m venv venv && source venv/bin/activate
pip install -r requirements.txt
uvicorn main:app --reload --port 8080

# Frontend (Next.js)
cd frontend && npm install && npm run dev

# Windows Agent (.NET 8)
cd src/OctofleetAgent.Service && dotnet run

# Run Tests
cd tests/api && pytest
cd tests/e2e && npx playwright test

⚙️ Configuration

Environment Variables

ℹ️ The backend reads API_KEY from the environment (with fallback to INVENTORY_API_KEY for backward compatibility). Use API_KEY for new deployments.

📖 Full Configuration Reference →

🤝 Contributing

We love contributions! Octofleet is built by the community, for the community.

🌟 First time? Check out issues labeled good first issue

📖 Read the Contributing Guide for setup instructions and guidelines.

Ways to Contribute

• 🐛 Report bugs and request features
• 📝 Improve documentation
• 💻 Submit pull requests
• 🌍 Translate to other languages
• ⭐ Star the repo to show support!

🗺️ Roadmap

See the Enterprise Roadmap and public roadmap for planned features.

✅ Completed in v0.6.0

• E30 Patch & Update Orchestration
• E31 Configuration Baselines & Drift Management
• E33 Content Repository & Lifecycle Management
• E34 Real-time Query Engine
• E38 Software Metering & License Tracking
• E42 Patch Explorer — Tree-based fleet update management with live progress & verification

🔜 Upcoming

• macOS Agent
• LDAP/Active Directory & SSO/OIDC integration
• Ansible/DSC integration
• Cloud provider integration (Azure, AWS, Proxmox)
• Multi-tenancy
• High Availability

View Full Roadmap →

📄 License

MIT License — see LICENSE for details.

🙏 Acknowledgments

Built with FastAPI, Next.js, .NET 8, TimescaleDB

Vulnerability data from NVD • Icons by Lucide

🐙 Reach every endpoint in your fleet

⭐ Star us on GitHub · 🐛 Report Bug · 💡 Request Feature