BossAgentsLRAgent 开源与开放平台文档
所有开源策略、开放平台、企业模块、桌面客户端、数据库管理相关文档的统一入口。
一、开源策略
| 文档 | 说明 |
|---|---|
| OPEN-SOURCE-STRATEGY.md | 完整开源策略方案（11章）：品牌定位、许可证选择、社区建设、商业化路径 |
| OPEN-CORE-MAP.md | 开源/闭源边界清单：哪些模块 MIT，哪些 BSL 1.1 |
| LICENSE | MIT 许可证全文（核心框架） |
| LICENSE-ENTERPRISE.md | BSL 1.1 许可证全文（企业模块） |
| CONTRIBUTING.md | 贡献指南：代码规范、PR 流程、行为准则 |
| SECURITY.md | 安全策略：漏洞报告流程、支持版本 |
二、企业模块
| 文档 | 说明 |
|---|---|
| ENTERPRISE-README.md | 企业模块目录说明：BSL 1.1 授权、安装方式 |
| install-enterprise-reference.js | 企业模块安装脚本（参考副本，源文件 enterprise/install-enterprise.js） |
| enterprise-loader-reference.js | 企业模块动态加载器（参考副本，源文件 server/enterprise-loader.js） |
| feature-flags.json | 功能开关配置：社区版/企业版特性控制 |
三、开放平台
| 文档 | 说明 |
|------|------|
| api-docs-reference.html | 开放平台 API 文档页面（参考副本，源文件 server/public/api-docs.html） |
在线访问：https://ylxt.chat/api-docs 或 http://localhost:3006/api-docs
API 端点概览：
| 端点 | 说明 |
|------|------|
| POST /api/open-platform/keys | 创建 API Key（lr_ 前缀） |
| GET /api/open-platform/keys | 列出所有 Key |
| DELETE /api/open-platform/keys/:keyId | 吊销 Key |
| GET /api/open-platform/usage | 查询用量统计 |
| GET /api/platform/databases | 数据库列表 |
| GET /api/platform/databases/:name/download | 数据库文件下载 |
| GET /api/platform/databases/:name/tables | 数据库表结构 |
四、OSS 同步（私有库 → 公开 GitHub）
| 文档 | 说明 |
|------|------|
| ossignore.md | 同步排除清单（119 条规则，源文件 .ossignore） |
| oss-sync-reference.js | 同步脚本（参考副本，源文件 scripts/oss-sync.js） |
GitHub 仓库：https://github.com/andyy1976/lragent
同步流程：
私有库（BossAgents）→ oss-sync.js 读取 .ossignore → 过滤企业模块/敏感文件 → 推送到公开库
五、桌面客户端
| 文档 | 说明 |
|------|------|
| desktop-client.md | Electron 桌面客户端完整文档：架构、打包、API |
六、数据库管理
| 文档 | 说明 |
|---|---|
| database-manager.md | 数据库管理组件实现文档：三层架构、远端部署要求、安全设计 |
源文件位置对照表
| 本目录文件 | 项目源位置 | 备注 |
|-----------|-----------|------|
| LICENSE | /LICENSE | 根目录保留原件（GitHub 识别） |
| LICENSE-ENTERPRISE.md | /LICENSE-ENTERPRISE | 根目录保留原件 |
| CONTRIBUTING.md | /CONTRIBUTING.md | 根目录保留原件（GitHub 识别） |
| SECURITY.md | /SECURITY.md | 根目录保留原件（GitHub 识别） |
| OPEN-SOURCE-STRATEGY.md | /OPEN-SOURCE-STRATEGY.md | 根目录保留原件 |
| OPEN-CORE-MAP.md | /OPEN-CORE-MAP.md | 根目录保留原件 |
| feature-flags.json | /feature-flags.json | 根目录保留原件 |
| ossignore.md | /.ossignore | 根目录保留原件 |
| oss-sync-reference.js | /scripts/oss-sync.js | 参考副本 |
| enterprise-loader-reference.js | /server/enterprise-loader.js | 参考副本 |
| ENTERPRISE-README.md | /enterprise/README.md | 参考副本 |
| install-enterprise-reference.js | /enterprise/install-enterprise.js | 参考副本 |
| api-docs-reference.html | /server/public/api-docs.html | 参考副本 |
| desktop-client.md | /docs/desktop-client.md | 原位置保留 |
| database-manager.md | /docs/database-manager.md | 原位置保留 |
注意：根目录的 LICENSE、CONTRIBUTING.md、SECURITY.md 等 GitHub 标准文件必须保留在根目录，GitHub 会自动识别。本目录的副本方便集中查阅。
