GitHub - OpenListTeam/OpenList-Worker: Service Worker Backend for OpenList

OpenList 是一个多功能的目录列表工具，支持数十种网盘文件挂载和文件预览/下载/分享等功能

本仓库是官方 OpenListTeam/OpenList 项目的 TypeScript + Serverless 架构移植版

基于 Cloudflare Workers / EdgeOne Cloud Function / Alibaba Cloud ESA 运行

📘 使用文档 · 🌏 使用文档（中国大陆） · ⚖️ 使用条款 · 🔒 隐私政策

上游项目 · 贡献指南 · 行为准则 · 许可证

🌎 全球 Demo 　|　 🇨🇳 中国 Demo

一键部署

点击下方按钮，即可将本项目一键部署到对应平台：

EdgeOne Makers · 国际站	EdgeOne Makers · 中国站	Cloudflare Workers · 全球站

Important

若 Cloudflare 提示无法获取存储库内容，则您需要先 Fork 本项目，再通过连接到 Github 仓库功能部署
部署时请填写 JWT_SECRET（≥16 字符的随机串，可用 openssl rand -hex 32 生成）：它用于 JWT 签名与数据加密；未配置时会在初始化时自动生成并持久化
数据存储默认自动选择平台自带的持久化后端（DB_DRIVER=auto），无需配置；其余变量见配置变量
部署完成后首次访问站点，按安装向导在浏览器中设置管理员账号与密码即可完成初始化；如需跳过向导，可配置 ADMIN_PASS

功能简介

OpenList 是一个运行于边缘计算平台的多存储聚合文件列表与管理系统，可将分散在不同网盘、对象存储与协议服务中的文件统一到一个界面，进行浏览、预览、下载与管理。

OpenList-Worker 是官方 OpenListTeam/OpenList 项目的 TypeScript + Serverless 移植版，后端由 Go 重写为运行于 Workers 的 TypeScript 服务，前端保持一致的界面与交互体验。

存储聚合

内置 78 个存储驱动，开箱即用地挂载各类存储后端：

国内网盘：阿里云盘（开放平台/分享）、夸克网盘（开放平台/UC TV 版）、百度网盘（相册）、115 网盘（开放平台/分享）、123 云盘（开放平台/分享）、天翼云盘（189/PC/TV）、中国移动云盘（139/和彩云）、沃家云盘、迅雷云盘、腾讯微云、蓝奏云、城通网盘、PikPak（分享）、豆包网盘、光亚盘、超星小组网盘、联想 NAS 分享、Teambition 网盘、WPS 网盘、阿里文档、HalalCloud、MediaTrack 等
国际网盘：Google Drive（相册）、OneDrive（应用/分享链接）、Dropbox、MEGA、MediaFire、Proton Drive、Yandex Disk、Degoo、Bunny Storage、TeraBox 等
对象存储：S3 兼容（AWS/OSS/COS/MinIO 等）、Cloudflare R2（Workers Binding 直连或 S3 API）、又拍云 USS、Azure Blob、WebDAV、FTP、SFTP、SMB、IPFS 等
代码托管：GitHub、GitHub Releases、CNB Releases
网盘程序：OpenList（分享）、AList V3、Cloudreve V3/V4、Kodbox（可道云）、Seafile、Teldrive、Febbox 等
其他驱动：网易云音乐、Misskey、Emby、Cloudflare 图床等

除上述真实存储外，还提供 Local、Alias、UrlTree、AutoIndex、Strm、Crypt、Virtual、Chunk 等虚拟/功能型驱动，可用于本地挂载、地址别名、URL 列表、加密存储与分片等场景。

核心能力

文件浏览：统一的目录树浏览，支持图片、视频、音频、文档、代码、压缩包等格式在线预览。
上传下载：跨存储的上传、批量下载、流式传输与直链跳转。
文件分享：生成带有效期、密码与权限控制的分享链接，支持匿名访问与目录分享。
全文搜索：在已索引的存储中快速检索文件。
离线任务：后台任务队列，支持批量操作与异步处理。
外部接口：将聚合存储以 WebDAV 或 S3 兼容协议对外暴露，便于挂载到第三方工具。
MCP 服务：提供 Model Context Protocol 端点，可被 AI 助手等客户端集成调用。
并发去重：同一时刻相同的目录列表 / 元信息请求只向上游网盘发起一次，其余请求复用同一结果，避免无谓的限流与 CPU 消耗。

权限管理

权限管理：基于角色的访问控制（RBAC），支持用户分组、目录级读写权限与配额。
认证方式：内置账号密码，支持TOTP验证、WebAuthn/FIDO登录、SSO单点登录与 LDAP 目录认证。
安全加固：JWT 会话、CSRF 防护、点击劫持防护（X-Frame-Options）、内容安全策略（CSP）。
健康检查：提供 /health 存活探针与 /healthz 就绪探针，可用于监控与告警。

平台部署

运行平台：Cloudflare Workers、腾讯云 EdgeOne Makers、阿里云 ESA、Vercel / AWS Lambda 及 Node.js 容器环境。
数据存储：Cloudflare D1（SQLite）为主，也支持 KV / Blob / Durable Objects 与外部 MySQL / MariaDB。
一键部署：支持 EdgeOne、Cloudflare Workers 的一键部署按钮 + 安装向导。

手动部署

前置要求

Node.js 18+（推荐使用 pnpm）
Cloudflare 账号（用于部署到 Workers）

本地开发

# 1. 安装依赖
pnpm install

# 2. 按需配置 wrangler.jsonc 中的绑定与变量（JWT_SECRET 见 .dev.vars.example）

# 3. 启动开发服务器（自动拉取官方前端并运行 Worker）
pnpm run dev:unified

# 或仅运行 Worker（不拉取前端）
pnpm run dev:worker

生产部署

# 一键部署：构建前端产物 → 部署到 Cloudflare Workers（KV 绑定由 wrangler 自动预配）
pnpm run deploy

# 或直接部署 Worker（跳过前端构建）
pnpm run deploy:worker

技术架构

后端

运行环境：Cloudflare Workers / EdgeOne 云函数 / 阿里云 ESA（Edge Computing）
Web 框架：Hono.js
数据库：Cloudflare D1（SQLite）/ KV / Blob / Durable Objects，或外部 MySQL / MariaDB
语言：TypeScript
构建工具：Wrangler、esbuild

前端

框架：SolidJS + TypeScript（官方 OpenList-Frontend）
UI 库：Hope UI
构建工具：Vite

配置

部署完成后首次访问站点会自动进入安装向导，在浏览器中设置管理员账号与密码即可完成初始化；如需跳过向导，配置 ADMIN_PASS 即可自动初始化 admin。

绝大多数部署不需要任何额外配置：数据存储默认走 DB_DRIVER=auto，会自动选择平台可用的持久化后端（Cloudflare Workers → KV / D1 / DO，EdgeOne / ESA → Blob）。建议显式配置的只有一项：

变量	说明
`JWT_SECRET`	JWT 令牌签名密钥（≥16 字符，推荐 `openssl rand -hex 32` 生成），同时用于定时任务鉴权。未配置时会在初始化时自动生成并持久化

JWT_SECRET 请以 Secret（而非普通变量）方式配置：普通变量可能在平台重新部署时被仓库内的配置覆盖，Secret 不会被覆盖。

其余变量均有合理默认值，需要时再调整：

变量	默认值	说明
`ADMIN_PASS`	—	跳过安装向导，以该密码自动初始化 admin
`DB_FORMAT`	`map`	数据存储格式：`map`（整对象 JSON）/ `key`（分 key）/ `sql`（关系表，与 Go 后端一致）
`DB_DRIVER`	`auto`	存储驱动：`auto` / `blob` / `cfkv` / `kv` / `d1` / `do` / `mysql`；显式指定后不做回退
`DB_CIPHER`	`none`	敏感字段落盘算法（默认不加密），如 `aes-256-gcm`
`CACHE_ENABLED` / `CACHE_DRIVER`	`true` / `db`	文件树缓存与下载链接缓存，默认复用业务数据后端
`ALLOW_URLS`	—	CORS 允许白名单（逗号分隔，不设则仅同源）
`MAX_UPLOAD` / `MAX_UPPART`	26214400 / 16777216	整体上传 / 分片上传大小上限（字节）
`ASSET_URLS`	—	前端静态资源 CDN 地址，支持 `$version` 占位符

完整环境变量（含缓存 CACHE_*、字段加密 DB_CIPHER、并发去重 SINGLEFLIGHT、cfkv / MySQL 连接配置等）与各平台部署步骤，请参阅文档站：

帮助支持

在使用过程中遇到问题，可通过以下渠道获取帮助：

🐛 提交 Bug 或功能请求：请前往 Issues
💬 一般性问题与交流：请前往 Discussions 讨论区

开源许可

OpenList 是基于 AGPL-3.0 许可证的开源软件。

联系我们

🌐 @GitHub · ✈️ Telegram 交流群 · ✈️ Telegram 频道

贡献列表

感谢以下项目及其贡献者：

Alist 项目作者及全体贡献者
OpenList（Go 版）项目作者及全体贡献者
本项目全体贡献者：

Name		Name	Last commit message	Last commit date
.github		.github
api		api
cloud-functions		cloud-functions
docs		docs
functions		functions
node-functions		node-functions
public_data		public_data
readmes		readmes
scripts		scripts
src/backend		src/backend
tests		tests
.dev.vars.example		.dev.vars.example
.env.example		.env.example
.gitignore		.gitignore
.npmrc		.npmrc
.prettierignore		.prettierignore
.prettierrc		.prettierrc
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
edgeone.json		edgeone.json
esa-entry.ts		esa-entry.ts
esa.jsonc		esa.jsonc
handler.ts		handler.ts
loadEnv.js		loadEnv.js
middleware.js		middleware.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
renovate.json		renovate.json
sea-config.json		sea-config.json
serverless.yml		serverless.yml
tsconfig.json		tsconfig.json
vercel.json		vercel.json
wrangler.jsonc		wrangler.jsonc

Navigation Menu

Repository navigation

About

Repository files navigation

一键部署

功能简介

存储聚合

核心能力

权限管理

平台部署

手动部署

前置要求

本地开发

生产部署

技术架构

后端

前端

配置

帮助支持

开源许可

联系我们

贡献列表

About

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

一键部署

功能简介

存储聚合

核心能力

权限管理

平台部署

手动部署

前置要求

本地开发

生产部署

技术架构

后端

前端

配置

帮助支持

开源许可

联系我们

贡献列表

About

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages