diff --git a/docs/.vuepress/public/img/drivers/teldrive/fetch_teldrive_cookie.png b/docs/.vuepress/public/img/drivers/teldrive/fetch_teldrive_cookie.png new file mode 100644 index 000000000..d73ad459c Binary files /dev/null and b/docs/.vuepress/public/img/drivers/teldrive/fetch_teldrive_cookie.png differ diff --git a/docs/guide/drivers/teldrive.md b/docs/guide/drivers/teldrive.md new file mode 100644 index 000000000..c45139092 --- /dev/null +++ b/docs/guide/drivers/teldrive.md @@ -0,0 +1,91 @@ +--- +# This is the title of the article +title: teldrive +# This is the icon of the page +icon: iconfont icon-state +# This control sidebar order +order: 214 +# A page can have multiple categories +category: + - Guide +# A page can have multiple tags +tag: + - Storage + - Guide + - "302" +# this page is sticky in article list +sticky: true +# this page will appear in starred articles +star: true +--- + +# Teldrive + +Teldrive is a telegram based cloud storage, which is maintained by telegram official team. + +**features:** +- No storage limit +- no file size limit. +- Bandwidth limited applied if your account is not subscribe Telegram Premium. Speed depends on the distance from teldrive service to your account datacenter location(DC1-DC5). + +Official repository: [teldrive](https://github.com/tgdrive/teldrive) + +Setup guide: [teldrive Installation](https://teldrive-docs.pages.dev/docs/getting-started/prerequisites) + +## Parameters + +### Address +Your teldrive backend url without suffix dash. + +Example: `https://teldrive.example.com` + +### Authentication +Only support `Cookie` authentication. + +You can get cookie from your browser after login to teldrive web interface. + +It should start with `access_token=xxx.xxx.xxx`, which is jwt token format style. + +![fetch teldrive cookie](/img/drivers/teldrive/fetch_teldrive_cookie.png) + +::: tip +Only the string with access_token= is required. +::: + +### Chunk Size +Upload chunk size in MiB. + +Default is `10` (10MiB). You can set it to a smaller value if you have issues with large files. + +if chunk size is bigger than file size, it will not split the file, and upload it as a whole with single thread. + +### Concurrency +Upload concurrency, default is `4`. + +You should limit the concurrency with your machine actual memory, by calculating `chunk size * concurrency`. + +## Download +**Notice: If webdav 302 is enabled, it will create share file and public the download link with 1 hour expiration time.** + +Otherwise, it will use the default local proxy by AlistGo. + +## **The default download method used** + +```mermaid +--- +title: Which download method is used by default? +--- +flowchart TB + style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff + style a2 fill:#ff7575,stroke:#333,stroke-width:4px + subgraph ide1 [ ] + a1 + end + a1[302]:::someclass====|default|a2[user equipment] + classDef someclass fill:#f96 + c1[local proxy]-.alternative.->a2[user equipment] + b1[Download proxy URL]-.alternative.->a2[user equipment] + click a1 "../drivers/common.html#webdav-policy" + click b1 "../drivers/common.html#webdav-policy" + click c1 "../drivers/common.html#webdav-policy" +``` diff --git a/docs/zh/guide/drivers/teldrive.md b/docs/zh/guide/drivers/teldrive.md new file mode 100644 index 000000000..c5d537d13 --- /dev/null +++ b/docs/zh/guide/drivers/teldrive.md @@ -0,0 +1,91 @@ +--- +# 这是文章标题 +title: teldrive +# 这是页面的图标 +icon: iconfont icon-state +# 控制侧边栏的顺序 +order: 214 +# 页面可以有多个分类 +category: + - 指南 +# 页面可以有多个标签 +tag: + - 存储 + - 指南 + - "302" +# 该页面会在文章列表中置顶 +sticky: true +# 该页面会出现在加星的文章中 +star: true +--- + +# Teldrive + +Teldrive 是一个基于 Telegram 的云存储服务,由 Telegram 官方团队维护。 + +**功能特点:** +- 无限存储空间 +- 无文件大小限制 +- 如果未订阅 Telegram Premium,将受到带宽限制。速度取决于 Teldrive 服务与你账户的数据中心(DC1–DC5)之间的距离。 + +官方仓库:[teldrive](https://github.com/tgdrive/teldrive) + +安装指南:[teldrive 安装教程](https://teldrive-docs.pages.dev/docs/getting-started/prerequisites) + +## 参数说明 + +### 地址 +填写你的 teldrive 后端网址,不要包含后缀的短横线。 +例如:`https://teldrive.example.com` + +### 认证 +仅支持 `Cookie` 方式认证。 + +你可以在登录 Teldrive 网页端后,通过浏览器获取 Cookie。 + +Cookie 应以 `access_token=` 开头,这是一个 JWT 格式的 Token。 + +![获取 teldrive cookie](/img/drivers/teldrive/fetch_teldrive_cookie.png) + +::: tip +只需要包含 `access_token=` 的那一串字符串。 +::: + +### 分块大小 +上传时的分块大小,单位为 MiB。 + +默认值为 `10`(即 10MiB)。如果上传大文件出现问题,可以设置为更小的值。 + +如果分块大小大于文件本身大小,则不会进行分块,整个文件将通过单线程上传。 + +### 并发数量 +上传时的并发线程数,默认值为 `4`。 + +你应根据实际内存情况调整并发数,计算方式为:`分块大小 × 并发数`。 + +## 下载方式 + +**注意:如果启用了 WebDAV 302 重定向,将会生成共享文件链接,下载链接的有效期为 1 小时。** + +否则,默认会使用 AlistGo 提供的本地代理方式。 + +## 默认使用的下载方式 + +```mermaid +--- +title: 默认使用哪种下载方式? +--- +flowchart TB + style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff + style a2 fill:#ff7575,stroke:#333,stroke-width:4px + subgraph ide1 [ ] + a1 + end + a1[302]:::someclass====|默认|a2[用户设备] + classDef someclass fill:#f96 + c1[本地代理]-.可选.->a2[用户设备] + b1[下载代理 URL]-.可选.->a2[用户设备] + click a1 "../drivers/common.html#webdav-policy" + click b1 "../drivers/common.html#webdav-policy" + click c1 "../drivers/common.html#webdav-policy" +```