Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update some docs about yutto #439

Merged
merged 5 commits into from
Dec 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## 💥 A global resource download orchestration system

![Python](https://img.shields.io/badge/python-3.10-blue) [![GitHub release](https://img.shields.io/github/v/release/opennaslab/kubespider.svg)](https://github.com/opennaslab/kubespider/releases) [![Total Downloads](https://img.shields.io/docker/pulls/cesign/kubespider.svg)](https://hub.docker.com/repository/docker/cesign/kubespider/general) [![GitHub stars](https://img.shields.io/github/stars/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/stargazers) [![GitHub license](https://img.shields.io/github/license/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/blob/master/LICENSE)
![Python](https://img.shields.io/badge/python-3.11-blue) [![GitHub release](https://img.shields.io/github/v/release/opennaslab/kubespider.svg)](https://github.com/opennaslab/kubespider/releases) [![Total Downloads](https://img.shields.io/docker/pulls/cesign/kubespider.svg)](https://hub.docker.com/repository/docker/cesign/kubespider/general) [![GitHub stars](https://img.shields.io/github/stars/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/stargazers) [![GitHub license](https://img.shields.io/github/license/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/blob/master/LICENSE)

We are a community of individuals who share a passion for life and have come together based on shared interests and needs. In our free time, we collaborated to develop Kubespider.

Expand All @@ -17,6 +17,7 @@ After being exposed to Terraform and its great versatility, we were inspired to
## ⛵ System architecture

To realize a general download orchestration system, it is necessary to adapt various resource websites and download software, so these two parts are abstracted from the core functions: ![image](../images/kubespider-architecture.png)

* `kubespider-core`: The core module of Kubespider accepts the trigger download request, calls the resource provider for resolution (it will eventually be resolved into a standard mode, such as the user enters the bilibili blogger address, and the corresponding resource provider outputs the mp4 file address download list), and finally calls the download provider to implement Download; this module will also periodically call providers (such as TV series provider) to download additional resources.
* `source-provider`:The provider of each resource website accepts input of general resource addresses, and outputs standard resource address URLs, such as the personal homepage of a YouTuber, and outputs all mp4 download addresses of the blogger’s videos. The configuration file is in `.config/source_provider.yaml`.
* `download-provider`:The provider of each download software receives the request task from `kubespider-core`, and calls the corresponding service to realize the download. The configuration file is in `.config/download_provider.yaml`.
Expand Down Expand Up @@ -129,6 +130,7 @@ In order to make full use of the existing download software in the open-source c
| you-get | Yes | [link](../zh/user_guide/youget_download_provider/README.md) |
| yt-dlp | Yes | [link](../zh/user_guide/ytdlp_download_provider/README.md) |
| transmission | Yes | [link](../zh/user_guide/transmission_download_provider/README.md) |
| yutto | Yes | [link](../zh/user_guide/yutto_download_provider/README.md) |

### Basic feature

Expand Down Expand Up @@ -199,6 +201,7 @@ Thanks to the following companies for sponsoring development tools, the ranking
## 📃 Disclaimer

All downloading and use of the software are deemed to have carefully read and fully agreed to the following terms:

* The software is only for personal learning and communication, and it is strictly prohibited for commercial and bad purposes.
* If any commercial behavior and bad use are found, the software author has the right to revoke the right to use.
* The risk of using this software will be entirely borne by him, and the software author will not bear any responsibility.
Expand Down
5 changes: 4 additions & 1 deletion docs/zh/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## 💥 一款全局资源编排下载系统

![Python](https://img.shields.io/badge/python-3.10-blue) [![GitHub release](https://img.shields.io/github/v/release/opennaslab/kubespider.svg)](https://github.com/opennaslab/kubespider/releases) [![Total Downloads](https://img.shields.io/docker/pulls/cesign/kubespider.svg)](https://hub.docker.com/repository/docker/cesign/kubespider/general) [![GitHub stars](https://img.shields.io/github/stars/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/stargazers) [![GitHub license](https://img.shields.io/github/license/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/blob/master/LICENSE)
![Python](https://img.shields.io/badge/python-3.11-blue) [![GitHub release](https://img.shields.io/github/v/release/opennaslab/kubespider.svg)](https://github.com/opennaslab/kubespider/releases) [![Total Downloads](https://img.shields.io/docker/pulls/cesign/kubespider.svg)](https://hub.docker.com/repository/docker/cesign/kubespider/general) [![GitHub stars](https://img.shields.io/github/stars/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/stargazers) [![GitHub license](https://img.shields.io/github/license/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/blob/master/LICENSE)

我们是一群热爱生活的人,因兴趣和共同需求聚集在一起,利用空闲时间共同开发了 Kubespider。

Expand All @@ -17,6 +17,7 @@
## ⛵ 系统架构

为了实现一个通用的下载编排系统,需要适配各种资源网站和下载软件,所以将这两部分从核心功能中抽象出来: ![image](../images/kubespider-architecture.png)

* `kubespider-core`:Kubespider核心模块,接受触发下载请求,调用资源提供器provider解析(最终会解析为标准模式,如用户输入bilibili博主地址,对应资源提供器输出mp4文件地址下载列表),最后调用下载提供器provider实现下载;此模块同时也会周期调用providers(如追剧provider),下载增加的资源。
* `source-provider`:各资源网站的提供器,接受通用资源地址输入,输出为标准资源地址url,如输入为某个bilibili博主的个人主页,输出为博主视频的所有mp4下载地址。配置文件在`.config/source_provider.yaml`。
* `download-provider`:各下载软件的提供器,接收`kubespider-core`的请求Task,调用对应的服务实现下载。配置文件在`.config/download_provider.yaml`。
Expand Down Expand Up @@ -133,6 +134,7 @@ Kubespider结合chrome插件,能获得更好的体验。
| you-get | 是 | [link](./user_guide/youget_download_provider/README.md) |
| yt-dlp | 是 | [link](./user_guide/ytdlp_download_provider/README.md) |
| transmission | 是 | [link](./user_guide/transmission_download_provider/README.md) |
| yutto | 是 | [link](./user_guide/yutto_download_provider/README.md) |

### 基本特性

Expand Down Expand Up @@ -204,6 +206,7 @@ Kubespider结合chrome插件,能获得更好的体验。
## 📃 免责声明

一切下载及使用软件时均被视为已经仔细阅读并完全同意以下条款:

* 软件仅供个人学习与交流使用,严禁用于商业以及不良用途。
* 如有发现任何商业行为以及不良用途,软件作者有权撤销使用权。
* 使用本软件所存在的风险将完全由其本人承担,软件作者不承担任何责任。
Expand Down
8 changes: 4 additions & 4 deletions docs/zh/user_guide/yutto_download_provider/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# yutto 下载提供器安装和配置
## 简介
[yutto](https://github.com/yutto-dev/yutto) 是一个开源的命令行工具, 一个可爱且任性的 B 站视频下载器(bilili V2)。
[yutto](https://github.com/yutto-dev/yutto) 是一个开源的命令行工具,一个可爱且任性的 B 站视频下载器(bilili V2)。

## 最终效果
效果如图,结合You-Get,Kubespider会调用You-Get,下载Bilibili视频:
效果如图,结合 yutto,Kubespider会调用 yutto,下载Bilibili视频:

![img](images/yutto_final_show.gif)

Expand Down Expand Up @@ -62,8 +62,8 @@ yutto:
* 名称,可自定义(不可重复),可以在 `source_provider.yaml` 中按名称指定下载器。
* `type`: 表示此下载器的类型,需为 `yutto_download_provider`。
* `enable`: 设置是否使用此provider。
* `http_endpoint_host`: yttto下载软件IP地址
* `http_endpoint`: yttto下载软件IP端口
* `http_endpoint_host`: yutto下载软件IP地址
* `http_endpoint`: yutto下载软件IP端口
* `priority`: 下载提供器优先级,数字越小,优先级越高,下载资源时按优先级尝试,无法下载或下载失败时切换下载器。

### 2.测试下载
Expand Down
Loading