diff --git a/.vscode/settings.json b/.vscode/settings.json index 01799125..28838c61 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,5 +6,8 @@ "tsconfig.json": "json5", "tsconfig.*.json": "json5", }, + "[markdown]": { + "editor.wordWrap": "off", + }, "python.venvPath": "./backend/venv", } diff --git a/README.md b/README.md index cc968cd3..df7e266a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- - + +

@@ -12,7 +12,7 @@ # 项目说明

- +

本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。 diff --git a/backend/requirements.txt b/backend/requirements.txt index 2781feb3..ba894d35 100644 --- a/backend/requirements.txt +++ b/backend/requirements.txt @@ -6,7 +6,7 @@ click fastapi h11 idna -pydantic +pydantic~=1.10 PySocks qbittorrent-api requests diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 9da22854..10b4db98 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,46 +1,85 @@ import { defineConfig } from "vitepress"; + +const version = `v3.0` + // https://vitepress.dev/reference/site-config export default defineConfig({ title: "AutoBangumi", description: "从 Mikan Project 全自动追番下载整理", + + head: [ + ['link', { rel: 'icon', type: 'image/svg+xml', href: '/light-logo.svg' }], + ['meta', { property: 'og:image', content: '/social.png' }], + ['meta', { property: 'og:site_name', content: 'AutoBangumi' }], + ['meta', { property: 'og:url', content: 'https://www.autobangumi.org' }], + ], + themeConfig: { // https://vitepress.dev/reference/default-theme-config + logo: { + dark: '/dark-logo.svg', + light: '/light-logo.svg', + }, + + editLink: { + pattern: 'https://github.com/vitejs/vite/blob/3.1-dev/docs/:path', + text: 'Edit this page', + }, + + search: { + provider: 'local' + }, + + socialLinks: [ + { icon: "github", link: "https://github.com/EstrellaXD/Auto_Bangumi" }, + { + icon: { + svg: 'Telegram' + }, + link: "https://t.me/autobangumi" + }, + ], + nav: [ { text: "项目说明", link: "/home/" }, - { text: "开始部署", link: "/deploy/部署说明" }, + { text: "快速开始", link: "/deploy/quick-start" }, { text: "排错流程", link: "/faq/排错流程" }, { text: "常见问题", link: "/faq/常见问题" }, ], + footer: { + message: `AutoBangumi Released under the MIT License. (latest: ${version})`, + copyright: 'Copyright © 2021-present @EstrellaXD & AutoBangumi Contributors', + }, + sidebar: [ { - text: "项目说明", items: [ { text: "项目说明", link: "/home/", }, + { + text: "快速开始", + link: "/deploy/quick-start", + }, ], }, { text: "部署", items: [ - { - text: "部署前准备", - link: "/deploy/部署说明", - }, { text: "Docker-cli 部署", - link: "/deploy/Docker-cli", + link: "/deploy/docker-cli", }, { text: "Docker-Compose 部署", - link: "/deploy/Docker-compose", + link: "/deploy/docker-compose", }, { text: "群晖NAS", - link: "/deploy/群晖", + link: "/deploy/dsm", }, { text: "WSL", @@ -53,26 +92,46 @@ export default defineConfig({ items: [ { text: "Windows 本地部署", - link: "/deploy/Windows-本地部署", + link: "/deploy/windows", }, { text: "Unix 本地部署", - link: "/deploy/local-run", + link: "/deploy/unix", }, ], }, { - text: "使用说明", + text: "配置说明", items: [ - { - text: "使用说明", - link: "/use/使用说明", - }, - { - text: "配置选项说明", - link: "/use/配置选项说明", - }, - ], + { + text: "获取 RSS 订阅链接", + link: "/config/rss", + }, + { + text: "主程序配置", + link: "/config/program", + }, + { + text: "下载器配置", + link: "/config/downloader", + }, + { + text: "解析器配置", + link: "/config/parser", + }, + { + text: "推送器配置", + link: "/config/notifier", + }, + { + text: "代理配置", + link: "/config/proxy", + } + ] + }, + { + text: "WebUI 使用说明", + link: "/usage/webui", }, { text: "FAQ", @@ -101,9 +160,5 @@ export default defineConfig({ ], }, ], - - socialLinks: [ - { icon: "github", link: "https://github.com/EstrellaXD/Auto_Bangumi" }, - ], }, }); diff --git a/docs/.vitepress/theme/components/HomePreviewWebUI.vue b/docs/.vitepress/theme/components/HomePreviewWebUI.vue new file mode 100644 index 00000000..aaaa4871 --- /dev/null +++ b/docs/.vitepress/theme/components/HomePreviewWebUI.vue @@ -0,0 +1,50 @@ + + + + + \ No newline at end of file diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index bdd506d9..6beadcc2 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,6 +1,15 @@ // https://vitepress.dev/guide/custom-theme -import { h } from 'vue' +import { + h, + onMounted, + watch, + nextTick, +} from 'vue' import Theme from 'vitepress/theme' +import { useRoute } from 'vitepress' +import mediumZoom from 'medium-zoom' +import HomePreviewWebUI from './components/HomePreviewWebUI.vue' + import './style.css' export default { @@ -8,8 +17,28 @@ export default { Layout: () => { return h(Theme.Layout, null, { // https://vitepress.dev/guide/extending-default-theme#layout-slots + 'home-features-after': () => h(HomePreviewWebUI), }) }, + setup() { + const route = useRoute() + const initZoom = () => { + /** + * Allow images to be zoomed in on click + * https://github.com/vuejs/vitepress/issues/854 + */ + mediumZoom('[data-zoomable]', { background: 'var(--vp-c-bg)' }) + } + + onMounted(() => { + initZoom() + }) + + watch( + () => route.path, + () => nextTick(initZoom), + ) + }, enhanceApp({ app, router, siteData }) { // ... } diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css index c23c17ac..a5f9baec 100644 --- a/docs/.vitepress/theme/style.css +++ b/docs/.vitepress/theme/style.css @@ -8,12 +8,12 @@ * -------------------------------------------------------------------------- */ :root { - --vp-c-brand: #646cff; - --vp-c-brand-light: #747bff; - --vp-c-brand-lighter: #9499ff; - --vp-c-brand-lightest: #bcc0ff; - --vp-c-brand-dark: #535bf2; - --vp-c-brand-darker: #454ce1; + --vp-c-brand: #7B65D6; + --vp-c-brand-light: #7162AE; + --vp-c-brand-lighter: #8D7FC2; + --vp-c-brand-lightest: #8E8A9C; + --vp-c-brand-dark: #4E3C94; + --vp-c-brand-darker: #281E52; --vp-c-brand-dimm: rgba(100, 108, 255, 0.08); } @@ -41,14 +41,14 @@ --vp-home-hero-name-color: transparent; --vp-home-hero-name-background: -webkit-linear-gradient( 120deg, - #bd34fe 30%, - #41d1ff + #b42ff1 30%, + #441bd9 ); --vp-home-hero-image-background-image: linear-gradient( -45deg, - #bd34fe 50%, - #47caff 50% + #b42ff1bb 50%, + #4794ffbb 50% ); --vp-home-hero-image-filter: blur(40px); } @@ -89,3 +89,22 @@ --docsearch-primary-color: var(--vp-c-brand) !important; } +/** + * Component: medium-zoom + * -------------------------------------------------------------------------- */ + + +.medium-zoom--opened .medium-zoom-overlay { + z-index: 20; +} + +.medium-zoom--opened .medium-zoom-image { + z-index: 21; +} + +.vp-doc .ab-shadow-card { + box-shadow: 0 10px 30px -10px rgba(0,0,0,0.2), + 0 0 2px rgba(0,0,0,0.2), + 0 20px 30px -20px rgba(0,0,0,0.4); + border-radius: 10px; +} diff --git a/docs/changelog/2.6.md b/docs/changelog/2.6.md index 4e8ceb85..5c553a0e 100644 --- a/docs/changelog/2.6.md +++ b/docs/changelog/2.6.md @@ -125,7 +125,7 @@ AB 现在可以对合集以及文件夹内的文件进行重命名了，此时 A **标准路径** -```text +``` /downloads/Bangumi/剧集信息/Season 1/xxx ``` diff --git a/docs/config/downloader.md b/docs/config/downloader.md new file mode 100644 index 00000000..afd0840d --- /dev/null +++ b/docs/config/downloader.md @@ -0,0 +1,55 @@ +# 下载器设置 + +## WebUI 设置 + +![downloader](../image/config/downloader.png){width=500}{class=ab-shadow-card} + +
+ +- **Downloader Type** 为下载器类型，目前支持 qBittorrent 下载器，目前暂不支持修改。 +- **Host** 为下载器地址。[1](#下载器地址) +- **Download path** 为映射的下载器下载路径。[2](#下载器路径问题) +- **SSL** 为下载器是否使用 SSL。 + +## 常见问题 + +### 下载器地址 + +⚠️**请不要直接使用 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 会隔离容器的网络，此时如果你不做额外的网桥配置将无法访问同宿主机的其他容器或者主机本身。 + +### 下载器路径问题 + +AB 中配置的路径只是为了生成对应番剧文件路径，AB 本身不对路径下的文件做直接管理。 + +**下载路径** 到底写什么？ + +这个参数只要和你 **下载器** 中的参数保持一致即可。 +- Docker：比如 qB 中是 `/downloads` 那就写 `/downloads/Bangumi`，`Bangumi`可以任意更改。 +- Linux/macOS：如果是 `/home/usr/downloads` 或者 `/User/UserName/Downloads` 只要在最后再加一行 `Bangumi` 就行。 +- Windows：`D:\Media\`, 改为 `D:\Media\Bangumi` + +## `config.json` 中的配置选项 + +在配置文件中对应选项如下： + +配置文件部分：`downloader` + +| 参数名 | 参数说明 | 参数类型 | WebUI 对应选项 | 默认值 | +|----------|-------------|------|-------------|--------------------| +| type | 下载器类型 | 字符串 | 下载器类型 | qbittorrent | +| host | 下载器地址 | 字符串 | 下载器地址 | 172.17.0.1:8080 | +| username | 下载器用户名 | 字符串 | 下载器用户名 | admin | +| password | 下载器密码 | 字符串 | 下载器密码 | adminadmin | +| path | 下载器下载路径 | 字符串 | 下载器下载路径 | /downloads/Bangumi | +| ssl | 下载器是否使用 SSL | 布尔值 | 下载器是否使用 SSL | false | + + + diff --git a/docs/config/notifier.md b/docs/config/notifier.md new file mode 100644 index 00000000..1603322d --- /dev/null +++ b/docs/config/notifier.md @@ -0,0 +1,34 @@ +# 通知配置 + +## WebUI 配置 + +![notification](../image/config/notifier.png){width=500}{class=ab-shadow-card} + +
+ +- **Enable** 为是否启用通知，如果不启用通知，下面的配置项将不会生效。 +- **Type** 为通知类型，目前支持: + - Telegram + - Wecom + - Bark + - ServerChan +- **Chat ID** 仅在使用 `telegram` 通知时需要填写。[Telegram Bot 获取 Chat ID][1] +- **Wecom**，chat_id参数框填写自建推送的url地址，同时需要在服务端增加[图文消息][2]类型。[Wecom酱配置说明][3] + +## `config.json` 中的配置选项 + +在配置文件中对应选项如下： + +配置文件部分：`notification` + +| 参数名 | 参数说明 | 参数类型 | WebUI 对应选项 | 默认值 | +|---------|------------|------|------------|----------| +| enable | 是否启用通知 | 布尔值 | 通知 | false | +| type | 通知类型 | 字符串 | 通知类型 | telegram | +| token | 通知 Token | 字符串 | 通知 Token | +| chat_id | 通知 Chat ID | 字符串 | 通知 Chat ID | + + +[1]: https://core.telegram.org/bots#6-botfather +[2]: https://github.com/umbors/wecomchan-alifun +[3]: https://github.com/easychen/wecomchan \ No newline at end of file diff --git a/docs/config/parser.md b/docs/config/parser.md new file mode 100644 index 00000000..b771c403 --- /dev/null +++ b/docs/config/parser.md @@ -0,0 +1,41 @@ +# 解析器设置 + +AB 的解析器用于解析聚合 RSS 链接，如果 RSS 有新条目更新，AB 就会解析标题并且生成自动下载规则。 + +## 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] +- **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 | + + +[rss_token]: rss +[reproxy]: proxy##反向代理设置 \ No newline at end of file diff --git a/docs/config/program.md b/docs/config/program.md new file mode 100644 index 00000000..ddbc05b6 --- /dev/null +++ b/docs/config/program.md @@ -0,0 +1,27 @@ +# 主程序运行配置 + +## WebUI 配置 + +![program](../image/config/program.png){width=500}{class=ab-shadow-card} + +
+ +- Interval Time 参数的单位为秒，如果你需要设置为分钟，请自行转换为秒。 +- RSS 为 RSS 检查时间间隔，这个参数影响自动下载规则生成的周期间隔。 +- Rename 为重命名检查时间间隔，如果你需要修改重命名检查时间间隔，请修改此参数。 +- WebUI Port 为端口，请注意如果你使用 Docker 部署，修改后需要在 Docker 中重新映射端口。 + + +## `config.json` 中的配置选项 + +在配置文件中对应选项如下： + +配置文件部分：`program` + +| 参数名 | 参数说明 | 参数类型 | WebUI 对应选项 | 默认值 | +|-------------|------------|----------|------------|------| +| rss_time | RSS 检查时间间隔 | 以秒为单位的整数 | RSS 检查时间间隔 | 7200 | +| rename_time | 重命名检查时间间隔 | 以秒为单位的整数 | 重命名检查时间间隔 | 60 | +| webui_port | WebUI 端口 | 以整数为单位 | WebUI 端口 | 7892 | + + diff --git a/docs/config/proxy.md b/docs/config/proxy.md new file mode 100644 index 00000000..58c19ae0 --- /dev/null +++ b/docs/config/proxy.md @@ -0,0 +1,54 @@ +# 代理和反向代理 + +## 代理 + +![proxy](../image/config/proxy.png){width=500}{class=ab-shadow-card} + +
+ +AB 支持 HTTP 代理和 SOCKS5 代理，通过设置代理可以解决一些网络问题。 + +- **Enable**: 是否启用代理。 +- **Type** 为代理类型。 +- **Host** 为代理地址。 +- **Port** 为代理端口。 + +需要注意的是，在 HTTP 模式下不支持用户名密码验证，如果你的代理需要用户名密码验证，请使用 **SOCKS5** 模式。 + +## 反向代理设置 + +为了应对 [蜜柑计划](https://mikanani.me) 无法访问的情况，AB 增加了三种应对的方式。 + +1. HTTP 以及 Socks 代理 + + 老版本的 AB 就有这项功能，升级到 2.6 版本之后只需要在 WebUI 中检查代理配置即可正常访问蜜柑计划。 + + 不过这时候 qBittorrent 无法正常访问蜜柑计划的 RSS 和种子地址，因此需要在 qBittorrent 中添加代理。详情可以查看 #198 + +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://` 来保证程序正常运行。 + +## `config.json` 中的配置选项 + +在配置文件中对应选项如下： + +配置文件部分：`proxy` + +| 参数名 | 参数说明 | 参数类型 | WebUI 对应选项 | 默认值 | +|----------|--------|------|------------|-------| +| enable | 是否启用代理 | 布尔值 | 代理 | false | +| type | 代理类型 | 字符串 | 代理类型 | http | +| host | 代理地址 | 字符串 | 代理地址 | +| port | 代理端口 | 整数 | 代理端口 | +| username | 代理用户名 | 字符串 | 代理用户名 | +| password | 代理密码 | 字符串 | 代理密码 | diff --git a/docs/config/rss.md b/docs/config/rss.md new file mode 100644 index 00000000..c670bad4 --- /dev/null +++ b/docs/config/rss.md @@ -0,0 +1,40 @@ +# 准备 Mikan RSS 订阅链接 + +AutoBangumi 可以自动解析 [Mikan Project][mikan-site] 的 RSS 订阅地址，根据字幕组以及番剧名称生成下载规则， 从而实现自动追番。 +因此在开始自动追番之前，你需要准备好 [Mikan Project][mikan-site] 的 RSS 订阅地址。 + +需要注意的是，目前 Mikan Project 主站已经被墙，当你不知道如何使用代理时请使用如下链接进行访问订阅： + +[Mikan Project CN][mikan-cn-site] + +## 获取订阅地址 + +本项目基于解析 Mikan Project 提供的 RSS 地址，因此如果要实现自动追番，需要注册并且获得 Mikan Project 的 RSS 地址： + +![image](../image/rss/rss-token.png){data-zoomable} + +获取的 RSS 地址如下： + +```txt +https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +# 或者 +https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符。 + +## Mikan Project 订阅贴士 + +由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点： + +![image](../image/rss/advanced-subscription.png){data-zoomable} + +- 在个人设置中打开高级设置。 +- 一部番剧只订阅一个字幕组，点击 Mikan Project 的番剧图片即可呼出二级菜单，选择一个字幕组订阅即可。 +- 如果字幕组有简体繁体不同的字幕，Mikan Project 大多时候提供了选择订阅的方式，选择一种字幕订阅。 +- 如果不提供简繁选择，那么可以在 AutoBangumi 中设置 `filter` 进行过滤，也可以在规则生成之后进入 qBittorrent 中手动过滤。 +- 目前不支持 OVA 以及 剧场版 的订阅解析。 + + +[mikan-site]: https://mikanani.me/ +[mikan-cn-site]: https://mikanime.tv/ \ No newline at end of file diff --git a/docs/deploy/Docker-cli.md b/docs/deploy/Docker-cli.md deleted file mode 100644 index 7481166a..00000000 --- a/docs/deploy/Docker-cli.md +++ /dev/null @@ -1,91 +0,0 @@ -## 使用 Docker-cli 部署 - -### 设置环境变量 - -添加环境变量（注意这里最好手动输入）详细内容请参考 [Docker Compose](/deploy/Docker-compose) 章节中同样内容 - -```shell -export \ -DOWNLOAD_PATH=/path/downloads \ -RSS= -``` - -### 创建数据和配置文件夹 - -为了保证 AB 在每次更新之后数据和配置不丢失，推荐使用 Docker volume 进行数据和配置的持久化。 - -```shell -# 创建数据文件夹 -mkdir AutoBangumi -cd AutoBangumi -``` - -### 使用 Docker-cli 部署 AutoBangumi - -复制以下命令运行即可。 - -```shell -docker run -d \ - --name=AutoBangumi \ - -v $PWD/config:/app/config \ - -v $PWD/data:/app/data \ - -p 7892:7892 \ - --network=bridge \ - --dns=8.8.8.8 \ - --restart unless-stopped \ - estrellaxd/auto_bangumi:latest -``` - -此时 AB 的 WebUI 会自动运行，但是主程序会处于暂停状态，可以进入 `http://abhost:7892` 进行配置。 - -当然也可以使用环境变量进行配置，具体内容请参考 [Docker Compose](/deploy/Docker-compose) 章节中同样内容 - -```shell -docker run -d \ - --name=AutoBangumi \ - -e TZ=Asia/Shanghai \ #optional - -e AB_DOWNLOADER_HOST=qbittorrent:8080 \ #optional - -e AB_DOWNLOADER_USERNAME=admin \ #optional - -e AB_DOWNLOADER_PASSWORD=adminadmin \ #optional - -e AB_DOWNLOAD_PATH=/path/downloads \ - -e AB_RSS= \ - -v $PWD/config:/app/config \ - -v $PWD/data:/app/data \ - --network=host \ - --dns=8.8.8.8 \ - --restart unless-stopped \ - estrellaxd/auto_bangumi:latest -``` - -此时 AB 会自动把环境变量写入 `config.json` 文件中然后自动运行。 - -推荐使用 _[Portainer](https://www.portainer.io)_ 等带有 UI 的 Docker 管理器进行进阶部署 - -## 部署结果： - -```other -[2022-07-09 21:55:19,164] INFO: _ ____ _ -[2022-07-09 21:55:19,165] INFO: /\ | | | _ \ (_) -[2022-07-09 21:55:19,166] INFO: / \ _ _| |_ ___ | |_) | __ _ _ __ __ _ _ _ _ __ ___ _ -[2022-07-09 21:55:19,167] INFO: / /\ \| | | | __/ _ \| _ < / _` | '_ \ / _` | | | | '_ ` _ \| | -[2022-07-09 21:55:19,167] INFO: / ____ \ |_| | || (_) | |_) | (_| | | | | (_| | |_| | | | | | | | -[2022-07-09 21:55:19,168] INFO: /_/ \_\__,_|\__\___/|____/ \__,_|_| |_|\__, |\__,_|_| |_| |_|_| -[2022-07-09 21:55:19,169] INFO: __/ | -[2022-07-09 21:55:19,169] INFO: |___/ -[2022-07-09 21:55:19,170] INFO: Version 2.6.3 Author: EstrellaXD Twitter: https://twitter.com/Estrella_Pan -[2022-07-09 21:55:19,171] INFO: GitHub: https://github.com/EstrellaXD/Auto_Bangumi/ -[2022-07-09 21:55:19,172] INFO: Starting AutoBangumi... -[2022-07-09 21:55:20,717] INFO: Add RSS Feed successfully. -[2022-07-09 21:55:21,761] INFO: Start collecting RSS info. -[2022-07-09 21:55:23,431] INFO: Finished -[2022-07-09 21:55:23,432] INFO: Running.... -[2022-07-09 22:01:24,534] INFO: [NC-Raws] 继母的拖油瓶是我的前女友 - 01 (B-Global 1920x1080 HEVC AAC MKV) [0B604F3A].mkv >> 继母的拖油瓶是我的前女友 S01E01.mkv -[2022-07-09 22:01:24,539] INFO: Finished checking 131 files' name, renamed 1 files. -[2022-07-09 23:55:31,843] INFO: Start collecting RSS info. -[2022-07-09 23:55:37,269] INFO: Finished -[2022-07-09 23:55:37,270] INFO: Running.... -[2022-07-10 00:13:38,855] INFO: [NC-Raws] Lycoris Recoil 莉可麗絲 - 02 (Baha 1920x1080 AVC AAC MP4) [1160E633].mp4 >> Lycoris Recoil 莉可麗絲 S01E02.mp4 -[2022-07-10 00:13:38,869] INFO: Finished checking 131 files' name, renamed 1 files. -[2022-07-10 00:43:40,777] INFO: [NC-Raws] Lycoris Recoil 莉可麗絲 - 01 (Baha 1920x1080 AVC AAC MP4) [7E742084].mp4 >> Lycoris Recoil 莉可麗絲 S01E01.mp4 -[2022-07-10 00:43:40,811] INFO: Finished checking 132 files' name, renamed 1 files. -``` diff --git a/docs/deploy/Docker-compose.md b/docs/deploy/Docker-compose.md deleted file mode 100644 index 56481f5d..00000000 --- a/docs/deploy/Docker-compose.md +++ /dev/null @@ -1,102 +0,0 @@ -## 安装 **Docker Compose** - -现在提供了一键部署的 **AutoBangumi** 的方法，可以使用 `docker-compose.yml` 文件进行部署。 - -正常来说安装完 Docker 之后都会自带 `docker-compose`，使用命令： - -```bash -docker compose -v -``` - -检查版本即可 - -如果没有安装，可以使用以下命令安装： - -```bash - $ sudo apt-get update - $ sudo apt-get install docker-compose-plugin -``` - -## 部署 **AutoBangumi** - -### 创建 AutoBangumi 文件夹 - -```bash -mkdir AutoBangumi -cd AutoBangumi -``` - -### 下载 Docker Compose 配置文件 - -项目中提供了三种安装方式： - -- 只安装 **AutoBangumi** - ```bash - wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/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 - ``` - -首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。 - -### 定义环境变量 - -如果你是用上面下载的 AB+QB / AB+QB+Plex 的 Docker-Compose 文件，那么你需要定义以下环境变量： - -```shell -export \ -QB_PORT= \ -DOWNLOAD_PATH= -``` - -- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080` -- `DOWNLOAD_PATH`: 填写你的文件下载路径 - -如果你不想使用环境变量，也可以拉起 Docker-Compose 后在 WebUI 中进行配置。 - -### 拉起 Docker-Compose - -```bash -# 如果配置过了上面的环境变量，请使用下面的方式拉起 -docker compose up -d - -# 如果没有手动配置上面的环境变量，请使用下面的方式拉起 -QB_PORT= DOWNLOAD_PATH= docker compose up -d -``` - -## 部署结果： - -```other -2022-06-05 16:38:49 INFO: Add RSS Feed successfully. -2022-06-05 16:38:50 INFO: Adding Kawaii dake ja Nai Shikimori-san Season 1 -2022-06-05 16:38:50 INFO: Adding Kakkou no Iinazuke Season 1 -2022-06-05 16:38:50 INFO: Adding SPYxFAMILY Season 1 -2022-06-05 16:38:50 INFO: Adding Love Live！虹咲学园 学园偶像同好会 Season 2 -2022-06-05 16:38:50 INFO: Adding CUE! Season 1 -2022-06-05 16:38:50 INFO: Adding Kaguya-sama wa Kokurasetai Season 3 -2022-06-05 16:38:50 INFO: Adding Shokei Shoujo no Virgin Road Season 1 -2022-06-05 16:38:50 INFO: Adding Kakkou no Iikagen Season 1 -2022-06-05 16:38:50 INFO: Adding Summer Time Rendering Season 1 -2022-06-05 16:38:50 INFO: Adding Mahoutsukai Reimeiki Season 1 -2022-06-05 16:38:50 INFO: Adding Paripi Koumei Season 1 -2022-06-05 16:38:50 INFO: Adding Komi-san wa, Komyushou Desu. Season 1 -2022-06-05 16:38:50 INFO: Adding Deaimon Season 1 -2022-06-05 16:38:50 INFO: Adding Tate no Yuusha no Nariagari Season 2 -2022-06-05 16:38:50 INFO: Adding Shijou Saikyou no Daimaou Season 1 -2022-06-05 16:38:50 INFO: Adding Yuusha, Yamemasu Season 1 -2022-06-05 16:38:50 INFO: Adding Tomodachi Game Season 1 -2022-06-05 16:38:50 INFO: Adding Machikado Mazoku: 2-choume Season 1 -2022-06-05 16:38:50 INFO: Start collecting past episodes. -2022-06-05 16:39:32 INFO: Start adding rules. -2022-06-05 16:39:32 INFO: Finished. -2022-06-05 16:39:32 INFO: Waiting for downloading torrents... -2022-06-05 16:49:32 INFO: Finished checking 185 file's name. -2022-06-05 16:49:32 INFO: Renamed 0 files. -2022-06-05 16:49:32 INFO: Finished rename process. -``` diff --git a/docs/deploy/docker-cli.md b/docs/deploy/docker-cli.md new file mode 100644 index 00000000..05508281 --- /dev/null +++ b/docs/deploy/docker-cli.md @@ -0,0 +1,45 @@ +# 使用 Docker-cli 部署 + +## 新版本提醒 + +AutoBangumi 2.6 版本后支持直接在 WebUI 中配置，你可以选择直接拉起容器再在 WebUI 中配置。老版本的环境变量配置参数会自动迁移，环境变量配置方式仍然可用，但是仅在第一次启动时生效。 + +## 创建数据和配置文件夹 + +为了保证 AB 在每次更新之后数据和配置不丢失，推荐使用 Docker volume 或者 bind mount 进行数据和配置的持久化。 + +```shell +# 使用 Docker volume +docker volume create AutoBangumi_config +docker volume create AutoBangumi_data + +# 使用 bind mount +mkdir "AutoBangumi" +cd "AutoBangumi" +mkdir -p $PWD/config +mkdir -p $PWD/data +``` + +## 使用 Docker-cli 部署 AutoBangumi + +复制以下命令运行即可。 + +```shell +docker run -d \ + --name=AutoBangumi \ + -v AutoBangumi_config:/app/config \ + -v AutoBangumi_data:/app/data \ + -p 7892:7892 \ + --network=bridge \ + --dns=8.8.8.8 \ + --restart unless-stopped \ + estrellaxd/auto_bangumi:latest +``` + +如果使用 bind mount，可以自行替换绑定路径。 + +此时 AB 的 WebUI 会自动运行，但是主程序会处于暂停状态，可以进入 `http://abhost:7892` 进行配置。 + +此时 AB 会自动把环境变量写入 `config.json` 文件中然后自动运行。 + +推荐使用 _[Portainer](https://www.portainer.io)_ 等带有 UI 的 Docker 管理器进行进阶部署 diff --git a/docs/deploy/docker-compose.md b/docs/deploy/docker-compose.md new file mode 100644 index 00000000..76c5c4d6 --- /dev/null +++ b/docs/deploy/docker-compose.md @@ -0,0 +1,95 @@ +# 通过 Docker Compose 部署 AutoBangumi + +现在提供了一键部署的 **AutoBangumi** 的方法，可以使用 `docker-compose.yml` 文件进行部署。 + +## 安装 Docker Compose + +正常来说安装完 Docker 之后都会自带 `docker-compose`，使用命令： + +```bash +docker compose -v +``` + +检查版本即可 + +如果没有安装，可以使用以下命令安装： + +```bash + $ sudo apt-get update + $ sudo apt-get install docker-compose-plugin +``` + +## 部署 **AutoBangumi** + +### 创建 AutoBangumi 文件夹 + +```bash +mkdir AutoBangumi +cd AutoBangumi +``` + +### 选项1: 自定义 Docker Compose 配置文件 + +```yaml +version: "3.8" + +services: + AutoBangumi: + image: estrellaxd/auto_bangumi:latest + container_name: AutoBangumi + volumes: + - ./config:/app/config + - ./data:/app/data + ports: + - "7892:7892" + restart: unless-stopped + dns: + - 223.5.5.5 + +volumes: + AutoBangumi_config: + name: AutoBangumi_config + AutoBangumi_data: + name: AutoBangumi_data +``` + +复制上面的内容到 `docker-compose.yml` 文件中。 + +### 选项2: 下载 Docker Compose 配置文件 + +当你不想自己创建 `docker-compose.yml` 文件时， +项目中提供了三种安装方式： + +- 只安装 **AutoBangumi** + ```bash + wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/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 + ``` + +首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。 + +### 定义环境变量 + +如果你是用上面下载的 AB+QB / AB+QB+Plex 的 Docker-Compose 文件，那么你需要定义以下环境变量： + +```shell +export \ +QB_PORT= +``` + +- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080` + +### 拉起 Docker-Compose + +```bash +# 如果配置过了上面的环境变量，请使用下面的方式拉起 +docker compose up -d +``` + diff --git a/docs/deploy/dsm.md b/docs/deploy/dsm.md new file mode 100644 index 00000000..b5e11993 --- /dev/null +++ b/docs/deploy/dsm.md @@ -0,0 +1,44 @@ +# 群晖 (DSM 7.2) 部署说明（ QNAP 同理） + +在 DSM 7.2 中，已经支持了 Docker Compose，推荐使用 Docker Compose 一键部署本项目。 + +## 创建配置和数据存储文件夹 + + +## 安装 Container Manager (Docker) 套件 + +进入套件中心，安装 Container Manager (Docker) 套件。 + +![install-docker](../image/dsm/install-docker.png){data-zoomable} + +## 通过 Docker compose 安装配置 AB + +点击 **项目**，然后点击 **新建**，选择 **Docker Compose**。 + +![new-compose](../image/dsm/new-compose.png){data-zoomable} + +复制以下内容填入 **Docker Compose** 中。 +```yaml +version: "3.8" + +services: + ab: + image: "ghcr.io/estrellaxd/auto_bangumi:latest" + container_name: "auto_bangumi" + restart: unless-stopped + ports: + - "7892:7892" + volumes: + - "/volume1/docker/ab/config:/app/config" + - "/volume1/docker/ab/data:/app/data" + - "/volume1/docker/ab/log:/app/log" +``` + +点击 **下一步**，然后点击 **完成**。 + +![create](../image/dsm/create.png){data-zoomable} + +完成创建之后进入 `http://:7892` 即可进入 AB 并进行配置。 + + + diff --git a/docs/deploy/quick-start.md b/docs/deploy/quick-start.md new file mode 100644 index 00000000..eeebdeee --- /dev/null +++ b/docs/deploy/quick-start.md @@ -0,0 +1,107 @@ +# 快速开始 + +我们推荐你在 Docker 中部署运行 AutoBangumi。 +部署前请确认已经安装了 [Docker Engine][docker-engine] 或者 [Docker Desktop][docker-desktop]。 + +## 创建数据和配置文件夹 + +为了保证 AB 在每次更新之后数据和配置不丢失，推荐使用 Docker volume 进行数据和配置的持久化。 + +```shell +docker volume create AutoBangumi_config +docker volume create AutoBangumi_data +``` +## 使用 Docker 部署 AutoBangumi + +### 选项1: 使用 Docker-cli 部署 + +复制以下命令运行即可。 + +```shell +docker run -d \ + --name=AutoBangumi \ + -v AutoBangumi_config:/app/config \ + -v AutoBangumi_data:/app/data \ + -p 7892:7892 \ + --network=bridge \ + --dns=8.8.8.8 + --restart unless-stopped \ + estrellaxd/auto_bangumi:latest + +``` + +### 选项2: 使用 Docker-compose 部署 + +复制以下内容到 `docker-compose.yml` 文件中，然后运行 `docker-compose up -d` 即可。 + +```yaml +version: "3.8" + +services: + AutoBangumi: + image: estrellaxd/auto_bangumi:latest + container_name: AutoBangumi + volumes: + - AutoBangumi_config:/app/config + - AutoBangumi_data:/app/data + ports: + - 7892:7892 + restart: unless-stopped + dns: + - 223.5.5.5 + network_mode: bridge + +volumes: + AutoBangumi_config: + name: AutoBangumi_config + AutoBangumi_data: + name: AutoBangumi_data +``` + +## 安装 qBittorrent + +如果你没有安装 qBittorrent，请先安装 qBittorrent。 + +- [在 Docker 中安装 qBittorrent][qbittorrent-docker] +- [在 Windows/macOS 中安装 qBittorrent][qbittorrent-desktop] +- [在 Linux 中安装 qBittorrent-nox][qbittorrent-nox] + +## 获取 Mikan Project 的 RSS 链接 + +进入 [MiKan Project][mikan-project]，注册账号并登录，然后点击右下角的 **RSS** 按钮，复制链接。 + +![mikan-rss](../image/rss/rss-token.png){data-zoomable} + +获取的 RSS 地址如下： + +```txt +https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +# 或者 +https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` +复制 token= 后面的内容。 + +详细步骤参考 [Mikan RSS][config-rss] + + +## 配置 AutoBangumi + +安装好 AB 之后，AB 的 WebUI 会自动运行，但是主程序会处于暂停状态，可以进入 `http://abhost:7892` 进行配置。 + +1. 填入下载器的地址，端口，用户名和密码。 + +![ab-webui](../image/config/downloader.png){width=500}{class=ab-shadow-card} + +2. 填入 Mikan RSS 的 Token。 + +![ab-rss](../image/config/parser.png){width=500}{class=ab-shadow-card} + +3. 点击 **Apply** 保存配置，此时 AB 会重启运行，当右上角的圆点变为绿色时，表示 AB 已经正常运行。 + +[docker-engine]: https://docs.docker.com/engine/install/ +[docker-desktop]: https://www.docker.com/products/docker-desktop +[config-rss]: ../config/rss +[mikan-project]: https://mikanani.me/ +[qbittorrent-docker]: https://hub.docker.com/r/superng6/qbittorrent +[qbittorrent-desktop]: https://www.qbittorrent.org/download +[qbittorrent-nox]: https://www.qbittorrent.org/download-nox \ No newline at end of file diff --git a/docs/deploy/local-run.md b/docs/deploy/unix.md similarity index 92% rename from docs/deploy/local-run.md rename to docs/deploy/unix.md index 107ceabf..bf662726 100644 --- a/docs/deploy/local-run.md +++ b/docs/deploy/unix.md @@ -18,7 +18,7 @@ python3 pip install -r requirements.txt ```bash cd backend/src -echo "VERSION = 'local'" >> module/__version__.py +echo "VERSION = 'local'" > module/__version__.py ``` ## 下载 WebUI diff --git a/docs/deploy/Windows-本地部署.md b/docs/deploy/windows.md similarity index 99% rename from docs/deploy/Windows-本地部署.md rename to docs/deploy/windows.md index 13a82222..af374788 100644 --- a/docs/deploy/Windows-本地部署.md +++ b/docs/deploy/windows.md @@ -1,3 +1,6 @@ +# Windows 本地部署 + + 1. 克隆并进入 AutoBangumi 的 `git` 仓库： ```powershell diff --git a/docs/deploy/wsl.md b/docs/deploy/wsl.md index b91d0bcd..38bc327c 100644 --- a/docs/deploy/wsl.md +++ b/docs/deploy/wsl.md @@ -17,9 +17,9 @@ services: - GID=1000 - QB_WEBUI_PORT=8989 ports: - - 6881:6881 - - 6881:6881/udp - - 8989:8989 + - "6881:6881" + - "6881:6881/udp" + - "8989:8989" volumes: - qb_config:/config - /mnt/g/animation:/Downloads #下载路径，对应 Windows上目录是 G:\animation @@ -42,8 +42,8 @@ services: - PGID=1000 - TZ=Asia/Shanghai - AB_DOWNLOADER_HOST=qbittorrent:8989 - - AB_DOWNLOADER_USERNAME=admin - - AB_DOWNLOADER_PASSWORD=adminadmin + - AB_DOWNLOADER_USERNAME=admin + - AB_DOWNLOADER_PASSWORD=adminadmin - AB_NOT_CONTAIN=720|繁体|CHT|JPTC|繁日|BIG5 - AB_DOWNLOAD_PATH=/Downloads #qbittorrent 映射的地址，否者可能提示下载失败 - AB_RSS=https://mikanani.me/RSS/MyBangumi?token=xxxxxxxx%3d%3d #订阅地址，改成自己的 @@ -58,5 +58,4 @@ volumes: external: false auto_bangumi: external: false - ``` \ No newline at end of file diff --git a/docs/deploy/群晖.md b/docs/deploy/群晖.md deleted file mode 100644 index 53a456fd..00000000 --- a/docs/deploy/群晖.md +++ /dev/null @@ -1,26 +0,0 @@ -## 群晖部署说明（ QNAP 同理） - -1. 安装 Docker 套件 - -![docker.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8accwj20zc0u0wh4.jpg) 2. 在 Docker 中搜索 AutoBangumi 并且拉取 - -![ab.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8zrv1j20zc0u0dka.jpg) 3. 配置 AutoBangumi - -![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8ludwj20wt0u0tam.jpg) - -![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8fxvyj20zj0u078i.jpg) - -![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7u8x6j20wm0u0mzy.jpg) - -4. 如果你还没有安装 qBittorrent - 配置如下： - -![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7ohctj20zh0u0mzq.jpg) - -![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7h8bsj20wp0u040n.jpg) - -![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd6cgovj20wt0u00uj.jpg) - -## 运行结果 - -![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd65jcbj21bx0u07bf.jpg) diff --git a/docs/deploy/部署说明.md b/docs/deploy/部署说明.md deleted file mode 100644 index 4208c351..00000000 --- a/docs/deploy/部署说明.md +++ /dev/null @@ -1,50 +0,0 @@ -# 开始前的准备 - -**AutoBangumi** 可以使用 Docker 运行，也可以直接从源代码运行，鉴于追番是一个 7x24 小时的过程，**推荐**在 NAS 或者 Linux 服务器中使用 Docker 运行。 - -## 获取 Mikan Project RSS 订阅地址 - -本项目基于解析 Mikan Project 提供的 RSS 地址，因此如果要实现自动追番，需要注册并且获得 Mikan Project 的 RSS 地址： - -![image](https://raw.githubusercontent.com/EstrellaXD/ab_resource/main/resource/image/订阅地址.png) - -获取的 RSS 地址如下： - -```angular2html -https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -# 或者 -https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -``` - -AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符。 - -## Mikan Project 订阅贴士 - -由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点： - -![image](https://raw.githubusercontent.com/EstrellaXD/ab_resource/main/resource/image/高级订阅.png) - -- 在个人设置中打开高级设置。 -- 一部番剧只订阅一个字幕组，点击 Mikan Project 的番剧图片即可呼出二级菜单，选择一个字幕组订阅即可。 -- 如果字幕组有简体繁体不同的字幕，Mikan Project 大多时候提供了选择订阅的方式，选择一种字幕订阅。 -- 如果不提供简繁选择，那么可以在 AutoBangumi 中设置 `filter` 进行过滤，也可以在规则生成之后进入 qBittorrent 中手动过滤。 -- 目前不支持 OVA 以及 剧场版 的订阅解析。 - -## 安装 Docker 以及 Docker Compose - -- [安装 Docker 英文](https://docs.docker.com/get-docker/) -- [安装 Docker-Compose 英文](https://docs.docker.com/compose/) -- [安装 Docker 中文](https://sspai.com/post/56893) -- [Docker Compose 教程](https://sspai.com/post/66013) - -**推荐使用 Docker Compose 一键部署本项目** - -## 安装 qBittorrent 和媒体库 - -如果你选择使用 Docker Compose 的方式安装，可以跳过这一步。 -如果你已经配置好已有的 qBittorrent 也可以跳过这一步。 - -### 使用 Docker 安装 qBittorrent - -- [安装说明](https://github.com/linuxserver/docker-qbittorrent) -- [群晖安装 qBittorrent](https://post.smzdm.com/p/a5k64587/) diff --git a/docs/faq/常见问题.md b/docs/faq/常见问题.md index 042d182e..fc2e0617 100644 --- a/docs/faq/常见问题.md +++ b/docs/faq/常见问题.md @@ -1,3 +1,5 @@ +# 常见问题 + ## WebUI ### WebUI 地址 diff --git a/docs/faq/排错流程.md b/docs/faq/排错流程.md index a98136b0..f55af72f 100644 --- a/docs/faq/排错流程.md +++ b/docs/faq/排错流程.md @@ -1,7 +1,11 @@ -## ❌ 常用问题排错流程 +--- +title: 排错流程 +--- + +## 💡 通用排错流程 1. 如果 AB 无法正常启动，请检查启动命令是否正确, 当前版本正确的启动命令为 `/init`, 如果发现启动命令不正确且不会修改，请尝试重新部署 AB。 2. 部署完 AB 之后请先查看 Log。如果运行如下说明 AB 运行正常，且与 QB 连接良好： - ```log + ``` [2022-07-09 21:55:19,164] INFO: _ ____ _ [2022-07-09 21:55:19,165] INFO: /\ | | | _ \ (_) [2022-07-09 21:55:19,166] INFO: / \ _ _| |_ ___ | |_) | __ _ _ __ __ _ _ _ _ __ ___ _ @@ -20,11 +24,11 @@ [2022-07-09 22:01:24,534] INFO: [NC-Raws] 继母的拖油瓶是我的前女友 - 01 (B-Global 1920x1080 HEVC AAC MKV) [0B604F3A].mkv >> 继母的拖油瓶是我的前女友 S01E01.mkv ``` 1. 如果出现如下 LOG，说明 AB 无法连接 qBittorrent，请检查 qBittorrent 是否正常运行，如果 qBittorrent 正常运行，转跳 [网络问题](/faq/常见问题#🌍-网络链接) 部分进行排查。 - ```log + ``` [2022-07-09 22:01:24,534] WARNING: Cannot connect to qBittorrent, wait 5min and retry ``` 2. 如果出现如下 LOG，说明 AB 无法连接到 Mikan RSS，请转跳到 [网络问题](/faq/常见问题#🌍-网络链接) 部分进行排查。 - ```log + ``` [2022-07-09 21:55:21,761] INFO: Start collecting RSS info. [2022-07-09 22:01:24,534] WARNING: Connected Failed，please check DNS/Connection ``` diff --git a/docs/home/index.md b/docs/home/index.md index e8f3021e..284e5140 100644 --- a/docs/home/index.md +++ b/docs/home/index.md @@ -1,8 +1,12 @@ +--- +title: 项目说明 +--- +

- - - + + +

@@ -11,16 +15,20 @@

- + AutoBangumi WebUI

-本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。 +**`AutoBangumi`** 是从 [Mikan Project](https://mikanani.me) 全自动追番整理下载工具。 +只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番、下载并整理文件， +整理后的番剧名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。 -[主项目地址](https://www.github.com/EstrellaXD/Auto_Bangumi) -/ [WebUI 仓库](https://github.com/Rewrite0/Auto_Bangumi_WebUI) -/ [Wiki 说明](https://www.github.com/EstrellaXD/Auto_Bangumi/wiki) - -## AutoBangumi 功能说明 +## 功能说明 - 简易单次配置就能持续使用 - 无需介入的 `RSS` 解析器，解析番组信息并且自动生成下载规则。 @@ -58,20 +66,11 @@ - 内置 TDMB 解析器，可以直接生成完整的 TMDB 格式的文件以及番剧信息。 - 对于 Mikan RSS 的反代支持。 -## 如何开始 - -- **[部署说明 (Official)](https://github.com/EstrellaXD/Auto_Bangumi/wiki)** -- **[2.6 版本更新说明](https://github.com/EstrellaXD/Auto_Bangumi/wiki/2.6更新说明)** -- **[3.0 版本更新说明](https://github.com/EstrellaXD/Auto_Bangumi/wiki/3.0更新说明)** -- **[部署说明 (手把手)](https://www.himiku.com/archives/auto-bangumi.html)** - ## 相关群组 - 更新推送：[Telegram Channel](https://t.me/autobangumi_update) - Bug 反馈群：[Telegram](https://t.me/+yNisOnDGaX5jMTM9) -# 声明 - ## 致谢 感谢 [Sean](https://github.com/findix) 提供的大量帮助 diff --git a/docs/image/config/downloader.png b/docs/image/config/downloader.png new file mode 100644 index 00000000..6109b29c Binary files /dev/null and b/docs/image/config/downloader.png differ diff --git a/docs/image/config/manager.png b/docs/image/config/manager.png new file mode 100644 index 00000000..24e21f6b Binary files /dev/null and b/docs/image/config/manager.png differ diff --git a/docs/image/config/notifier.png b/docs/image/config/notifier.png new file mode 100644 index 00000000..88a86c6e Binary files /dev/null and b/docs/image/config/notifier.png differ diff --git a/docs/image/config/parser.png b/docs/image/config/parser.png new file mode 100644 index 00000000..262be48d Binary files /dev/null and b/docs/image/config/parser.png differ diff --git a/docs/image/config/program.png b/docs/image/config/program.png new file mode 100644 index 00000000..84733b8a Binary files /dev/null and b/docs/image/config/program.png differ diff --git a/docs/image/config/proxy.png b/docs/image/config/proxy.png new file mode 100644 index 00000000..385819e5 Binary files /dev/null and b/docs/image/config/proxy.png differ diff --git a/docs/image/dark-icon.png b/docs/image/dark-icon.png deleted file mode 100644 index 6186ffd0..00000000 Binary files a/docs/image/dark-icon.png and /dev/null differ diff --git a/docs/image/dsm/create.png b/docs/image/dsm/create.png new file mode 100644 index 00000000..0aa57b94 Binary files /dev/null and b/docs/image/dsm/create.png differ diff --git a/docs/image/dsm/install-docker.png b/docs/image/dsm/install-docker.png new file mode 100644 index 00000000..b78d0fe4 Binary files /dev/null and b/docs/image/dsm/install-docker.png differ diff --git a/docs/image/dsm/new-compose.png b/docs/image/dsm/new-compose.png new file mode 100644 index 00000000..9012aac1 Binary files /dev/null and b/docs/image/dsm/new-compose.png differ diff --git a/docs/image/icons/dark-icon.svg b/docs/image/icons/dark-icon.svg new file mode 100644 index 00000000..f42427b9 --- /dev/null +++ b/docs/image/icons/dark-icon.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/image/icons/light-icon.svg b/docs/image/icons/light-icon.svg new file mode 100644 index 00000000..dc0c2102 --- /dev/null +++ b/docs/image/icons/light-icon.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/image/icons/mikan-icon.ico b/docs/image/icons/mikan-icon.ico new file mode 100644 index 00000000..8077da2f Binary files /dev/null and b/docs/image/icons/mikan-icon.ico differ diff --git a/docs/image/icons/mikan-pic.png b/docs/image/icons/mikan-pic.png new file mode 100644 index 00000000..823dfafd Binary files /dev/null and b/docs/image/icons/mikan-pic.png differ diff --git a/docs/image/icons/plex-icon.png b/docs/image/icons/plex-icon.png new file mode 100644 index 00000000..7d73b91c Binary files /dev/null and b/docs/image/icons/plex-icon.png differ diff --git a/docs/image/icons/qbittorrent-logo.svg b/docs/image/icons/qbittorrent-logo.svg new file mode 100644 index 00000000..59a79b0e --- /dev/null +++ b/docs/image/icons/qbittorrent-logo.svg @@ -0,0 +1,16 @@ + + + qbittorrent-new-light + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/image/icons/tmdb-icon.png b/docs/image/icons/tmdb-icon.png new file mode 100644 index 00000000..583d3d2b Binary files /dev/null and b/docs/image/icons/tmdb-icon.png differ diff --git a/docs/image/light-icon.png b/docs/image/light-icon.png deleted file mode 100644 index a264ebf2..00000000 Binary files a/docs/image/light-icon.png and /dev/null differ diff --git a/docs/image/preview/webui-home.png b/docs/image/preview/webui-home.png new file mode 100644 index 00000000..1f3ac87a Binary files /dev/null and b/docs/image/preview/webui-home.png differ diff --git a/docs/image/preview/window.png b/docs/image/preview/window.png new file mode 100644 index 00000000..54b39a8a Binary files /dev/null and b/docs/image/preview/window.png differ diff --git a/docs/image/rss/advanced-subscription.png b/docs/image/rss/advanced-subscription.png new file mode 100644 index 00000000..61713979 Binary files /dev/null and b/docs/image/rss/advanced-subscription.png differ diff --git a/docs/image/rss/rss-token.png b/docs/image/rss/rss-token.png new file mode 100644 index 00000000..31ade6c9 Binary files /dev/null and b/docs/image/rss/rss-token.png differ diff --git a/docs/image/window.png b/docs/image/window.png deleted file mode 100644 index f2b61272..00000000 Binary files a/docs/image/window.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index 73bc46c3..143414ce 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,23 +2,103 @@ # https://vitepress.dev/reference/default-theme-home-page layout: home +title: AutoBangumi +titleTemplate: 自动追番，解放双手！ + hero: name: AutoBangumi - tagline: 从 Mikan Project 全自动追番下载整理 + text: 自动追番，解放双手！ + tagline: 从 Mikan Project 全自动 订阅解析、下载管理、重命名整理 +# image: +# dark: /image/icons/dark-logo.svg +# light: /image/icons/light-logo.svg +# alt: AutoBangumi WebUI actions: - theme: brand text: 快速开始 - link: /deploy/ + link: /deploy/quick-start + - theme: alt + text: 项目说明 + link: /home/ - theme: alt text: 更新日志 link: /changelog/3.0 features: - - title: 自动解析下载规则 - details: 自动解析 Mikan Project RSS 并下载 - - title: 自动重命名 - details: 自动管理下载重命名的种子 - - title: 一键管理 - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - icon: + src: /image/icons/mikan-pic.png + title: Mikan Project 订阅源 + details: 自动识别蜜柑计划 RSS 订阅格式，无需手动输入番剧，仅需订阅即可自动解析、下载、整理。 + - icon: + src: /image/icons/qbittorrent-logo.svg + title: qBitTorrent 下载器 + details: 使用 qBitTorrent 共享下载番剧资源，在 AutoBangumi 中可管理已有番剧、下载旧番、删除番剧。 + - icon: + src: /image/icons/tmdb-icon.png + title: The Movie DB 解析匹配 + details: 可根据 TMDB 最大程度匹配对应番剧信息，保证对多个字幕组的资源也能正确匹配与解析。 + - icon: + src: /image/icons/plex-icon.png + title: Plex / Jellyfin / Infuse ... + details: 根据番剧匹配结果自动整理资源文件名，统一目录结构，保证各类媒体库元信息刮削成功率。 --- + +
+
+ +## 致谢声明 + +### Credits +Thanks to +- [Mikan Project](https://mikanani.me) for providing the so great anime resource. +- [VitePress](https://vitepress.dev) for providing a great documentation framework. +- [qBitTorrent](https://www.qbittorrent.org) for providing a great downloader. +- [Plex](https://www.plex.tv) / [Jellyfin](https://jellyfin.org) for providing some great self-host media libraries. +- [Infuse](https://firecore.com/infuse) for providing an elegant video player. +- [DanDan Play](https://www.dandanplay.com) for providing a great danmaku player. +- Every bangumi production team / translator team / fans. + +### Contributors + +[ + ![](https://contrib.rocks/image?repo=EstrellaXD/Auto_Bangumi){class=contributors-avatar} +](https://github.com/EstrellaXD/Auto_Bangumi/graphs/contributors) + + +
+
+ + + + + diff --git a/docs/package.json b/docs/package.json index 883484bb..6c29edc5 100644 --- a/docs/package.json +++ b/docs/package.json @@ -2,11 +2,13 @@ "private": true, "scripts": { "docs:dev": "vitepress dev", - "docs:build": "vitepress build", + "docs:build": "vitepress build && mkdir -p .vitepress/dist/image && cp -rf image/icons .vitepress/dist/image/", "docs:preview": "vitepress preview", "deploy:preview": "vercel --cwd .vitepress/dist" }, "devDependencies": { + "@vue/tsconfig": "^0.4.0", + "medium-zoom": "^1.0.8", "typescript": "4.9.5", "vercel": "31.0.1", "vitepress": "1.0.0-beta.3", diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml index b958b298..ce9570a2 100644 --- a/docs/pnpm-lock.yaml +++ b/docs/pnpm-lock.yaml @@ -1,6 +1,16 @@ lockfileVersion: '6.0' +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + devDependencies: + '@vue/tsconfig': + specifier: ^0.4.0 + version: 0.4.0 + medium-zoom: + specifier: ^1.0.8 + version: 1.0.8 typescript: specifier: 4.9.5 version: 4.9.5 @@ -2602,6 +2612,10 @@ packages: resolution: {integrity: sha512-7OjdcV8vQ74eiz1TZLzZP4JwqM5fA94K6yntPS5Z25r9HDuGNzaGdgvwKYq6S+MxwF0TFRwe50fIR/MYnakdkQ==} dev: true + /@vue/tsconfig@0.4.0: + resolution: {integrity: sha512-CPuIReonid9+zOG/CGTT05FXrPYATEqoDGNrEaqS4hwcw5BUNM2FguC0mOwJD4Jr16UpRVl9N0pY3P+srIbqmg==} + dev: true + /@vueuse/core@10.2.1(vue@3.3.4): resolution: {integrity: sha512-c441bfMbkAwTNwVRHQ0zdYZNETK//P84rC01aP2Uy/aRFCiie9NE/k9KdIXbno0eDYP5NPUuWv0aA/I4Unr/7w==} dependencies: @@ -4922,6 +4936,10 @@ packages: engines: {node: '>= 0.6'} dev: true + /medium-zoom@1.0.8: + resolution: {integrity: sha512-CjFVuFq/IfrdqesAXfg+hzlDKu6A2n80ZIq0Kl9kWjoHh9j1N9Uvk5X0/MmN0hOfm5F9YBswlClhcwnmtwz7gA==} + dev: true + /merge-descriptors@1.0.1: resolution: {integrity: sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w==} dev: true @@ -7085,7 +7103,3 @@ packages: /zwitch@2.0.4: resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==} dev: true - -settings: - autoInstallPeers: true - excludeLinksFromLockfile: false diff --git a/docs/public/dark-logo.svg b/docs/public/dark-logo.svg new file mode 100644 index 00000000..0bb7c9c0 --- /dev/null +++ b/docs/public/dark-logo.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/public/light-logo.svg b/docs/public/light-logo.svg new file mode 100644 index 00000000..63272925 --- /dev/null +++ b/docs/public/light-logo.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/docs/public/social.png b/docs/public/social.png new file mode 100644 index 00000000..73081939 Binary files /dev/null and b/docs/public/social.png differ diff --git a/docs/tsconfig.json b/docs/tsconfig.json new file mode 100644 index 00000000..1b32b4dc --- /dev/null +++ b/docs/tsconfig.json @@ -0,0 +1,4 @@ +{ + // https://github.com/vuejs/tsconfig + "extends": "@vue/tsconfig/tsconfig.json", +} diff --git a/docs/usage/manage.md b/docs/usage/manage.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/docs/usage/manage.md @@ -0,0 +1 @@ + diff --git a/docs/usage/manual.md b/docs/usage/manual.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/usage/webui.md b/docs/usage/webui.md new file mode 100644 index 00000000..60007b7c --- /dev/null +++ b/docs/usage/webui.md @@ -0,0 +1,37 @@ +# WebUI 使用说明 + +## 添加合集 + +AB 提供了两种手动下载的方式： +**Collect** 和 **Subscribe**。 +其中 **Collect** 为手动下载全部剧集，适用于下载已经完结的番剧。 +**Subscribe** 为手动添加自动下载规则以及对应的 RSS 链接，适用于下载尚未完结的番剧。 + +### 解析 RSS 链接 + +AB 支持解析所有资源站的合集 RSS 链接，在对应的资源站找到对应番剧合集 RSS，点击 AB 右上角的 **+** 号，在弹出的窗口中粘贴 RSS 链接即可。 + +### 添加下载 + +如果正常解析，则会弹出一个窗口，显示解析到的番剧信息，点击 **Collect** 或者 **Subscribe** 即可添加到下载队列。 + +### 常见问题 + +如果出现解析错误，可能是由于 RSS 链接不正确，或者 RSS 中字幕组的命名不支持解析。 + +## 管理番剧 + + +### 修改番剧信息 + +3.0 版本之后 AB 在 WebUI 中提供了手动管理番剧的功能，可以手动调整解析不正确的番剧信息。 + +在番剧列表中，点击番剧海报，即可进入番剧信息页面。 +修改番剧信息后，点击 **Apply** 即可。 +此时 AB 会根据你修改的信息重新调整目录并自动重命名。 + + +### 删除番剧 + +在 3.0 之后 AB 可以手动管理 + diff --git a/webui/src/components/basic/ab-add.vue b/webui/src/components/basic/ab-add.vue index 43b8ecdf..51ede24f 100644 --- a/webui/src/components/basic/ab-add.vue +++ b/webui/src/components/basic/ab-add.vue @@ -18,8 +18,8 @@ defineEmits(['click']);