doc: add doc about yutto

Signed-off-by: richardli1598 <opennaslab@gmail.com>
opennaslab · Dec 16, 2023 · 3a7af57 · 3a7af57
1 parent f55eab6
commit 3a7af57
Show file tree

Hide file tree

Showing 13 changed files with 188 additions and 59 deletions.
diff --git a/.config/source_provider.yaml b/.config/source_provider.yaml
@@ -20,7 +20,7 @@ meijutt_source_provider:
 bilibili_source_provider:
   type: bilibili_source_provider
   enable: true
-  downloader: youget
+  downloader: yutto
 youtube_source_provider:
   type: youtube_source_provider
   enable: true
@@ -62,7 +62,7 @@ douyin_source_provider:
 bilibili_vlogger_subscribe_source_provider:
   enable: false
   type: bilibili_vlogger_subscribe_source_provider
-  downloader: youget
+  downloader: yutto
   vlogger:
     - 367877
 alist_source_provider:

diff --git a/README-CN.md b/README-CN.md
@@ -10,13 +10,13 @@
 [![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)
 
-[English](./README.md) | 简体中文  
+[English](./README.md) | 简体中文
 
 [安装](#-安装) | [配置](#-特性列表) | [开发者群](https://t.me/opennaslab)
 
-我们是一群热爱生活的人，因兴趣和共同需求聚集在一起，利用空闲时间共同开发了 Kubespider。  
+我们是一群热爱生活的人，因兴趣和共同需求聚集在一起，利用空闲时间共同开发了 Kubespider。
 
-开发Kubespider的出发点是：局域网有一台空闲的服务器，想把它作为NAS，实现自动追剧下载，本地笔记本电脑触发下载，同时适配各种网站资源（Youtube、Bilibili等）和资源类型（电视剧、电影、音乐等）。  
+开发Kubespider的出发点是：局域网有一台空闲的服务器，想把它作为NAS，实现自动追剧下载，本地笔记本电脑触发下载，同时适配各种网站资源（Youtube、Bilibili等）和资源类型（电视剧、电影、音乐等）。
 
 之前接触到Terraform，惊讶于其通用性。Kubespider受到Terraform启发，旨在构建一个通用的下载编排系统，兼容各种资源平台和下载软件，兼容多种下载方式（请求触发，周期触发，更新触发），做资源下载最完美的统一解决方案。
 
@@ -80,22 +80,23 @@ Aria2 default secret is:kubespider
 * 配置文件默认在 `${HOME}/kubespider/.config`。
 
 #### 2.连接aria2
-为了便于查看下载任务，需要下载Chrome插件AriNg:(1)如果你能访问外网，在chrome商店下载[AriaNg](https://chrome.google.com/webstore/detail/aria2-for-chrome/mpkodccbngfoacfalldjimigbofkhgjn)；(2)如果不能，在Crx4Chrome下载[AriaNg](https://www.crx4chrome.com/crx/85196/)。  
+为了便于查看下载任务，需要下载Chrome插件AriNg:(1)如果你能访问外网，在chrome商店下载[AriaNg](https://chrome.google.com/webstore/detail/aria2-for-chrome/mpkodccbngfoacfalldjimigbofkhgjn)；(2)如果不能，在Crx4Chrome下载[AriaNg](https://www.crx4chrome.com/crx/85196/)。
 
 然后连接，插件配置如下(显示在脚本`install_kubespider.sh`执行输出最后)：
 ![img](./docs/images/aria2-for-chrome-config-zh.jpg)
 
 当然，非必需的，你也可以使用桌面程序连接：[AriaNg](https://github.com/mayswind/AriaNg-Native/releases/)
 
 #### 3.安装Chrome插件
-Kubespider结合chrome插件，能获得更好的体验。  
-在步骤1下载代码后，打开Chrome，按如下步骤安装Kubespider Chrome插件并且设置(其中地址为`http://<server_ip>:3080`):  
+Kubespider结合chrome插件，能获得更好的体验。
+
+在步骤1下载代码后，打开Chrome，按如下步骤安装Kubespider Chrome插件并且设置(其中地址为`http://<server_ip>:3080`):
 ![img](./docs/images/kubespider-chrome-ext-install.gif)
 
 例如，我想要下载一个torrent的大文件，直接右键，发送给Kubespider即可([示例网站](https://ubuntu.com/download/alternative-downloads)):
 ![img](./docs/images/kubespider-chrome-ext-usage.png)
 
-然后，使用aria2 Chrome插件查看下载任务，你可以看见下载任务已开始：  
+然后，使用aria2 Chrome插件查看下载任务，你可以看见下载任务已开始：
 ![img](./docs/images/kubespider-chrome-ext-aria2.png)
 
 #### 4.更多（可选）
@@ -112,7 +113,7 @@ Kubespider结合chrome插件，能获得更好的体验。
 * 在绿联NAS上安装Kubespider, 请参考 [link](./docs/zh/user_guide/ugreen_installation/README.md)。
 
 ## 📝 配置
-全局配置文件在`.config/kubespider.yaml`，安装后默认位于`${HOME}/kubespider/.config/kubespider.yaml`，各配置项解释如下：  
+全局配置文件在`.config/kubespider.yaml`，安装后默认位于`${HOME}/kubespider/.config/kubespider.yaml`，各配置项解释如下：
 | 配置项                          | 是否必配 |                                                                    功能 |
 | :------------------------------ | -------: | ----------------------------------------------------------------------: |
 | `proxy`                         |       否 |                                   请求代理，如`http://192.168.1.5:1087` |
@@ -148,6 +149,7 @@ Kubespider结合chrome插件，能获得更好的体验。
 | you-get      |       是 |       [link](./docs/zh/user_guide/youget_download_provider/README.md) |
 | yt-dlp       |       是 |        [link](./docs/zh/user_guide/ytdlp_download_provider/README.md) |
 | transmission |       是 | [link](./docs/zh/user_guide/transmission_download_provider/README.md) |
+| yutto        |       是 |        [link](./docs/zh/user_guide/yutto_download_provider/README.md) |
 
 ### 消息通知提供器(按需配置)
 为了充分利用开源社区已有的消息通知软件，目前支持如下消息通知软件：
@@ -186,7 +188,7 @@ Kubespider结合chrome插件，能获得更好的体验。
 
 如果你想更多的参与社区，欢迎加入我们的 [Telegram开发者群](https://t.me/opennaslab).
 
-## ❤️ 赞助  
+## ❤️ 赞助
 感谢以下公司赞助开发工具，排名不分先后：
 <table>
   <thead>

diff --git a/README.md b/README.md
@@ -11,13 +11,13 @@
 [![GitHub license](https://img.shields.io/github/license/opennaslab/kubespider?style=plastic)](https://github.com/opennaslab/kubespider/blob/master/LICENSE)
 
 
-English | [简体中文](./README-CN.md)  
+English | [简体中文](./README-CN.md)
 
 [Installation](#-installation) | [Configuration](#-feature-list) | [Developer Group](https://t.me/opennaslab)
 
-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.  
+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.
 
-Kubespider is developed to utilize an idle server in a local area network as a NAS, enabling automatic downloads of TV series, triggering downloads from a local laptop, and adapting to various websites such as YouTube and BiliBili, as well as different types of resources such as TV series, movies, music and more.  
+Kubespider is developed to utilize an idle server in a local area network as a NAS, enabling automatic downloads of TV series, triggering downloads from a local laptop, and adapting to various websites such as YouTube and BiliBili, as well as different types of resources such as TV series, movies, music and more.
 
 After being exposed to Terraform and its great versatility, we were inspired to create Kubespider as a general download orchestration system that is compatible with various resource platforms and download software. Kubespider supports multiple download methods, including request trigger, cycle trigger, and update trigger, making it the most comprehensive and unified solution for resource downloads.
 
@@ -78,21 +78,22 @@ Aria2 default secret is:kubespider
 * Configuration files are located in `${HOME}/kubespider/.config` by default.
 
 #### 2.Connect to aria2
-For checking the download tasks on your server conveniently, go to the chrome store to download [AriaNg plugin](https://chrome.google.com/webstore/detail/aria2-for-chrome/mpkodccbngfoacfalldjimigbofkhgjn).  
+For checking the download tasks on your server conveniently, go to the chrome store to download [AriaNg plugin](https://chrome.google.com/webstore/detail/aria2-for-chrome/mpkodccbngfoacfalldjimigbofkhgjn).
 Then connect, the plugin configuration is as follows(shown at the end of the script `install_kubespider.sh` execution output):
 ![img](./docs/images/aria2-for-chrome-config-en.jpg)
 
 Of course, it is not necessary, you can also use the desktop program to connect: [AriaNg](https://github.com/mayswind/AriaNg-Native/releases/)
 
 #### 3.Install Chrome plugin
-With Kubespider Chrome plugin, you can get a better experience.  
-After step 1 has been done, open chrome, then install Kubespider plugin, and configure it as follows(The server address is `http://<server_ip>:3080`):  
+With Kubespider Chrome plugin, you can get a better experience.
+
+After step 1 has been done, open chrome, then install Kubespider plugin, and configure it as follows(The server address is `http://<server_ip>:3080`):
 ![img](./docs/images/kubespider-chrome-ext-install.gif)
 
 For example, if I want to download a torrent-related file, I can right click and send the download task to Kubespider([demo website](https://ubuntu.com/download/alternative-downloads)):
 ![img](./docs/images/kubespider-chrome-ext-usage.png)
 
-Then with aria2 chrome plugin, you can see the download task starts:  
+Then with aria2 chrome plugin, you can see the download task starts:
 ![img](./docs/images/kubespider-chrome-ext-aria2.png)
 
 #### 4.More (Optional)
@@ -119,7 +120,7 @@ The global configuration file is located at `.config/kubespider.yaml`, which is
 | `server_port`                   |       No |                                                                                                                             The port used to provider API service |
 
 ## 🔧 Feature list
-### Source provider(Configured as needed)  
+### Source provider(Configured as needed)
 As mentioned before, the source provider is used to adapt to different websites, and download related resources based on the conditions:
 | Source Provider                            | Support |                                                                    Purpose |                                                                     Configuration |
 | :----------------------------------------- | ------: | -------------------------------------------------------------------------: | --------------------------------------------------------------------------------: |
@@ -136,7 +137,7 @@ As mentioned before, the source provider is used to adapt to different websites,
 | ANi source provider                        |     Yes |                                    Fully automated anime download from ANi |                        [link](./docs/zh/user_guide/ani_source_provider/README.md) |
 
 
-### Download provider(Configured as needed)  
+### Download provider(Configured as needed)
 In order to make full use of the existing download software in the open-source community(For example, YouTube has dedicated download software), the following software is currently supported:
 | Download Software | Support |                                                         Configuration |
 | :---------------- | ------: | --------------------------------------------------------------------: |
@@ -146,8 +147,10 @@ In order to make full use of the existing download software in the open-source c
 | you-get           |     Yes |       [link](./docs/zh/user_guide/youget_download_provider/README.md) |
 | yt-dlp            |     Yes |        [link](./docs/zh/user_guide/ytdlp_download_provider/README.md) |
 | transmission      |     Yes | [link](./docs/zh/user_guide/transmission_download_provider/README.md) |
+| yutto             |       Yes |        [link](./docs/zh/user_guide/yutto_download_provider/README.md) |
+
 
-### Notification provider(Configured as needed)  
+### Notification provider(Configured as needed)
 In order to make full use of the existing notification software in the open-source community, the following software is currently supported:
 | Notification Software | Support |                                                         Configuration |
 | :-------------------- | ------: | --------------------------------------------------------------------: |
@@ -156,7 +159,7 @@ In order to make full use of the existing notification software in the open-sour
 | QQ                    |     Yes |       [link](./docs/zh/user_guide/qq_notification_provider/README.md) |
 | Bark                  |     Yes |     [link](./docs/zh/user_guide/bark_notification_provider/README.md) |
 
-### Basic feature  
+### Basic feature
 Currently, the following file types are supported to trigger downloading:
 | Download Types          | Support |
 | :---------------------- | ------: |
@@ -184,7 +187,7 @@ If you are interested in participating in joint development, welcome to STAR/FOR
 If you want to participate more in the community, welcome to join our [Telegram developer group](https://t.me/opennaslab).
 
 
-## ❤️ Sponsor  
+## ❤️ Sponsor
 Thanks to the following companies for sponsoring development tools, the ranking is not in any particular order:
 <table>
   <thead>

diff --git a/docs/zh/user_guide/bilibili_source_provider/README.md b/docs/zh/user_guide/bilibili_source_provider/README.md
@@ -1,7 +1,7 @@
 # Bilibili资源提供器配置
 ## 简介
 哔哩哔哩（Bilibili）是一家中国的在线视频分享和弹幕评论平台，于2009年创建。它最初定位为ACG（动画、漫画、游戏）文化社区，但现在已扩展到包括音乐、舞蹈、科技、生活等各种领域。用户可以在B站上观看和上传视频，并与其他用户互动交流。B站以其丰富的内容、独特的弹幕系统和活跃的用户群体而闻名。
-官方地址：[bilibili.com](https://bilibili.com/)  
+官方地址：[bilibili.com](https://bilibili.com/)
 本资源提供器旨在实现**链接触发下载**，简化下载流程。
 
 ## 最终效果
@@ -10,7 +10,7 @@
 
 ## 配置
 ### 1.前提
-你已经安装并配置好You-Get下载器，并对接Kubespider；如果未安装，请先参照 [link](../youget_download_provider/README.md) 安装。
+你已经安装并配置好You-Get下载器，并对接Kubespider；如果未安装，请先参照 [link](../yutto_download_provider/README.md) 安装。
 
 ### 2.配置手册
 你可以通过`${HOME}/kubespider/.config/source_provider.yaml`配置，配置解释如下：
@@ -19,7 +19,7 @@
 bilibili_source_provider:
   type: bilibili_source_provider
   enable: true
-  downloader: youget
+  downloader: yutto
 ```
 
 * `type`：订阅源类型，需为`bilibili_source_provider`。

diff --git a/docs/zh/user_guide/bilibili_vlogger_subscribe_source_provider/README.md b/docs/zh/user_guide/bilibili_vlogger_subscribe_source_provider/README.md
@@ -3,21 +3,21 @@
 B站上面有许多优秀的博主，有时期待自动下载更新的视频。所以本资源提供器旨在实现**自动下载博主更新视频**，简化下载流程。
 
 ## 最终效果
-最终效果如下图，在配置好后，会自动检查博主更新视频，自动下载（此处借助youget下载）：
+最终效果如下图，在配置好后，会自动检查博主更新视频，自动下载（此处借助yutto下载）：
 ![img](images/final_show.png)
 
 ## 配置
 ### 1.前提
 1. 你已经安装好了Kubespider/Kubespider chrome插件。
-2. 配置安装好youget downloader，如果没有请参考 [link](../youget_download_provider/README.md)
+2. 配置安装好yutto downloader，如果没有请参考 [link](../yutto_download_provider/README.md)
 
 ### 2.配置手册
 你可以通过`${HOME}/kubespider/.config/source_provider.yaml`配置，配置解释如下：
 ```yaml
 bilibili_vlogger_subscribe_source_provider:
   type: bilibili_vlogger_subscribe_source_provider
   enable: false
-  downloader: youget
+  downloader: yutto
   vlogger:
     - 367877
 ```
@@ -32,18 +32,18 @@ bilibili_vlogger_subscribe_source_provider:
   bilibili_vlogger_subscribe_source_provider:
   type: bilibili_vlogger_subscribe_source_provider
   enable: false
-  downloader: youget
+  downloader: yutto
   vlogger:
     - 367877
     - 367878
   ```
 
 
 ## 测试
-设置好后，保存文件后Kubespider会自动启动，触发下载，并追更。你可以通过查看youget下载器的日志查看下载进度：
+设置好后，保存文件后Kubespider会自动启动，触发下载，并追更。你可以通过查看yutto下载器的日志查看下载进度：
 
 ```sh
-$ docker logs -f youget
+$ docker logs -f yutto
 ```
 
-默认下载路径为 `VideoMixed`。 
+默认下载路径为 `VideoMixed`。
diff --git a/docs/zh/user_guide/youget_download_provider/README.md b/docs/zh/user_guide/youget_download_provider/README.md
@@ -2,8 +2,8 @@
 ## 简介
 [You-Get](https://github.com/soimort/you-get) 是一个开源的命令行工具，用于从互联网上下载视频、音频和其他类型的媒体资源。它支持多种视频和音频网站，包括YouTube、Vimeo、Twitch、SoundCloud等。用户可以通过简单的命令行输入来下载他们想要的各种媒体文件。You-Get还支持多线程下载，因此可以更快地下载大型文件。
 
-## 最终效果
-效果如图，结合You-Gey，Kubespider会调用You-Get，下载Bilibili视频：
+## 最终效果（现在You-Get缺乏维护，请使用yutto或者yt-dlp）
+效果如图，结合You-Get，Kubespider会调用You-Get，下载Bilibili视频：
 ![img](images/youget_final_show.gif)
 
 ## 安装
@@ -16,7 +16,7 @@ bash hack/install_youget.sh
 ```
 
 ### 2.确认安装
-运行如下命令，确认迅雷已经安装成功：
+运行如下命令，确认You-Get已经安装成功：
 ```sh
 docker ps | grep youget
 ```
@@ -30,25 +30,31 @@ docker ps | grep youget
 为了下载高清视频，有时候需要设置认证cookie，各资源网站的cookie设置如下：
 
 #### Bilibili下载设置
-1.打开chrome的隐身模式  
+1.打开chrome的隐身模式
+
 <img src='images/bilibili_config_step1.png' style="width: 600px;">
 
-2.登陆bilibili  
+2.登陆bilibili
+
 <img src='images/bilibili_config_step2.png' style="width: 600px;">
 
-3.F12选择network，查看cookie信息  
-<img src='images/bilibili_config_step3.png' style="width: 600px;">  
+3.F12选择network，查看cookie信息
+
+<img src='images/bilibili_config_step3.png' style="width: 600px;">
 找到关键信息并复制：`SESSDATA=xxx; bili_jct=xxx;`
 找到并复制后关闭窗口。
 
-4.在chrome市场安装插件`Get cookies.txt LOCALLY`  
-<img src='images/bilibili_config_step4.png' style="width: 600px;">  
-下载地址：[link](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc?hl=en)  
+4.在chrome市场安装插件`Get cookies.txt LOCALLY`
+
+<img src='images/bilibili_config_step4.png' style="width: 600px;">
+
+下载地址：[link](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc?hl=en)
+
+5.复制bilibili完整cookie(非隐身模式)
 
-5.复制bilibili完整cookie(非隐身模式)  
 <img src='images/bilibili_config_step5.png' style="width: 600px;">
 
-6.将复制内容拷贝到`${HOME}/kubespider/youget/bilibili_cookie.txt`  
+6.将复制内容拷贝到`${HOME}/kubespider/youget/bilibili_cookie.txt`
 ```txt
 # Netscape HTTP Cookie File
 # http://curl.haxx.se/rfc/cookie_spec.html