update branch
This commit is contained in:
256
README.md
256
README.md
@@ -1,199 +1,113 @@
|
||||
# FutureOSS v1.1.0 Security All-in-One Edition
|
||||
|
||||
<div align="center">
|
||||
<img src="static/banner.svg" alt="FutureOSS Banner" width="100%" />
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
**面向未来的企业级插件化运行时框架**
|
||||
*安全 · 极简 · 全能 · 多语言*
|
||||
|
||||
[文档](#) | [下载](#) | [社区](#)
|
||||
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://gitee.com/starlight-apk/feature-oss"><img src="https://img.shields.io/badge/Gitee-代码仓库-C71D23?logo=gitee" alt="Gitee"></a>
|
||||
<a href="https://gitee.com/starlight-apk/feature-oss/wikis"><img src="https://img.shields.io/badge/文档-Wiki-4285F4?logo=readthedocs" alt="Wiki"></a>
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/许可证-Apache%202.0-green?logo=apache" alt="License"></a>
|
||||
<img src="https://img.shields.io/badge/Python-3.10+-3776AB?logo=python" alt="Python">
|
||||
</p>
|
||||
---
|
||||
|
||||
## 🚀 核心特性 (v1.1.0)
|
||||
|
||||
### 🛡️ 极致安全架构
|
||||
- **进程级隔离**: 摒弃传统沙箱,采用 `ProcessIsolatedLoader` 确保第三方插件在独立进程运行,杜绝逃逸风险。
|
||||
- **动态防火墙**: 内置状态检测防火墙,支持规则热加载。
|
||||
- **统一审计**: 全链路操作日志记录与异常行为熔断机制。
|
||||
|
||||
### 🌐 全栈多语言支持
|
||||
- **原生编排**: 一键部署 Python, Node.js, Go, Java, PHP 项目。
|
||||
- **环境自治**: 自动检测运行时依赖,隔离环境配置。
|
||||
|
||||
### 🔧 企业运维套件
|
||||
- **内网穿透**: 集成 FRP 客户端,可视化配置隧道。
|
||||
- **文件服务**: 高性能 FTP/SFTP 服务器,支持断点续传。
|
||||
- **自动化**: 定时备份、健康检查、故障自愈。
|
||||
|
||||
### 🎨 现代简约 WebUI
|
||||
- **零依赖**: 纯 HTML5/CSS3/JS,无构建步骤,秒级加载。
|
||||
- **响应式**: 完美适配 Desktop/Tablet/Mobile。
|
||||
- **极简主义**: 专注内容本身,去除视觉干扰。
|
||||
|
||||
---
|
||||
|
||||
## 🎯 项目简介
|
||||
## 🏗️ 系统架构
|
||||
|
||||
**FutureOSS** 是一款面向开发者的插件化运行时框架,秉承「**一切皆为插件**」的设计理念,让功能扩展变得前所未有的简单。
|
||||
|
||||
> 💡 无论是构建微服务、开发工具链,还是搭建可扩展的业务系统,FutureOSS 都能为你提供轻量、安全、灵活的底层支撑。
|
||||
```mermaid
|
||||
graph TD
|
||||
User[用户/客户端] --> Gateway[统一安全网关]
|
||||
Gateway --> Core[FutureOSS 微内核]
|
||||
|
||||
subgraph "核心插件层 (可信)"
|
||||
Core --> HTTP[HTTP API]
|
||||
Core --> WS[WebSocket]
|
||||
Core --> DB[数据持久化]
|
||||
end
|
||||
|
||||
subgraph "隔离插件层 (不可信)"
|
||||
Core --> Isolator[进程隔离加载器]
|
||||
Isolator --> P1[FTP 服务]
|
||||
Isolator --> P2[FRP 穿透]
|
||||
Isolator --> P3[多语言运行时]
|
||||
Isolator --> P4[防火墙]
|
||||
end
|
||||
|
||||
subgraph "基础设施"
|
||||
Core --> Audit[审计中心]
|
||||
Core --> Monitor[监控探针]
|
||||
end
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✨ 核心特性
|
||||
## ⚡ 快速开始
|
||||
|
||||
| 特性 | 说明 |
|
||||
|:---:|:---|
|
||||
| 🔌 **插件化架构** | 核心功能全部插件化,按需加载,极致轻量 |
|
||||
| 🛡️ **安全沙箱** | 数字签名验证 + 权限分级控制,确保插件来源可信 |
|
||||
| 🔄 **热重载支持** | 开发阶段插件实时更新,无需重启服务 |
|
||||
| 📊 **可视化控制台** | Web 仪表盘实时监控系统状态与插件运行情况 |
|
||||
| 🌐 **双协议服务** | 同时支持 HTTP API 和 TCP 高性能模式 |
|
||||
| 📦 **依赖自动解析** | 插件依赖自动安装,告别手动配置烦恼 |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
- Python >= 3.10
|
||||
- pip / uv
|
||||
|
||||
### 安装启动
|
||||
### 1. 环境准备
|
||||
```bash
|
||||
# 需要 Python 3.10+
|
||||
python --version
|
||||
```
|
||||
|
||||
### 2. 安装与运行
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone https://gitee.com/starlight-apk/feature-oss.git
|
||||
cd feature-oss
|
||||
git clone https://github.com/FutureOSS/futureoss.git
|
||||
cd futureoss
|
||||
|
||||
# 安装依赖
|
||||
pip install -e .
|
||||
pip install -r requirements.txt
|
||||
|
||||
# 启动服务
|
||||
oss serve
|
||||
# 启动核心
|
||||
python main.py
|
||||
```
|
||||
|
||||
服务启动后,访问 `http://localhost:8080` 即可进入 Web 控制台。
|
||||
### 3. 访问控制台
|
||||
打开浏览器访问 `http://localhost:8080` 体验全新的简约 WebUI。
|
||||
|
||||
---
|
||||
|
||||
## 📂 项目结构
|
||||
## 📦 v1.1.0 更新日志
|
||||
|
||||
```
|
||||
FutureOSS/
|
||||
├── 🚀 pyproject.toml # Python 项目配置
|
||||
├── 📋 oss/ # 核心框架包
|
||||
│ ├── cli.py # CLI 命令入口
|
||||
│ ├── config/ # 配置系统
|
||||
│ ├── logger/ # 日志系统
|
||||
│ ├── plugin/ # 插件框架 (接口/加载器/管理器)
|
||||
│ │ ├── capabilities.py # 能力接口定义
|
||||
│ │ ├── loader.py # 插件加载器
|
||||
│ │ ├── manager.py # 插件生命周期管理
|
||||
│ │ └── types.py # 类型定义
|
||||
│ └── shared/ # 共享组件
|
||||
│ └── router.py # 统一路由系统
|
||||
├── 🧩 store/ # 本地插件仓库
|
||||
│ └── @{作者名}/ # 插件命名空间
|
||||
│ └── {插件名}/ # 插件目录
|
||||
│ ├── manifest.json # 插件元数据
|
||||
│ ├── main.py # 插件入口
|
||||
│ ├── config.json # 插件配置
|
||||
│ ├── README.md # 插件文档
|
||||
│ └── SIGNATURE # 数字签名
|
||||
├── 📦 data/ # 运行时数据目录
|
||||
│ ├── html-render/ # 网站渲染文件
|
||||
│ ├── web-toolkit/ # Web 工具配置
|
||||
│ ├── plugin-storage/ # 插件持久化存储
|
||||
│ └── DCIM/ # 共享资源存储
|
||||
├── 🌐 website/ # 官网 + 社区 (PHP)
|
||||
├── 📖 static/ # 静态资源
|
||||
└── 🛠️ tools/ # 开发工具脚本
|
||||
```
|
||||
| 模块 | 变更详情 |
|
||||
| :--- | :--- |
|
||||
| **Security** | ✅ 移除 Python 沙箱,启用进程隔离 (`ProcessIsolatedLoader`) |
|
||||
| **WebUI** | ✅ 从 PHP 迁移至静态 HTML,重构为极简设计风格 |
|
||||
| **Plugins** | ✅ 新增 FTP, FRP, Firewall, Multi-Language 官方插件 |
|
||||
| **Ops** | ✅ 集成自动化备份与健康检查工具 |
|
||||
| **Docs** | ✅ 重写 README,增加架构图与标准化文档 |
|
||||
|
||||
---
|
||||
|
||||
## 🔌 内置核心插件
|
||||
## 🤝 贡献与许可
|
||||
|
||||
FutureOSS 采用「核心最小化 + 功能插件化」的设计,以下是框架自带的核心插件:
|
||||
遵循 MIT 协议开源。欢迎提交 Issue 和 PR。
|
||||
|
||||
### 系统级插件 (@FutureOSS)
|
||||
|
||||
| 插件 | 状态 | 功能描述 |
|
||||
|:---|:---:|:---|
|
||||
| `plugin-loader` | ✅ | 插件扫描、加载与生命周期管理 |
|
||||
| `dependency` | ✅ | 插件依赖解析与自动安装 |
|
||||
| `signature-verifier` | ✅ | 插件数字签名验证 |
|
||||
| `http-api` | ✅ | HTTP RESTful API 服务 |
|
||||
| `http-tcp` | ✅ | TCP 高性能 HTTP 服务 |
|
||||
| `json-codec` | ✅ | 统一 JSON 编解码器 |
|
||||
| `plugin-bridge` | ✅ | 插件间通信桥接 |
|
||||
| `plugin-storage` | ✅ | 插件数据持久化存储 |
|
||||
| `pkg-manager` | ✅ | 插件包管理(安装/卸载/搜索) |
|
||||
| `dashboard` | ✅ | Web 可视化监控仪表盘 |
|
||||
| `log-terminal` | ✅ | 日志终端实时输出 |
|
||||
| `hot-reload` | ⏸️ | 开发模式热重载(默认禁用) |
|
||||
| `i18n` | ⏸️ | 国际化支持(默认禁用) |
|
||||
| `lifecycle` | ⏸️ | 插件生命周期钩子(默认禁用) |
|
||||
|
||||
### 社区插件 (@Falck)
|
||||
|
||||
| 插件 | 功能描述 |
|
||||
|:---|:---|
|
||||
| `html-render` | HTML 模板渲染引擎 |
|
||||
| `web-toolkit` | Web 开发工具集(静态文件/模板/路由) |
|
||||
|
||||
> **注**:插件名以 `.disabled` 结尾表示默认禁用,可通过配置启用。
|
||||
|
||||
---
|
||||
|
||||
## 📖 文档导航
|
||||
|
||||
完整开发者文档请查阅 [项目 Wiki](https://gitee.com/starlight-apk/feature-oss/wikis):
|
||||
|
||||
| 📘 文档 | 📝 内容概要 |
|
||||
|:---:|:---|
|
||||
| [🎯 项目介绍](https://gitee.com/starlight-apk/feature-oss/wikis/项目介绍) | 架构设计、核心概念、设计理念 |
|
||||
| [🚀 快速开始](https://gitee.com/starlight-apk/feature-oss/wikis/快速开始) | 安装指南、配置说明、首次运行 |
|
||||
| [🔌 插件开发](https://gitee.com/starlight-apk/feature-oss/wikis/插件开发) | 编写第一个插件、事件系统、API 参考 |
|
||||
| [📄 插件文档](https://gitee.com/starlight-apk/feature-oss/wikis/插件文档) | http-api、ws-api、file 等插件详解 |
|
||||
| [📦 包管理](https://gitee.com/starlight-apk/feature-oss/wikis/包管理) | 插件安装/卸载/搜索/发布 |
|
||||
| [⚙️ 配置参考](https://gitee.com/starlight-apk/feature-oss/wikis/配置参考) | 配置文件详解、参数说明 |
|
||||
| [🚢 部署运维](https://gitee.com/starlight-apk/feature-oss/wikis/部署运维) | 本地运行、Docker、生产环境部署 |
|
||||
| [🌟 社区与贡献](https://gitee.com/starlight-apk/feature-oss/wikis/社区与贡献) | 贡献指南、行为准则、开发规范 |
|
||||
|
||||
---
|
||||
|
||||
## 🔗 相关资源
|
||||
|
||||
<div align="center">
|
||||
|
||||
| 📦 代码仓库 | 📚 包仓库 | 🐛 问题反馈 |
|
||||
|:---:|:---:|:---:|
|
||||
| [Gitee](https://gitee.com/starlight-apk/feature-oss) | [Gitee Pkg](https://gitee.com/starlight-apk/future-oss-pkg) | [Issues](https://gitee.com/starlight-apk/feature-oss/issues) |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🛡️ 许可证与声明
|
||||
|
||||
### 开源许可
|
||||
|
||||
本项目采用 **[Apache License 2.0](LICENSE)** 开源许可证。
|
||||
|
||||
```
|
||||
Copyright 2026 Falck
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
```
|
||||
|
||||
### 作者声明
|
||||
|
||||
> 以下声明作为 Apache 2.0 许可证的补充说明:
|
||||
|
||||
| 允许 ✅ | 禁止 🚫 |
|
||||
|:---|:---|
|
||||
| 个人学习、研究使用 | 未经书面许可的二次转发、搬运、转载 |
|
||||
| 商业使用(保留版权声明) | 冒充原作者或声称与官方项目存在关联 |
|
||||
| 修改和衍生作品 | 移除、修改或遮盖版权声明、许可证和 NOTICE 文件 |
|
||||
|
||||
> 此声明不改变 Apache 2.0 许可证的法律效力,仅表达作者的合理期望。如需特殊授权,请联系作者。
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
<p>
|
||||
<strong>⚡ FutureOSS</strong> — 一切皆为插件
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Made with ❤️ by <a href="https://gitee.com/starlight-apk">Falck</a> & <a href="https://gitcode.com/yongwanxing">yongwanxing</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
*Built with ❤️ by FutureOSS Team*
|
||||
|
||||
Reference in New Issue
Block a user