From 2c46609454fc9fbc0dc243d992d4307621ebbffc Mon Sep 17 00:00:00 2001 From: tanghongxin Date: Thu, 28 Aug 2025 10:44:35 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20README=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3=EF=BC=8C=E6=96=B0=E5=A2=9E=20WebDAV=20=E6=A1=A5?= =?UTF-8?q?=E6=8E=A5=E6=9C=8D=E5=8A=A1=E7=9A=84=E5=8A=9F=E8=83=BD=E4=BB=8B?= =?UTF-8?q?=E7=BB=8D=E3=80=81=E4=BD=BF=E7=94=A8=E6=96=B9=E6=B3=95=E5=8F=8A?= =?UTF-8?q?=E9=83=A8=E7=BD=B2=E9=85=8D=E7=BD=AE=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++- README_en.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 208 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4653c20..65a8e24 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,110 @@ -# 4. Tips +# 4. WebDAV Bridge 桥接服务 + +本项目提供了一个强大的 **WebDAV Bridge Cloudflare Worker**，让您可以通过标准的 WebDAV 协议访问和管理托管的文件。 + +## 4.1 功能特性 + +- 🔒 **身份验证**：支持基于用户名密码的 Basic Auth 认证 +- 📁 **目录浏览**：完整的目录结构展示，支持 HTML 页面和 WebDAV 客户端 +- 📤 **文件上传**：通过 PUT 方法上传文件到指定目录 +- 🗑️ **文件删除**：支持删除单个文件或整个文件夹 +- 📥 **文件下载**：直接下载文件，自动代理到上游存储 +- 🌐 **跨域支持**：内置 CORS 支持，确保 Web 客户端正常访问 + +## 4.2 支持的 WebDAV 方法 + +| 方法 | 功能 | 说明 | +|------|------|------| +| `PROPFIND` | 列出目录内容 | 获取文件和文件夹列表，支持 WebDAV 客户端 | +| `GET` | 下载文件/浏览目录 | 文件下载或 HTML 目录浏览页面 | +| `PUT` | 上传文件 | 上传文件到指定路径和文件夹 | +| `DELETE` | 删除文件/文件夹 | 支持删除单个文件或整个目录 | +| `OPTIONS` | 协议探测 | 返回支持的 WebDAV 方法和功能 | +| `MKCOL` | 创建目录 | 创建新的文件夹（自动支持） | + +## 4.3 部署配置 + +### 4.3.1 环境变量设置 + +需要在 Cloudflare Worker 中设置以下环境变量： + +```bash +# WebDAV 认证凭据 +AUTH_USER=your_username # WebDAV 登录用户名 +AUTH_PASS=your_password # WebDAV 登录密码 + +# 上游 API 配置 +UPSTREAM_HOST=your-imgbed.domain.com # 您的图床域名 +API_TOKEN=your_api_token # API 访问令牌 +``` + +### 4.3.2 自定义域名绑定（推荐） + +为了获得更好的使用体验，强烈建议为 WebDAV Worker 绑定自定义域名： + +1. **准备域名**：确保您有一个可用的域名，并且该域名已托管在 Cloudflare +2. **添加自定义路由**： + - 进入 Cloudflare Workers 控制台 + - 选择您的 WebDAV Worker + - 点击 `触发器` (Triggers) 标签 + - 点击 `添加自定义域名` + - 输入您的子域名，如：`webdav.yourdomain.com` + - 点击 `添加域名` + +3. **SSL 证书**：Cloudflare 会自动为您的自定义域名提供免费 SSL 证书 + +**使用自定义域名的优势**： +- 🌟 **更好的兼容性**：避免某些 WebDAV 客户端对 `.workers.dev` 域名的限制 +- 🔒 **更高的安全性**：自定义域名通常更受客户端信任 +- 📱 **移动端友好**：iOS/Android 设备对自定义域名支持更好 +- 🎯 **品牌一致性**：与您的图床服务使用统一的域名体系 + +## 4.4 使用方式 + +### 浏览器访问 +直接在浏览器中访问 Worker 地址，输入认证信息后可以浏览文件目录： +``` +# 使用自定义域名（推荐） +https://webdav.yourdomain.com/ + +# 或使用默认 Worker 域名 +https://your-webdav-worker.your-subdomain.workers.dev/ +``` + +### WebDAV 客户端 +可以使用任何支持 WebDAV 的客户端连接： + +**Windows 资源管理器**： +1. 打开"此电脑" +2. 右键选择"添加网络位置" +3. 输入 WebDAV Worker 地址 +4. 输入用户名和密码 + +**macOS Finder**： +1. 在 Finder 中按 `Cmd+K` +2. 输入 WebDAV 地址（推荐使用自定义域名）： + - `https://webdav.yourdomain.com` 或 + - `https://your-webdav-worker.your-subdomain.workers.dev` +3. 输入认证信息 + +**第三方客户端**： +- Cyberduck、WinSCP、FileZilla Pro 等文件管理器 +- Mobile 端：FE File Explorer、Documents by Readdle 等 + +## 4.5 特色功能 + +- **智能路径处理**：自动处理文件路径，支持中文和特殊字符 +- **分页加载**：大目录自动分页加载，提升性能 +- **错误处理**：完善的错误处理和用户友好的错误信息 +- **缓存优化**：合理利用浏览器缓存，提升访问速度 +- **安全可靠**：基于 Cloudflare Worker 的边缘计算，全球加速 + +通过 WebDAV Bridge，您可以像使用本地文件夹一样管理托管的文件，实现了真正的"云端硬盘"体验！ + +# 5. Tips - **前端开源**：参见[MarSeventh/Sanyue-ImgHub](https://github.com/MarSeventh/Sanyue-ImgHub)项目。 diff --git a/README_en.md b/README_en.md index 08732c0..72a6c06 100644 --- a/README_en.md +++ b/README_en.md @@ -102,7 +102,110 @@ Provides detailed deployment documentation, feature docs, development plans, upd -# 4. Tips +# 4. WebDAV Bridge Service + +This project provides a powerful **WebDAV Bridge Cloudflare Worker** that allows you to access and manage hosted files through the standard WebDAV protocol. + +## 4.1 Features + +- 🔒 **Authentication**: Supports Basic Auth authentication with username/password +- 📁 **Directory Browsing**: Complete directory structure display, supports both HTML pages and WebDAV clients +- 📤 **File Upload**: Upload files to specified directories using PUT method +- 🗑️ **File Deletion**: Support for deleting individual files or entire folders +- 📥 **File Download**: Direct file downloads with automatic proxy to upstream storage +- 🌐 **CORS Support**: Built-in CORS support ensuring proper web client access + +## 4.2 Supported WebDAV Methods + +| Method | Function | Description | +|--------|----------|-------------| +| `PROPFIND` | List directory contents | Get file and folder lists, supports WebDAV clients | +| `GET` | Download file/browse directory | File downloads or HTML directory browsing pages | +| `PUT` | Upload file | Upload files to specified paths and folders | +| `DELETE` | Delete file/folder | Support for deleting individual files or entire directories | +| `OPTIONS` | Protocol detection | Returns supported WebDAV methods and features | +| `MKCOL` | Create directory | Create new folders (automatically supported) | + +## 4.3 Deployment Configuration + +### 4.3.1 Environment Variables + +Set the following environment variables in your Cloudflare Worker: + +```bash +# WebDAV authentication credentials +AUTH_USER=your_username # WebDAV login username +AUTH_PASS=your_password # WebDAV login password + +# Upstream API configuration +UPSTREAM_HOST=your-imgbed.domain.com # Your image bed domain +API_TOKEN=your_api_token # API access token +``` + +### 4.3.2 Custom Domain Binding (Recommended) + +For a better user experience, it's highly recommended to bind a custom domain to your WebDAV Worker: + +1. **Prepare Domain**: Ensure you have an available domain that is hosted on Cloudflare +2. **Add Custom Route**: + - Go to Cloudflare Workers console + - Select your WebDAV Worker + - Click the `Triggers` tab + - Click `Add Custom Domain` + - Enter your subdomain, e.g.: `webdav.yourdomain.com` + - Click `Add Domain` + +3. **SSL Certificate**: Cloudflare will automatically provide a free SSL certificate for your custom domain + +**Advantages of Using Custom Domain**: +- 🌟 **Better Compatibility**: Avoid limitations some WebDAV clients have with `.workers.dev` domains +- 🔒 **Enhanced Security**: Custom domains are generally more trusted by clients +- 📱 **Mobile Friendly**: iOS/Android devices have better support for custom domains +- 🎯 **Brand Consistency**: Use a unified domain system with your image hosting service + +## 4.4 Usage + +### Browser Access +Access the Worker address directly in your browser and enter authentication credentials to browse file directories: +``` +# Using custom domain (recommended) +https://webdav.yourdomain.com/ + +# Or using default Worker domain +https://your-webdav-worker.your-subdomain.workers.dev/ +``` + +### WebDAV Clients +You can use any WebDAV-compatible client to connect: + +**Windows File Explorer**: +1. Open "This PC" +2. Right-click and select "Add a network location" +3. Enter the WebDAV Worker address +4. Enter username and password + +**macOS Finder**: +1. Press `Cmd+K` in Finder +2. Enter WebDAV address (custom domain recommended): + - `https://webdav.yourdomain.com` or + - `https://your-webdav-worker.your-subdomain.workers.dev` +3. Enter authentication credentials + +**Third-party Clients**: +- File managers like Cyberduck, WinSCP, FileZilla Pro +- Mobile: FE File Explorer, Documents by Readdle, etc. + +## 4.5 Key Features + +- **Smart Path Handling**: Automatic path processing with support for Chinese characters and special characters +- **Paginated Loading**: Large directories are automatically paginated for improved performance +- **Error Handling**: Comprehensive error handling with user-friendly error messages +- **Cache Optimization**: Proper browser caching utilization for improved access speed +- **Secure & Reliable**: Based on Cloudflare Worker edge computing with global acceleration + +Through WebDAV Bridge, you can manage hosted files just like using a local folder, achieving a true "cloud drive" experience! + +# 5. Tips - Frontend is open source, see [MarSeventh/Sanyue-ImgHub](https://github.com/MarSeventh/Sanyue-ImgHub).