docs: 补齐 common/file/process/shell 四个既有包的 README
- 每包定位/路由表/用法与注意事项(鉴权告诫、录制审计、防误杀语义) - 至此 remote-core 全部包 README 覆盖
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# file
|
||||
|
||||
被控端文件管理 HTTP 能力(自 remote-backend-server internal/handlers/file 移植,
|
||||
去 DB 依赖):目录浏览、改名、删除、上传、下载(断点支持)、目录创建。
|
||||
|
||||
## 路由
|
||||
|
||||
```go
|
||||
import "git.zeroonesoft.cn/golib/remote-core/file"
|
||||
|
||||
file.RegisterRoutersGatewayFile(r *gin.RouterGroup)
|
||||
```
|
||||
|
||||
| 方法 | 路径 | 说明 |
|
||||
|---|---|---|
|
||||
| GET/POST | `/file/list` | 目录列表(POST 收 JSON `{path}`,避免路径含 `#` 等字符被 query 截断) |
|
||||
| PUT | `/file/name` | 重命名 |
|
||||
| DELETE | `/file` | 删除文件/目录 |
|
||||
| GET/HEAD | `/file/download` | 下载(HEAD 取大小,GET 支持 Range 续传) |
|
||||
| POST | `/file/upload` | 上传 |
|
||||
| POST | `/file/dir` | 创建目录 |
|
||||
|
||||
## 注意
|
||||
|
||||
- 与 shell/process 同为被控 HTTP 能力,经 zonat 隧道 + web-gateway 反代出网。
|
||||
- 路径参数来自控制端,接入公网前务必在网关侧做鉴权与路径白名单校验。
|
||||
Reference in New Issue
Block a user