From 0b035da7f07d2308074a348bac39b0b31cf3af8e Mon Sep 17 00:00:00 2001 From: EstrellaXD Date: Sun, 10 Sep 2023 20:58:11 +0800 Subject: [PATCH] docs: update 3.1 docs. --- docs/.vitepress/config.ts | 28 ++++++------ docs/changelog/3.1.md | 47 ++++++++++++++++++++ docs/config/parser.md | 29 +++++------- docs/config/proxy.md | 26 ++--------- docs/deploy/unix.md | 2 +- docs/deploy/windows.md | 6 +-- docs/faq/{常见问题.md => index.md} | 17 ++++--- docs/faq/{排错流程.md => troubleshooting.md} | 0 docs/{feature => usage}/rename.md | 0 docs/{feature => usage}/rss.md | 0 docs/{use => usage}/使用说明.md | 0 docs/{use => usage}/配置选项说明.md | 0 12 files changed, 86 insertions(+), 69 deletions(-) create mode 100644 docs/changelog/3.1.md rename docs/faq/{常见问题.md => index.md} (92%) rename docs/faq/{排错流程.md => troubleshooting.md} (100%) rename docs/{feature => usage}/rename.md (100%) rename docs/{feature => usage}/rss.md (100%) rename docs/{use => usage}/使用说明.md (100%) rename docs/{use => usage}/配置选项说明.md (100%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 4cc953b9..b73fafbe 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,4 +1,4 @@ -import {defineConfig} from "vitepress"; +import {defineConfig} from 'vitepress'; const version = `v3.1` @@ -46,10 +46,8 @@ export default defineConfig({ nav: [ {text: "项目说明", link: "/home/"}, {text: "快速开始", link: "/deploy/quick-start"}, - // { text: "排错流程", link: "/faq/排错流程" }, - {text: "常见问题", link: "/faq/常见问题"}, + {text: "常见问题", link: "/faq/"}, ], - footer: { message: `AutoBangumi Released under the MIT License. (latest: ${version})`, copyright: 'Copyright © 2021-present @EstrellaXD & AutoBangumi Contributors', @@ -145,19 +143,23 @@ export default defineConfig({ { text: "重命名", link: "/feature/rename", + }, + { + text: "搜索番组", + link: "/feature/search", } ] }, { text: "FAQ", items: [ - // { - // text: "排错流程", - // link: "/faq/排错流程", - // }, { text: "常见问题", - link: "/faq/常见问题", + link: "/faq/", + }, + { + text: "排错流程", + link: "/faq/troubleshooting", }, { text: "网络问题", @@ -176,10 +178,10 @@ export default defineConfig({ text: "3.0 更新说明", link: "/changelog/3.0", }, - // { - // text: "2.6 更新说明", - // link: "/changelog/2.6", - // }, + { + text: "2.6 更新说明", + link: "/changelog/2.6", + }, ], }, { diff --git a/docs/changelog/3.1.md b/docs/changelog/3.1.md new file mode 100644 index 00000000..6834d93c --- /dev/null +++ b/docs/changelog/3.1.md @@ -0,0 +1,47 @@ +# [3.1] - 2023-08 + +- 合并了后端和前端仓库，优化了项目目录 +- 优化了版本发布流程。 +- Wiki 迁移至 Vitepress，地址：https://autobangumi.org + +## Backend + +### Features + +- 新增 `RSS Engine` 模块，从现在起，AB 可以自主对 RSS 进行更新支持 `RSS` 订阅并且发送种子给下载器。 + - 现在支持多个聚合 RSS 订阅源，可以通过 `RSS Engine` 模块进行管理。 + - 支持下载去重功能，重复的订阅的种子不会被下载。 + - 增加手动刷新 API，可以手动刷新 RSS 订阅。 + - 新增 RSS 订阅管理 API。 +- 新增 `Search Engine`模块，可以通过关键词搜索种子并解析成收集或者订阅任务。 + - 插件化的搜索引擎，可以通过插件的方式添加新的搜索目标，目前支持 `mikan`、`dmhy` 和 `nyaa` +- 新增对字幕组的特异性规则，可以针对不同的字幕组进行单独设置。 +- 新增 IPv6 监听支持，需要在环境变量中设置 `IPV6=1`。 +- API 新增批量操作，可以批量管理规则和 RSS 订阅。 + +### Changes + +- 数据库结构变更，更换为 `sqlmodel` 管理数据库。 +- 新增版本管理，可以无缝更新软件数据。 +- 调整 API 格式，更加统一。 +- 增加 API 返回语言选项。 +- 增加数据库 mock test。 +- 优化代码。 + +### Bugfixes + +- 修复了一些小问题。 +- 增加了一些大问题。 + +## Frontend + +### Features + +- 增加 `i18n` 支持，目前支持 `zh-CN` 和 `en-US`。 +- 增加 pwa 支持。 +- 增加 RSS 管理页面。 +- 增加搜索顶栏。 + +### Changes + +- 调整一些 UI 细节。 \ No newline at end of file diff --git a/docs/config/parser.md b/docs/config/parser.md index b771c403..ba1c7ab4 100644 --- a/docs/config/parser.md +++ b/docs/config/parser.md @@ -2,40 +2,33 @@ AB 的解析器用于解析聚合 RSS 链接，如果 RSS 有新条目更新，AB 就会解析标题并且生成自动下载规则。 +## ⚠️ Notice: + +v3.1 版本以后解析器设置迁移到各个单独的 RSS 设置中，如果需要配置**解析器类型**，请参考 [为 RSS 设定解析器][add_rss]。 + ## Webui 中的解析器设置 ![parser](../image/config/parser.png){width=500}{class=ab-shadow-card}
-- **Enable**: 是否启用 RSS 解析器。 -- **Source** 为 RSS 解析器类型，目前支持 `mikan` 。 -- **Token** 为蜜柑计划的 Token。[蜜柑计划 Token 获取][rss_token] -- **Custom_url** 为自定义蜜柑计划地址。[自定义反代地址][reproxy] +- **Enable / 启用**: 是否启用 RSS 解析器。 - **Language** 为 RSS 解析器语言，目前支持 `zh` 、 `jp` 、 `en` 三种语言。 -- **Parser_type** 为 **官方标题** 解析器解析类型，支持类型如下： - - parser 为正则表达式解析器，使用正则表达式解析标题。 - - mikan 为蜜柑计划解析器，使用蜜柑计划解析标题。 - - tmdb 为 TMDB 解析器，使用 TMDB 解析标题。 - **Exclude** 为全局 RSS 解析器过滤器，可以填入字符串或者正则表达式，AB 在解析 RSS 时会过滤掉符合过滤器的条目。 - ## `config.json` 中的配置选项 在配置文件中对应选项如下： 配置文件部分：`rss_parser` -| 参数名 | 参数说明 | 参数类型 | WebUI 对应选项 | 默认值 | -|-------------|----------------|------|----------------|---------------| -| enable | RSS 解析器是否启用 | 布尔值 | RSS 解析器是否启用 | true | -| type | RSS 解析器类型 | 字符串 | RSS 解析器类型 | mikan | -| token | RSS 解析器 Token | 字符串 | RSS 解析器 Token | token | -| custom_url | RSS 解析器自定义 URL | 字符串 | RSS 解析器自定义 URL | mikanime.tv | -| parser_type | RSS 解析器解析类型 | 字符串 | RSS 解析器解析类型 | parser | -| filter | RSS 解析器过滤器 | 数组 | 过滤器 | [720,\d+-\d+] | -| language | RSS 解析器语言 | 字符串 | RSS 解析器语言 | zh | +| 参数名 | 参数说明 | 参数类型 | WebUI 对应选项 | 默认值 | +|----------|-------------|------|-------------|---------------| +| enable | RSS 解析器是否启用 | 布尔值 | RSS 解析器是否启用 | true | +| filter | RSS 解析器过滤器 | 数组 | 过滤器 | [720,\d+-\d+] | +| language | RSS 解析器语言 | 字符串 | RSS 解析器语言 | zh | [rss_token]: rss +[add_rss]: usage/rss#解析器设置 [reproxy]: proxy##反向代理设置 \ No newline at end of file diff --git a/docs/config/proxy.md b/docs/config/proxy.md index 4ca449c1..ddcb15f3 100644 --- a/docs/config/proxy.md +++ b/docs/config/proxy.md @@ -13,30 +13,10 @@ AB 支持 HTTP 代理和 SOCKS5 代理，通过设置代理可以解决一些网 - **Host** 为代理地址。 - **Port** 为代理端口。 -需要注意的是，在 HTTP 模式下不支持用户名密码验证，如果你的代理需要用户名密码验证，请使用 **SOCKS5** 模式。 +⚠️**注意**: -## 反向代理设置 - -为了应对 [蜜柑计划](https://mikanani.me) 无法访问的情况，AB 增加了三种应对的方式。 - -1. HTTP 以及 Socks 代理 - - 老版本的 AB 就有这项功能，升级到 2.6 版本之后只需要在 WebUI 中检查代理配置即可正常访问蜜柑计划。 - - 不过这时候 qBittorrent 无法正常访问蜜柑计划的 RSS 和种子地址，因此需要在 qBittorrent 中添加代理。详情可以查看: [Mikan 被墙怎么办](../faq/mikan-network.md) - -2. 自定义反向代理 URL - - 2.6 版本的 AB 在配置中增加了 `custom_url` 选项，可以自定义反向代理的 URL。 - 可以在配置中设置为自己正确设置的反代 URL。这样 AB 就会使用自定义的 URL 来访问蜜柑计划。并且 QB 也可以正常下载。 - -3. AB 作为反代中转 - - 在 AB 配置代理之后，AB 自身可以作为本地的反代中转。不过目前仅开放 RSS 相关功能的反代。 - 这时候只需要把 `custom_url` 设置为 `http://abhost:abport` 即可。 `abhost` 为 AB 的 IP 地址，`abport` 为 AB 的端口。 - 此时 AB 会把自身地址推送给 qBittorrent，qBittorrent 会使用 AB 的地址作为反代来访问蜜柑计划。 - - 请注意，此时如果你没有用 NGINX 等工具对 AB 进行反代，请填入 `http://` 来保证程序正常运行。 +- 在 HTTP 模式下不支持用户名密码验证，如果你的代理需要用户名密码验证，请使用 **SOCKS5** 模式。 +- 在 **Socks5** 模式下，需要添加用户名和密码。 ## `config.json` 中的配置选项 diff --git a/docs/deploy/unix.md b/docs/deploy/unix.md index bf662726..d48f52dd 100644 --- a/docs/deploy/unix.md +++ b/docs/deploy/unix.md @@ -24,7 +24,7 @@ echo "VERSION = 'local'" > module/__version__.py ## 下载 WebUI ```bash -wget https://github.com/Rewrite0/Auto_Bangumi_WebUI/releases/download/latest/dist.zip +wget https://github.com/EstrellaXD/Auto_Bangumi/releases/download/latest/dist.zip unzip dist.zip diff --git a/docs/deploy/windows.md b/docs/deploy/windows.md index 3d77a288..cea95ce1 100644 --- a/docs/deploy/windows.md +++ b/docs/deploy/windows.md @@ -8,11 +8,7 @@ cd Auto_Bangumi ``` -2. 创建版本信息文件： - - ```powershell - echo "VERSION='local'" > backend\src\__version__.py - ``` +2. 在 `backend\src` 目录下创建 `__version__.py` 文件并写入 `VERSION='local', 请注意文件编码格式为 `UTF-8`： 3. 新建 `python` 虚拟环境、激活并安装依赖（需保证 `python -V` 打印的版本符合 `Dockerfile` 中的要求，如 `FROM python:3.11-alpine AS APP`） diff --git a/docs/faq/常见问题.md b/docs/faq/index.md similarity index 92% rename from docs/faq/常见问题.md rename to docs/faq/index.md index fc2e0617..347885f5 100644 --- a/docs/faq/常见问题.md +++ b/docs/faq/index.md @@ -4,7 +4,7 @@ ### WebUI 地址 -默认端口为 7892，请访问 `http://serverhost:7892`，如果你修改了端口，请记得同时更改 Docker 中的端口映射。 +默认端口为 7892，如果是服务器部署，请访问 `http://serverhost:7892`，如果本地部署可以访问 `http://localhost:7892` 。如果你修改了端口，请记得同时更改 Docker 中的端口映射。 ### 默认用户名和密码 @@ -43,12 +43,8 @@ ### 没有开始自动下载怎么办： -- 检查 AutoBangumi 的日志，如果日志一切正常，说明是 qBittorrent 的设置问题，检查： - - 设置 >> RSS >> 启用 RSS Torrent 自动下载 - - Options >> RSS >> Enable auto downloading of RSS torrents - - 设置 >> RSS >> 启用获取 RSS 订阅 - - Options >> RSS >> Enable fetching RSS feeds - - 检查 qb 配置，看是否有权限新建文件夹 +请检查 AutoBangumi 的日志，是否有添加种子相关的日志。 +- 如果没有，请检查订阅是否正确。 ### 下载没有存储在正确的目录中 @@ -146,7 +142,7 @@ AB 中的过滤关键词是正则表达式，只会在建立规则的时候添 - 如果 DNS 解析正常，添加代理。 - 使用 TMDB 请添加代理。 -### 如何给 Mikanani 添加代理 +### 如何给 Mikan 添加代理 AB 现在提供三种代理模式 1. HTTP 以及 Socks 代理 @@ -188,4 +184,7 @@ AB 现在提供三种代理模式 然后在 WebUI 中重新配置一下即可。 如果你是老版本升级，请先参考[升级指南](/changelog/2.6)。 -如果有上述没有覆盖的问题，请到 [ISSUE](https://github.com/EstrellaXD/Auto_Bangumi/issues) 按照 bug 模板反馈。 +如果有上述没有覆盖的问题，请到 [ISSUE][ISSUE]按照 bug 模板反馈。 + + +[ISSUE]: https://github.com/EstrellaXD/Auto_Bangumi/issues \ No newline at end of file diff --git a/docs/faq/排错流程.md b/docs/faq/troubleshooting.md similarity index 100% rename from docs/faq/排错流程.md rename to docs/faq/troubleshooting.md diff --git a/docs/feature/rename.md b/docs/usage/rename.md similarity index 100% rename from docs/feature/rename.md rename to docs/usage/rename.md diff --git a/docs/feature/rss.md b/docs/usage/rss.md similarity index 100% rename from docs/feature/rss.md rename to docs/usage/rss.md diff --git a/docs/use/使用说明.md b/docs/usage/使用说明.md similarity index 100% rename from docs/use/使用说明.md rename to docs/usage/使用说明.md diff --git a/docs/use/配置选项说明.md b/docs/usage/配置选项说明.md similarity index 100% rename from docs/use/配置选项说明.md rename to docs/usage/配置选项说明.md