Skip to content

Commit

Permalink
部署使用前请先阅读README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ling-drag0n authored Dec 10, 2024
1 parent 5323d3b commit 8e9852d
Showing 1 changed file with 29 additions and 9 deletions.
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

一个基于 Cloudflare Workers 的在线剪贴板和文件分享服务。支持 Markdown、密码保护、文件上传等功能。


<table>
<tr>
<td><img src="https://github.com/user-attachments/assets/b3245bf3-976c-43dd-b097-f6a1477abe50" width="400"/></td>
Expand Down Expand Up @@ -41,6 +40,10 @@
- 同步滚动预览
- 支持自定义链接后缀(仅单文件上传时可用)
- 支持设置访问次数限制
- 支持自动保存草稿
- 浏览器关闭前自动保存
- 下次访问时可恢复
- 提交成功后自动清除

### 📁 文件分享

Expand Down Expand Up @@ -89,6 +92,10 @@
- 可切换 Markdown 开关
- 与主页编辑器相同的编辑体验
- 分屏预览模式
- 编辑文件分享设置
- 修改过期时间
- 修改下载次数限制
- 实时生效

### 🔐 访问控制

Expand All @@ -99,6 +106,8 @@
- 文本内容控制
- 仅管理员可编辑已分享的文本内容
- 普通用户只能查看
- 支持修改过期时间
- 支持修改访问次数限制
- 上传控制
- 管理员可开启/关闭文本上传功能
- 管理员可开启/关闭文件上传功能
Expand All @@ -107,10 +116,14 @@
### 🛡️ 安全特性

- 密码加密存储
- 自动过期清理 (每当有请求访问时,检查当前时间,如果是整点(分钟为 0),触发清理操作)
- 访问权限控制
- CORS 安全配置
- 上传限制保护
- 自动过期清理
- 定时检查过期内容
- 自动删除过期分享
- 释放存储空间
- 访问触发清理检查

### 🎨 界面优化

Expand Down Expand Up @@ -190,7 +203,7 @@

### 3. 创建 Worker

1. 创建新的 Worker脚本
1. 创建新的 Worker 脚本
2. 配置环境变量:

```env
Expand All @@ -199,30 +212,35 @@
```

3. 绑定存储:

- KV 绑定:

```toml
# 文本存储
变量名:PASTE_STORE
选择创建的 KV 命名空间

# 上传状态控制
变量名:UPLOAD_STATUS
选择创建的 KV 命名空间
```

- R2 绑定:
```toml
变量名:FILE_STORE
选择创建的 R2 存储桶
```

4. KV 命名空间说明:

- `PASTE_STORE`: 用于存储文本分享内容和元数据
- `UPLOAD_STATUS`: 用于存储和控制上传功能的开关状态
- `textUpload`: 控制文本上传功能
- `fileUpload`: 控制文件上传功能
- `FILE_STORE`: 用于存储上传的文件

5. 配置示例代码 (wrangler.toml):

```toml
[[kv_namespaces]]
binding = "PASTE_STORE"
Expand Down Expand Up @@ -281,7 +299,7 @@
POST /api/file # 上传文件
GET /api/file/:id # 获取文件信息
GET /api/file/:id?download=true # 下载文件
GET /download/:id # 直接下载文件
GET /download/:id # 直接下载文件
```

3. 管理相关
Expand All @@ -296,6 +314,7 @@
PUT /api/admin/file/:id/password # 修改文件分享密码
GET /api/admin/upload-status # 获取上传状态
PUT /api/admin/upload-status # 更新上传状态
PUT /api/admin/file/:id/settings # 修改文件分享设置
```

## 🔄 自动化功能
Expand All @@ -310,13 +329,13 @@
## ⚠️ 使用限制

- 文件大小上限:98MB
- 支持的过期时间:1小时、1天、7天、30天,永不过期
- 并发请求受Worker限制
- 支持的过期时间:1 小时、1 天、7 天、30 天,永不过期
- 并发请求受 Worker 限制
- 总存储空间:5GB
- 分享次数访问限制:
- 文本分享可设置最大访问次数
- 文件分享可设置最大下载次数
- 自定义设置次数,0表示无限制
- 自定义设置次数,0 表示无限制
- 达到限制次数后自动删除
- 自定义链接限制:
- 仅支持字母、数字、横线和下划线
Expand All @@ -339,10 +358,11 @@
3. 监控错误日志
4. 注意 Worker 使用配额
5. 直链下载若要在服务器传输文件

```bash
# 直接下载
curl -O https://your-domain/download/fileId

# 带密码下载
curl -H "X-Password: your-password" -O https://your-domain/download/fileId
```
Expand Down

0 comments on commit 8e9852d

Please sign in to comment.