Merge pull request EstrellaXD#625 from Geeksun2018/main

setting qbittorrent doesn't create sub folders
rxstella · Nov 22, 2023 · f0fb39f · f0fb39f
2 parents 7bee913 + f96aa03
commit f0fb39f
Show file tree

Hide file tree

Showing 42 changed files with 361 additions and 419 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -6,8 +6,8 @@ body:
   - type: markdown
     attributes:
       value: |
-        描述问题前，请先更新到最新版本。2.5 之前的版本升级请参考 [升级指南](https://www.autobangumi.org/changelog/2.6.html#如何从老版本更新的注意事项)
-        请确认以下信息，如果你的问题可以直接在文档中找到，那么你的 issue 将会被直接关闭。
+        描述问题前，请先更新到最新版本。
+        请确认以下信息，如果你没有完成以下检查，那么你的 issue 将会被直接关闭。
         解析器问题请转到[专用模板](https://github.com/EstrellaXD/Auto_Bangumi/issues/new?assignees=&labels=bug&template=parser_bug.yml&title=%5B解析器错误%5D)，
         重命名问题请到[专用模板](https://github.com/EstrellaXD/Auto_Bangumi/issues/new?assignees=&labels=bug&template=rename_bug.yml&title=%5B重命名错误%5D)
   - type: checkboxes

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -178,3 +178,13 @@ gitGraph:
 
 而新功能的发版时间则会更长而且不定，你可以在我们的 [GitHub Project](https://github.com/EstrellaXD/Auto_Bangumi/projects?query=is%3Aopen) 看板中看到开发进度，一个版本规划的新功能都开发完备后就会发版。
 
+## 贡献文档
+
+如果要为文档做贡献，请注意以下几点：
+
+- 更新分支为 `docs-update`，并基于它做修改.
+- 请确保你的 PR 标题和描述中包含了你的修改的目的和意图。
+
+撰写文档请尽量使用规范的书面化用语，遵照 Markdown 语法，以及 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines) 中的规范。
+
+
diff --git a/backend/src/module/downloader/client/qb_downloader.py b/backend/src/module/downloader/client/qb_downloader.py
@@ -90,6 +90,7 @@ def add_torrents(self, torrent_urls, torrent_files, save_path, category):
             save_path=save_path,
             category=category,
             use_auto_torrent_management=False,
+            content_layout="NoSubFolder"
         )
         return resp == "Ok."
 

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -14,7 +14,6 @@ export default defineConfig({
         ['meta', {property: 'og:image', content: '/social.png'}],
         ['meta', {property: 'og:site_name', content: 'AutoBangumi'}],
         ['meta', {property: 'og:url', content: 'https://www.autobangumi.org'}],
-        ["script", {src: '/_vercel/insights/script.js'}]
     ],
 
     themeConfig: {
@@ -25,7 +24,7 @@ export default defineConfig({
         },
 
         editLink: {
-            pattern: 'https://github.com/vitejs/vite/blob/3.1-dev/docs/:path',
+            pattern: 'https://github.com/EstrellaXD/Auto_Bangumi/edit/main/docs/:path',
             text: 'Edit this page',
         },
 
@@ -86,21 +85,8 @@ export default defineConfig({
                         link: "/deploy/dsm",
                     },
                     {
-                        text: "WSL",
-                        link: "/deploy/wsl",
-                    },
-                ],
-            },
-            {
-                text: "源码运行",
-                items: [
-                    {
-                        text: "Windows 本地部署",
-                        link: "/deploy/windows",
-                    },
-                    {
-                        text: "Unix 本地部署",
-                        link: "/deploy/unix",
+                        text: "本地部署",
+                        link: "/deploy/local",
                     },
                 ],
             },
@@ -148,6 +134,10 @@ export default defineConfig({
                         text: "RSS 管理",
                         link: "/feature/rss",
                     },
+                    {
+                        text: "番剧管理",
+                        link: "/feature/bangumi",
+                    },
                     {
                         text: "重命名",
                         link: "/feature/rename",
@@ -171,7 +161,7 @@ export default defineConfig({
                     },
                     {
                         text: "网络问题",
-                        link: "/faq/mikan-network",
+                        link: "/faq/network",
                     }
                 ],
             },

diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -11,6 +11,7 @@ import mediumZoom from 'medium-zoom'
 import Documate from '@documate/vue'
 import '@documate/vue/dist/style.css'
 import HomePreviewWebUI from './components/HomePreviewWebUI.vue'
+import googleAnalytics from 'vitepress-plugin-google-analytics'
 
 import './style.css'
 
@@ -21,7 +22,7 @@ export default {
             // https://vitepress.dev/guide/extending-default-theme#layout-slots
             'home-features-after': () => h(HomePreviewWebUI),
             'nav-bar-content-before': () => h(Documate, {
-                endpoint: '',
+                endpoint: 'https://kp35gyb313.us.aircode.run/ask',
             }),
         })
     },
@@ -44,7 +45,9 @@ export default {
             () => nextTick(initZoom),
         )
     },
-    enhanceApp({app, router, siteData}) {
-        // ...
-    }
+    enhanceApp: (ctx) => {
+    googleAnalytics({
+      id: 'G-3Z8W6WMN7J',
+    })
+  },
 }
diff --git a/docs/config/downloader.md b/docs/config/downloader.md
@@ -15,15 +15,19 @@
 
 ### 下载器地址
 
-⚠️**请不要直接使用 127.0.0.1 或 localhost 作为下载器地址。**
+::: warning 注意
+请不要直接使用 127.0.0.1 或 localhost 作为下载器地址。
+:::
 
 由于 AB 在官方教程中是以 **Bridge** 模式运行在 Docker 中的，如果你是用 127.0.0.1 或者 localhost 那么 AB 将会把这个地址解析为自身，而非下载器。
 - 如果此时你的 qBittorrent 也运行在 Docker 中，那么我们推荐你是用 Docker 的 **网关地址：172.17.0.1**。
 - 如果你的 qBittorrent 运行在宿主机上，那么你需要使用宿主机的 IP 地址。
 
 如果你以 **Host** 模式运行 AB，那么你可以直接使用 127.0.0.1 代替 Docker 网关地址。
 
-⚠️ Macvlan 会隔离容器的网络，此时如果你不做额外的网桥配置将无法访问同宿主机的其他容器或者主机本身。
+::: warning 注意
+Macvlan 会隔离容器的网络，此时如果你不做额外的网桥配置将无法访问同宿主机的其他容器或者主机本身。
+:::
 
 ### 下载器路径问题
 

diff --git a/docs/config/experimental.md b/docs/config/experimental.md
@@ -3,9 +3,8 @@
 ::: warning 警告
 实验功能尚处于测试阶段，开启后可能会导致预料之外的问题并且在未来某些版本中很可能被移除，请谨慎使用！
 :::
-## OpenAI ChatGPT
 
-![experimental](../image/config/experimental.png){width=500}{class=ab-shadow-card}
+## OpenAI ChatGPT
 
 使用 OpenAI ChatGPT 以获得更好的标题结构化解析效果，例如：
 
@@ -14,12 +13,34 @@ input: "【喵萌奶茶屋】★04月新番★[夏日重现/Summer Time Renderin
 output: '{"group": "喵萌奶茶屋", "title_en": "Summer Time Rendering", "resolution": "1080p", "episode": 11, "season": 1, "title_zh": "夏日重现", "sub": "", "title_jp": "", "season_raw": "", "source": ""}'
 ```
 
+![experimental OpenAI](../image/config/experimental-openai.png){width=500}{class=ab-shadow-card}
+
 - **Enable OpenAI** 为是否开启 OpenAI 并使用 ChatGPT 用于标题解析。
+- **OpenAI API Type** 默认为 OpenAI。
 - **OpenAI API Key** 为 OpenAI 账户的 API Key。
 - **OpenAI API Base URL** 为 OpenAI 接口地址，默认情况下为 OpenAI 官方地址；你也可以根据自己的需要修改成其他兼容 OpenAI 服务的第三方地址。
 - **OpenAI Model** 为 ChatGPT 的 `model` 模型参数，目前仅提供了 `gpt-3.5-turbo`，因为它足够便宜并且在 Prompt 的加持下可以得到相当不错的效果。
 
-### `config.json` 中的配置选项
+## Microsoft Azure OpenAI
+
+
+![experimental Microsoft Azure Openai](../image/config/experimental-azure-openai.png){width=500}{class=ab-shadow-card}
+
+除了原始的 OpenAI 之外，在 [3.18 版本](https://github.com/EstrellaXD/Auto_Bangumi/releases/tag/3.1.8) 中我们还加入了 Microsoft Azure OpenAI 的支持，它的使用方法与原始的 OpenAI 一致，部分参数共用，但是在填写参数时可能有几个地方需要注意：
+
+- **Enable OpenAI** 为是否开启 OpenAI 并使用 ChatGPT 用于标题解析。
+- **OpenAI API Type** 选择 `azure` 之后才会出现对应的参数选项。
+- **OpenAI API Key** 为 Microsoft Azure OpenAI 账户的 API Key。
+- **OpenAI API Base URL** 对应 Microsoft Azure OpenAI 的 Entrypoint，**需要你手动填写**。
+- **Azure OpenAI Version** 对应 Microsoft Azure OpenAI 的 API 版本，默认为 `2023-05-15`，可参考 [所支持的版本](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#completions)。
+- **Azure OpenAI Deployment ID** 对应 Microsoft Azure OpenAI 的 Deployment ID，通常与模型名称相同，需要注意的是 Microsoft Azure OpenAI 不支持除 `_-` 之外的符号，因此原始 OpenAI 中的 `gpt-3.5-turbo` 在 Microsoft Azure OpenAI 中实际为 `gpt-35-turbo`，此处**需要你手动填写**。
+
+参考文档：
+
+- [Quickstart: Get started using GPT-35-Turbo and GPT-4 with Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/chatgpt-quickstart?tabs=command-line&pivots=programming-language-python)
+- [Learn how to work with the GPT-35-Turbo and GPT-4 models](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/chatgpt?pivots=programming-language-chat-completions)
+
+## `config.json` 中的配置选项
 
 在配置文件中对应选项如下：
 
@@ -28,6 +49,9 @@ output: '{"group": "喵萌奶茶屋", "title_en": "Summer Time Rendering", "reso
 | 参数名     | 参数说明       | 参数类型 | WebUI 对应选项 | 默认值      |
 |---------|------------|------|------------|----------|
 | enable  | 是否启用 OpenAI 解析器    | 布尔值  | 启用 OpenAI         | false    |
+| api_type   | OpenAI API 类型       | 字符串  | OpenAI API 类型，可选 `openai` 和 `azure`       | openai |
 | api_key    | OpenAI API Key       | 字符串  | OpenAI API Key       | |
-| api_base   | OpenAI API Base URL   | 字符串  | OpenAI API Base URL   | https://api.openai.com/v1 |
-| model | OpenAI 模型 | 字符串  | OpenAI 模型 | gpt-3.5-turbo
+| api_base   | OpenAI API Base URL(Azure entrypoint)   | 字符串  | OpenAI API Base URL   | https://api.openai.com/v1 |
+| model | OpenAI 模型 | 字符串  | OpenAI 模型 | gpt-3.5-turbo |
+| api_version | Azure OpenAI API 版本 | 字符串  | Azure OpenAI API 版本 | 2023-05-15 |
+| deployment_id | Azure OpenAI Deployment ID | 字符串  | Azure OpenAI Deployment ID |  |
diff --git a/docs/config/manager.md b/docs/config/manager.md
@@ -14,7 +14,8 @@
 - **Eps complete** 为是否补全当季番剧，如果开启，则会补全当季番剧，如果关闭，则不会补全当季番剧。
 - **Add group tag** 为是否在下载规则中添加番剧组标签，如果开启，则会在下载规则中添加番剧组标签。
 - **Delete bad torrent** 为是否删除错误的种子，如果开启，则会删除错误的种子。
-- [文件路径以及重命名相关][1]
+- [关于文件路径][1]
+- [关于重命名][2]
 
 ## `config.json` 中的配置选项
 
@@ -31,4 +32,5 @@
 | remove_bad_torrent | 是否删除错误的种子       | 布尔值  | 种子删除       | false |
 
 
-[1]:   https://www.autobangumi.org/use/%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E.html#%E6%96%87%E4%BB%B6%E8%B7%AF%E5%BE%84%E4%BB%A5%E5%8F%8A%E9%87%8D%E5%91%BD%E5%90%8D%E7%9B%B8%E5%85%B3
+[1]:   https://www.autobangumi.org/faq/#%E4%B8%8B%E8%BD%BD%E4%BB%A5%E5%8F%8A%E5%85%B3%E9%94%AE%E8%AF%8D%E8%BF%87%E6%BB%A4
+[2]:   https://www.autobangumi.org/faq/#%F0%9F%93%81-%E9%87%8D%E5%91%BD%E5%90%8D%E7%9B%B8%E5%85%B3
diff --git a/docs/config/parser.md b/docs/config/parser.md
@@ -2,9 +2,9 @@
 
 AB 的解析器用于解析聚合 RSS 链接，如果 RSS 有新条目更新，AB 就会解析标题并且生成自动下载规则。
 
-## ⚠️ Notice:
-
+::: tip
 v3.1 版本以后解析器设置迁移到各个单独的 RSS 设置中，如果需要配置**解析器类型**，请参考 [为 RSS 设定解析器][add_rss]。
+:::
 
 ## Webui 中的解析器设置
 

diff --git a/docs/config/proxy.md b/docs/config/proxy.md
@@ -13,10 +13,9 @@ AB 支持 HTTP 代理和 SOCKS5 代理，通过设置代理可以解决一些网
 - **Host** 为代理地址。
 - **Port** 为代理端口。
 
-⚠️**注意**:
-
-- 在 HTTP 模式下不支持用户名密码验证，如果你的代理需要用户名密码验证，请使用 **SOCKS5** 模式。
-- 在 **Socks5** 模式下，需要添加用户名和密码。
+::: tip
+在 **Socks5** 模式下，需要添加用户名和密码。
+:::
 
 ## `config.json` 中的配置选项
 

diff --git a/docs/deploy/docker-cli.md b/docs/deploy/docker-cli.md
@@ -10,10 +10,8 @@ AutoBangumi 2.6 版本后支持直接在 WebUI 中配置，你可以选择直接
 
 ```shell
 # 使用 bind mount
-mkdir -p AutoBangumi
-cd AutoBangumi
-mkdir -p ./config
-mkdir -p ./data
+mkdir -p ${HOME}/AutoBangumi/{config,data}
+cd ${HOME}/AutoBangumi
 ```
 
 Bind mount 与 Docker volume 二选一
@@ -32,9 +30,13 @@ docker volume create AutoBangumi_data
 ```shell
 docker run -d \
   --name=AutoBangumi \
-  -v ./config:/app/config \
-  -v ./data:/app/data \
+  -v ${HOME}/AutoBangumi/config:/app/config \
+  -v ${HOME}/AutoBangumi/data:/app/data \
   -p 7892:7892 \
+  -e TZ=Asia/Shanghai \
+  -e PUID=$(id -u) \
+  -e PGID=$(id -g) \
+  -e UMASK=022 \
   --network=bridge \
   --dns=8.8.8.8 \
   --restart unless-stopped \

diff --git a/docs/deploy/docker-compose.md b/docs/deploy/docker-compose.md
@@ -24,10 +24,8 @@ docker compose -v
 ### 创建 AutoBangumi及数据 文件夹
 
 ```bash
-mkdir -p AutoBangumi
-cd AutoBangumi
-mkdir -p config # 如果不存在则会报错
-mkdir -p data
+mkdir -p ${HOME}/AutoBangumi/{config,data}
+cd ${HOME}/AutoBangumi
 ```
 
 ### 选项1: 自定义 Docker Compose 配置文件
@@ -49,7 +47,10 @@ services:
       - 223.5.5.5
     network_mode: bridge
     environment:
-      - AB_METHOD=Advance
+      - TZ=Asia/Shanghai
+      - PGID=$(id -g)
+      - PUID=$(id -u)
+      - UMASK=022
 ```
 
 复制上面的内容到 `docker-compose.yml` 文件中。
@@ -61,15 +62,11 @@ services:
 
 - 只安装 **AutoBangumi**
   ```bash
-  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/AutoBangumi/docker-compose.yml
+  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/resource/docker-compose/AutoBangumi/docker-compose.yml
   ```
 - 安装 **qBittorrent** 与 **AutoBangumi**
   ```bash
-  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
-  ```
-- **qBittorrent** + **AutoBangumi** + **Plex**
-  ```bash
-  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/All-in-one/docker-compose.yml
+  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/resource/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
   ```
 
 首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。

diff --git a/docs/deploy/dsm.md b/docs/deploy/dsm.md
@@ -34,7 +34,11 @@ services:
       - "./data:/app/data"
     network_mode: bridge
     environment:
+      - TZ=Asia/Shanghai
       - AB_METHOD=Advance
+      - PGID=1000
+      - PUID=1000
+      - UMASK=022
 ```
 
 点击 **下一步**，然后点击 **完成**。
@@ -74,6 +78,7 @@ services:
       - TZ=Asia/Shanghai
       - PGID=1000  #需要自行修改填入
       - PUID=1000  #需要自行修改填入
+      - UMASK=022
       - AB_DOWNLOADER_HOST=127.0.0.1:8989  #建议自行修改端口号
     volumes:
       - /volume1/docker/ab/config:/app/config