octofleet - 🐙 Open-source endpoint management platform — inven

项目说明

🐙 Octofleet

<p align="center">
<img src="docs/images/octofleet-logo-v3.png" alt="Octofleet Banner" width="800">
</p>

<p align="center">
<b>Open-source endpoint management platform</b><br>
Monitor your fleet, deploy software, track , manage patches, and control devices from a single dashboard.
</p>

<p align="center">
<a href=" src=" alt="Release"></a>
<a href="LICENSE"><img src=" alt="License"></a>
<a href=" src=" alt="Stars"></a>
<a href=" src=" alt="Issues"></a>
<a href=" src=" alt="Tests"></a>
</p>

<p align="center">
<a href="#-quick-start">Quick Start</a> •
<a href="#-features">Features</a> •
<a href="../../wiki">Documentation</a> •
<a href="#-contributing">Contributing</a> •
<a href="../../wiki/Roadmap">Roadmap</a>
</p>

---

🎯 Why Octofleet?

---

✨ Features

<table>
<tr>
<td width="50%">

📊 In & Monitoring

</td>
<td width="50%">

🚀 Deployment & Jobs

</td>
</tr>
<tr>
<td width="50%">

🔐 Security & Compliance

</td>
<td width="50%">

🩹 Patch & Update Management

</td>
</tr>
<tr>
<td width="50%">

📐 Configuration Baselines — NEW in v0.6.0!

</td>
<td width="50%">

📦 Content Lifecycle — NEW in v0.6.0!

</td>
</tr>
<tr>
<td width="50%">

🔍 Real-time Query Engine — NEW in v0.6.0!

</td>
<td width="50%">

📊 Software Metering & Licenses — NEW in v0.6.0!

</td>
</tr>
<tr>
<td width="50%">

🖥️ Remote Access & UX

</td>
<td width="50%">

🔌 Zero-Touch Pro

</td>
</tr>
<tr>
<td width="50%">

🗄️ SQL Ser

</td>
<td width="50%">

🔄 Self-Updating Agents

</td>
</tr>
<tr>
<td width="50%">

📊 Reports & Exports

</td>
<td width="50%">

🏗️ Hardware Fleet Dashboard

</td>
</tr>
</table>

---

🚀 Quick Start

Option 1: Docker (Recommended)

Open — Login: admin / admin

Option 2: Install Agent

Windows (PowerShell as Admin — one-liner):

Then configure C:\ProgramData\Octofleet\ser.json:

| Field | Description | Required |
|-------|-------------|----------|
| In | Backend API URL (port 8080) | Yes |
| In | API key for authentication | Yes |
| GatewayUrl | Gateway URL for remote access (port 18789) | No |
| GatewayToken | Gateway auth token | No |
| DisplayName | Node display name in UI | No (defaults to hostname) |

Restart the service after config changes:

Linux:

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

📖 Full Agent Setup Guide → · Installation Wiki →

---

🏗️ Architecture

---

📚 Documentation

| Topic | Link |
|-------|------|
| Quick Start | docs/GETTING-STARTED.md |
| Architecture | docs/ARCHITECTURE.md |
| Configuration | docs/CONFIGURATION.md |
| API Reference | docs/API-REFERENCE.md • Swagger UI |
| Security Center | docs/SECURITY-CENTER.md |
| Patch Management | docs/PATCH-MANAGEMENT.md |
| Content Lifecycle | docs/CONTENT-LIFECYCLE.md |
| Query Engine | docs/QUERY-ENGINE.md |
| Software Metering | docs/SOFTWARE-METERING.md |
| Agent Setup | docs/AGENT-SETUP.md |
| Roadmap | docs/ROADMAP-ENTERPRISE.md |

🔌 API Endpoints (~450 total)

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

Key Endpoint Groups:
| Category | Endpoints | Description |
|----------|-----------|-------------|
| /api/v1/nodes | 15 | Node in, search, tree view |
| /api/v1/in/* | 17 | Hardware, software, hotfixes, security |
| /api/v1/jobs | 10 | Job creation, scheduling, results |
| /api/v1/packages | 12 | Package management, winget/choco |
| /api/v1/ | 6 | C, 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, , history |
| /api/v1/baselines | ~25 | Config baselines, rules, e, drift, templates, remediation |
| /api/v1/content | 22 | Content repos, items, snapshots, en, 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, e, audit |

---

🛠️ De

---

⚙️ Configuration

En

| | Default | Description |
|----------|---------|-------------|
| API_KEY | octofleet-in | API key for agent authentication |
| DATABASE_URL | postgresql://octofleet:...@127.0.0.1:5432/in | PostgreSQL connection string |
| JWT_SECRET | Auto-generated | Secret for JWT tokens (persistent) |
| N | None | NVD API key for scanning |
| OCTOFLEET_GATEWAY_URL | | Octofleet gateway URL |
| OCTOFLEET_GATEWAY_TOKEN | Empty | Token for gateway authentication |

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

📖 Full Configuration Reference →

---

🤝 Contributing

We lo! 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

---

🗺️ Roadmap

See the Enterprise Roadmap and public roadmap for planned features.

✅ Completed in v0.6.0

🔜 Upcoming

View Full Roadmap →

---

📄 License

MIT License — see LICENSE for details.

---

🙏 Acknowledgments

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

data from NVD • Icons by Lucide

---

<p align="center">
<b>🐙 Reach every endpoint in your fleet</b><br><br>
<a href=" Star us on GitHub</a> ·
<a href="../../issues/new">🐛 Report Bug</a> ·
<a href="../../issues/new">💡 Request Feature</a>
</p>

项目信息

开发语言：TypeScript

Star 数：23

技术要点

该项目属于安全软件方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕🐙 Open-source endpoint management platform — inventory, patching, live monitoring for Windows & Linux展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。