diff --git a/README.md b/README.md index 7d3fc99..5b508e5 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,86 @@ # Cocoon -一个基于 [coco](https://github.com/DefectingCat/coco) 协程库的轻量级静态资源 Web 服务器。 +> 一只从 **coco** 协程库中孵化出的轻量 Web 服务器。 **Cocoon**(茧)—— 用协程的轻盈,包裹静态资源的安稳。 +[中文](#特性) | [Quick Start](#quick-start) + +--- + ## 特性 -- 🚀 **协程驱动并发** — 基于 coco 的有栈协程,每个连接一个协程,告别回调地狱 -- 📁 **静态文件托管** — 支持目录列表、MIME 类型自动识别、范围请求(Range) -- 🧵 **多线程调度** — 利用 coco 的 M:N 调度器,自动扩展至多核 -- ⚡ **零拷贝发送** — 支持 sendfile,减少用户态/内核态拷贝 -- 🔧 **极简配置** — 命令行参数即可启动,无需配置文件 +| 特性 | 描述 | +|------|------| +| 🚀 协程驱动 | 基于 coco 有栈协程,每个连接一个协程,上下文切换 < 100ns | +| 📁 静态托管 | 目录浏览、MIME 自动识别、Range 请求、index.html 自动补全 | +| 🧵 多核扩展 | M:N 调度器 + Work-stealing,自动负载均衡至多核 | +| ⚡ 零拷贝 | 优先使用 `sendfile`,减少用户态/内核态数据拷贝 | +| 🔐 路径安全 | 自动防护路径遍历攻击 (`../`) | +| 🔧 极简配置 | 纯命令行启动,无需配置文件 | -## 快速开始 +## Quick Start + +### 依赖 + +- GCC / Clang(C11 标准) +- [coco](https://github.com/DefectingCat/coco) 协程库(已编译) +- Linux(内核 ≥ 5.1,支持 io_uring)/ macOS ### 构建 ```bash -# 克隆仓库 git clone https://github.com/xfy911/cocoon.git cd cocoon -# 构建(需要 coco 库和头文件) +# 默认使用 ../coco 作为 coco 库路径 make -# 运行 -./cocoon -r ./examples/www -p 8080 +# 或指定路径 +make COCO_INCLUDE=/path/to/coco/include COCO_LIB=/path/to/coco/build ``` -### 依赖 - -- [coco](https://github.com/DefectingCat/coco) — 协程库 -- Linux / macOS(支持 epoll / kqueue) - -## 使用 +### 运行 ```bash -# 基本用法 -./cocoon -r /var/www/html -p 8080 +# 单线程模式(开发调试) +./cocoon -r ./examples/www -p 8080 -# 多线程模式(自动检测 CPU 核心数) +# 多线程模式(生产环境,自动检测 CPU 核心) ./cocoon -r ./examples/www -p 8080 -t -# 指定工作线程数 -./cocoon -r ./examples/www -p 8080 -w 8 +# 指定 8 个工作线程 +./cocoon -r ./examples/www -p 8080 -t -w 8 +``` + +### 测试 + +```bash +# 启动服务器 +./cocoon -r ./examples/www -p 8080 & + +# 访问首页 +curl http://localhost:8080/ + +# 目录浏览 +curl http://localhost:8080/examples/ + +# Range 请求 +curl -H "Range: bytes=0-99" http://localhost:8080/index.html +``` + +## 命令行参数 + +``` +Usage: ./cocoon [options] + +Options: + -r