mirror of
https://github.com/EstrellaXD/Auto_Bangumi.git
synced 2026-04-14 02:20:53 +08:00
Merge branch 'main' into experimental-openai-docs
This commit is contained in:
Xiaoyue Lin
2
.github/workflows/build.yml
vendored
2
.github/workflows/build.yml
vendored
@@ -36,7 +36,7 @@ jobs:
|
||||
- name: If release
|
||||
id: release
|
||||
run: |
|
||||
if [ '${{ github.event_name }}' == 'pull_request' ]; then
|
||||
if [[ '${{ github.event_name }}' == 'pull_request' && '${{ github.ref }}' == *'dev'* ]]; then
|
||||
if [ ${{ github.event.pull_request.merged }} == true ]; then
|
||||
echo "release=1" >> $GITHUB_OUTPUT
|
||||
else
|
||||
|
||||
15
README.md
15
README.md
@@ -19,7 +19,8 @@
|
||||
<img title="AutoBangumi" src="docs/image/preview/window.png" alt="" width=75%>
|
||||
</p>
|
||||
|
||||
本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。
|
||||
本项目是基于 RSS 的全自动追番整理下载工具。只需要在 [Mikan Project][mikan] 等网站上订阅番剧，就可以全自动追番。
|
||||
并且整理完成的名称和目录可以直接被 [Plex][plex]、[Jellyfin][plex] 等媒体库软件识别，无需二次刮削。
|
||||
|
||||
## AutoBangumi 功能说明
|
||||
|
||||
@@ -55,9 +56,9 @@
|
||||
- 自定义重命名，可以根据上级文件夹对所有子文件重命名。
|
||||
- 季中追番可以补全当季遗漏的所有剧集
|
||||
- 高度可自定义的功能选项，可以针对不同媒体库软件微调
|
||||
- 支持多种 RSS 站点，支持聚合 RSS 的解析。
|
||||
- 无需维护完全无感使用
|
||||
- 内置 TDMB 解析器，可以直接生成完整的 TMDB 格式的文件以及番剧信息。
|
||||
- 对于 Mikan RSS 的反代支持。
|
||||
|
||||
## 相关群组
|
||||
|
||||
@@ -66,15 +67,9 @@
|
||||
|
||||
## [Roadmap](https://github.com/users/EstrellaXD/projects/2)
|
||||
|
||||
***开发中的功能：***
|
||||
|
||||
- 内置 RSS 推送更新器。
|
||||
- 搜索功能
|
||||
|
||||
***计划开发的功能：***
|
||||
|
||||
- 对其他站点种子的解析归类。
|
||||
- 本地化番剧订阅方式。
|
||||
- Transmission 的支持。
|
||||
|
||||
## Star History
|
||||
@@ -93,3 +88,7 @@
|
||||
## Licence
|
||||
|
||||
[MIT licence](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/LICENSE)
|
||||
|
||||
[mikan]: https://mikanani.me
|
||||
[plex]: https://plex.tv
|
||||
[jellyfin]: https://jellyfin.org
|
||||
|
||||
@@ -1,183 +1,206 @@
|
||||
import { defineConfig } from "vitepress";
|
||||
import {defineConfig} from 'vitepress';
|
||||
|
||||
const version = `v3.0`
|
||||
|
||||
const version = `v3.1`
|
||||
|
||||
// https://vitepress.dev/reference/site-config
|
||||
// @ts-ignore
|
||||
export default defineConfig({
|
||||
title: "AutoBangumi",
|
||||
description: "从 Mikan Project 全自动追番下载整理",
|
||||
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' }],
|
||||
["script", { src: 'https://www.googletagmanager.com/gtag/js?id=G-3Z8W6WMN7J' }],
|
||||
["script", {}, "window.dataLayer = window.dataLayer || [];\nfunction gtag(){dataLayer.push(arguments);}\ngtag('js', new Date());\ngtag('config', 'G-3Z8W6WMN7J');"],
|
||||
],
|
||||
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'}],
|
||||
["script", {src: '/_vercel/insights/script.js'}]
|
||||
],
|
||||
|
||||
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: '<svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0 0 24 24"><title>Telegram</title><path d="M11.944 0A12 12 0 0 0 0 12a12 12 0 0 0 12 12 12 12 0 0 0 12-12A12 12 0 0 0 12 0a12 12 0 0 0-.056 0zm4.962 7.224c.1-.002.321.023.465.14a.506.506 0 0 1 .171.325c.016.093.036.306.02.472-.18 1.898-.962 6.502-1.36 8.627-.168.9-.499 1.201-.82 1.23-.696.065-1.225-.46-1.9-.902-1.056-.693-1.653-1.124-2.678-1.8-1.185-.78-.417-1.21.258-1.91.177-.184 3.247-2.977 3.307-3.23.007-.032.014-.15-.056-.212s-.174-.041-.249-.024c-.106.024-1.793 1.14-5.061 3.345-.48.33-.913.49-1.302.48-.428-.008-1.252-.241-1.865-.44-.752-.245-1.349-.374-1.297-.789.027-.216.325-.437.893-.663 3.498-1.524 5.83-2.529 6.998-3.014 3.332-1.386 4.025-1.627 4.476-1.635z"/></svg>'
|
||||
themeConfig: {
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
logo: {
|
||||
dark: '/dark-logo.svg',
|
||||
light: '/light-logo.svg',
|
||||
},
|
||||
link: "https://t.me/autobangumi"
|
||||
},
|
||||
],
|
||||
|
||||
nav: [
|
||||
{ text: "项目说明", link: "/home/" },
|
||||
{ text: "快速开始", link: "/deploy/quick-start" },
|
||||
{ text: "排错流程", link: "/faq/排错流程" },
|
||||
{ text: "常见问题", link: "/faq/常见问题" },
|
||||
],
|
||||
editLink: {
|
||||
pattern: 'https://github.com/vitejs/vite/blob/3.1-dev/docs/:path',
|
||||
text: 'Edit this page',
|
||||
},
|
||||
|
||||
footer: {
|
||||
message: `AutoBangumi Released under the MIT License. (latest: ${version})`,
|
||||
copyright: 'Copyright © 2021-present @EstrellaXD & AutoBangumi Contributors',
|
||||
search: {
|
||||
provider: 'local'
|
||||
},
|
||||
|
||||
socialLinks: [
|
||||
{icon: "github", link: "https://github.com/EstrellaXD/Auto_Bangumi"},
|
||||
{
|
||||
icon: {
|
||||
svg: '<svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0 0 24 24"><title>Telegram</title><path d="M11.944 0A12 12 0 0 0 0 12a12 12 0 0 0 12 12 12 12 0 0 0 12-12A12 12 0 0 0 12 0a12 12 0 0 0-.056 0zm4.962 7.224c.1-.002.321.023.465.14a.506.506 0 0 1 .171.325c.016.093.036.306.02.472-.18 1.898-.962 6.502-1.36 8.627-.168.9-.499 1.201-.82 1.23-.696.065-1.225-.46-1.9-.902-1.056-.693-1.653-1.124-2.678-1.8-1.185-.78-.417-1.21.258-1.91.177-.184 3.247-2.977 3.307-3.23.007-.032.014-.15-.056-.212s-.174-.041-.249-.024c-.106.024-1.793 1.14-5.061 3.345-.48.33-.913.49-1.302.48-.428-.008-1.252-.241-1.865-.44-.752-.245-1.349-.374-1.297-.789.027-.216.325-.437.893-.663 3.498-1.524 5.83-2.529 6.998-3.014 3.332-1.386 4.025-1.627 4.476-1.635z"/></svg>'
|
||||
},
|
||||
link: "https://t.me/autobangumi"
|
||||
},
|
||||
],
|
||||
|
||||
nav: [
|
||||
{text: "项目说明", link: "/home/"},
|
||||
{text: "快速开始", link: "/deploy/quick-start"},
|
||||
{text: "常见问题", link: "/faq/"},
|
||||
],
|
||||
footer: {
|
||||
message: `AutoBangumi Released under the MIT License. (latest: ${version})`,
|
||||
copyright: 'Copyright © 2021-present @EstrellaXD & AutoBangumi Contributors',
|
||||
},
|
||||
|
||||
sidebar: [
|
||||
{
|
||||
items: [
|
||||
{
|
||||
text: "项目说明",
|
||||
link: "/home/",
|
||||
},
|
||||
{
|
||||
text: "快速开始",
|
||||
link: "/deploy/quick-start",
|
||||
},
|
||||
{
|
||||
text: "运行原理",
|
||||
link: "/home/pipline",
|
||||
}
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "部署",
|
||||
items: [
|
||||
{
|
||||
text: "Docker-cli 部署",
|
||||
link: "/deploy/docker-cli",
|
||||
},
|
||||
{
|
||||
text: "Docker-Compose 部署",
|
||||
link: "/deploy/docker-compose",
|
||||
},
|
||||
{
|
||||
text: "群晖NAS",
|
||||
link: "/deploy/dsm",
|
||||
},
|
||||
{
|
||||
text: "WSL",
|
||||
link: "/deploy/wsl",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "源码运行",
|
||||
items: [
|
||||
{
|
||||
text: "Windows 本地部署",
|
||||
link: "/deploy/windows",
|
||||
},
|
||||
{
|
||||
text: "Unix 本地部署",
|
||||
link: "/deploy/unix",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "配置说明",
|
||||
items: [
|
||||
{
|
||||
text: "获取 RSS 订阅链接",
|
||||
link: "/config/rss",
|
||||
},
|
||||
{
|
||||
text: "主程序配置",
|
||||
link: "/config/program",
|
||||
},
|
||||
{
|
||||
text: "下载器配置",
|
||||
link: "/config/downloader",
|
||||
},
|
||||
{
|
||||
text: "解析器配置",
|
||||
link: "/config/parser",
|
||||
},
|
||||
{
|
||||
text: "推送器配置",
|
||||
link: "/config/notifier",
|
||||
},
|
||||
{
|
||||
text: "番剧管理配置",
|
||||
link: "/config/manager",
|
||||
},
|
||||
{
|
||||
text: "代理配置",
|
||||
link: "/config/proxy",
|
||||
},
|
||||
{
|
||||
text: "实验功能配置",
|
||||
link: "/config/experimental",
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
text: "功能说明",
|
||||
items: [
|
||||
{
|
||||
text: "RSS 管理",
|
||||
link: "/feature/rss",
|
||||
},
|
||||
{
|
||||
text: "重命名",
|
||||
link: "/feature/rename",
|
||||
},
|
||||
{
|
||||
text: "搜索番组",
|
||||
link: "/feature/search",
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
text: "FAQ",
|
||||
items: [
|
||||
{
|
||||
text: "常见问题",
|
||||
link: "/faq/",
|
||||
},
|
||||
{
|
||||
text: "排错流程",
|
||||
link: "/faq/troubleshooting",
|
||||
},
|
||||
{
|
||||
text: "网络问题",
|
||||
link: "/faq/mikan-network",
|
||||
}
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "更新日志",
|
||||
items: [
|
||||
{
|
||||
text: "3.1 更新说明",
|
||||
link: "/changelog/3.1",
|
||||
},
|
||||
{
|
||||
text: "3.0 更新说明",
|
||||
link: "/changelog/3.0",
|
||||
},
|
||||
{
|
||||
text: "2.6 更新说明",
|
||||
link: "/changelog/2.6",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "开发者文档",
|
||||
items: [
|
||||
{
|
||||
text: "贡献指南",
|
||||
link: "/dev/",
|
||||
},
|
||||
]
|
||||
}
|
||||
],
|
||||
},
|
||||
|
||||
sidebar: [
|
||||
{
|
||||
items: [
|
||||
{
|
||||
text: "项目说明",
|
||||
link: "/home/",
|
||||
},
|
||||
{
|
||||
text: "快速开始",
|
||||
link: "/deploy/quick-start",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "部署",
|
||||
items: [
|
||||
{
|
||||
text: "Docker-cli 部署",
|
||||
link: "/deploy/docker-cli",
|
||||
},
|
||||
{
|
||||
text: "Docker-Compose 部署",
|
||||
link: "/deploy/docker-compose",
|
||||
},
|
||||
{
|
||||
text: "群晖NAS",
|
||||
link: "/deploy/dsm",
|
||||
},
|
||||
{
|
||||
text: "WSL",
|
||||
link: "/deploy/wsl",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "源码运行",
|
||||
items: [
|
||||
{
|
||||
text: "Windows 本地部署",
|
||||
link: "/deploy/windows",
|
||||
},
|
||||
{
|
||||
text: "Unix 本地部署",
|
||||
link: "/deploy/unix",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "配置说明",
|
||||
items: [
|
||||
{
|
||||
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: "实验功能配置",
|
||||
link: "/config/experimental",
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
text: "WebUI 使用说明",
|
||||
link: "/usage/webui",
|
||||
},
|
||||
{
|
||||
text: "FAQ",
|
||||
items: [
|
||||
{
|
||||
text: "排错流程",
|
||||
link: "/faq/排错流程",
|
||||
},
|
||||
{
|
||||
text: "常见问题",
|
||||
link: "/faq/常见问题",
|
||||
},
|
||||
{
|
||||
text: "网络问题",
|
||||
link: "/faq/mikan-network",
|
||||
}
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "更新日志",
|
||||
items: [
|
||||
{
|
||||
text: "3.0 更新说明",
|
||||
link: "/changelog/3.0",
|
||||
},
|
||||
{
|
||||
text: "2.6 更新说明",
|
||||
link: "/changelog/2.6",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "开发者文档",
|
||||
items: [
|
||||
{
|
||||
text: "贡献指南",
|
||||
link: "/dev/",
|
||||
},
|
||||
]
|
||||
}
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
@@ -1,45 +1,50 @@
|
||||
// https://vitepress.dev/guide/custom-theme
|
||||
import {
|
||||
h,
|
||||
onMounted,
|
||||
watch,
|
||||
nextTick,
|
||||
import {
|
||||
h,
|
||||
onMounted,
|
||||
watch,
|
||||
nextTick,
|
||||
} from 'vue'
|
||||
import Theme from 'vitepress/theme'
|
||||
import { useRoute } from 'vitepress'
|
||||
import {useRoute} from 'vitepress'
|
||||
import mediumZoom from 'medium-zoom'
|
||||
import Documate from '@documate/vue'
|
||||
import '@documate/vue/dist/style.css'
|
||||
import HomePreviewWebUI from './components/HomePreviewWebUI.vue'
|
||||
|
||||
import './style.css'
|
||||
|
||||
export default {
|
||||
extends: Theme,
|
||||
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()
|
||||
})
|
||||
extends: Theme,
|
||||
Layout: () => {
|
||||
return h(Theme.Layout, null, {
|
||||
// https://vitepress.dev/guide/extending-default-theme#layout-slots
|
||||
'home-features-after': () => h(HomePreviewWebUI),
|
||||
'nav-bar-content-before': () => h(Documate, {
|
||||
endpoint: '',
|
||||
}),
|
||||
})
|
||||
},
|
||||
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)'})
|
||||
}
|
||||
|
||||
watch(
|
||||
() => route.path,
|
||||
() => nextTick(initZoom),
|
||||
)
|
||||
},
|
||||
enhanceApp({ app, router, siteData }) {
|
||||
// ...
|
||||
}
|
||||
onMounted(() => {
|
||||
initZoom()
|
||||
})
|
||||
|
||||
watch(
|
||||
() => route.path,
|
||||
() => nextTick(initZoom),
|
||||
)
|
||||
},
|
||||
enhanceApp({app, router, siteData}) {
|
||||
// ...
|
||||
}
|
||||
}
|
||||
|
||||
47
docs/changelog/3.1.md
Normal file
47
docs/changelog/3.1.md
Normal file
@@ -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 细节。
|
||||
34
docs/config/manager.md
Normal file
34
docs/config/manager.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 番剧管理设置
|
||||
|
||||
## WebUI 配置
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
<br/>
|
||||
|
||||
- **Enable** 为是否启用番剧管理，如果不启用番剧管理，下面的配置项将不会生效。
|
||||
- **Rename method** 为重命名方式，目前支持
|
||||
- `pn` 为 `Torrent Title S0XE0X.mp4` 的方式。
|
||||
- `advance` 为 `Official Title S0XE0X.mp4` 的方式。
|
||||
- `none` 为不重命名。
|
||||
- **Eps complete** 为是否补全当季番剧，如果开启，则会补全当季番剧，如果关闭，则不会补全当季番剧。
|
||||
- **Add group tag** 为是否在下载规则中添加番剧组标签，如果开启，则会在下载规则中添加番剧组标签。
|
||||
- **Delete bad torrent** 为是否删除错误的种子，如果开启，则会删除错误的种子。
|
||||
- [文件路径以及重命名相关][1]
|
||||
|
||||
## `config.json` 中的配置选项
|
||||
|
||||
在配置文件中对应选项如下：
|
||||
|
||||
配置文件部分：`bangumi_manager`
|
||||
|
||||
| 参数名 | 参数说明 | 参数类型 | WebUI 对应选项 | 默认值 |
|
||||
|--------------------|-----------------|------|------------|-------|
|
||||
| enable | 番剧管理是否启用 | 布尔值 | 番剧管理是否启用 | true |
|
||||
| eps_complete | 是否补全当季番剧 | 布尔值 | 番剧补全 | false |
|
||||
| rename_method | 重命名方式 | 字符串 | 重命名方式 | pn |
|
||||
| group_tag | 是否在下载规则中添加番剧组标签 | 布尔值 | 番剧组标签 | false |
|
||||
| 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
|
||||
@@ -2,40 +2,33 @@
|
||||
|
||||
AB 的解析器用于解析聚合 RSS 链接，如果 RSS 有新条目更新，AB 就会解析标题并且生成自动下载规则。
|
||||
|
||||
## ⚠️ Notice:
|
||||
|
||||
v3.1 版本以后解析器设置迁移到各个单独的 RSS 设置中，如果需要配置**解析器类型**，请参考 [为 RSS 设定解析器][add_rss]。
|
||||
|
||||
## Webui 中的解析器设置
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
<br/>
|
||||
|
||||
- **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]: /feature/rss#解析器设置
|
||||
[reproxy]: proxy##反向代理设置
|
||||
@@ -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` 中的配置选项
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# 准备 Mikan RSS 订阅链接
|
||||
|
||||
AutoBangumi 可以自动解析 [Mikan Project][mikan-site] 的 RSS 订阅地址，根据字幕组以及番剧名称生成下载规则， 从而实现自动追番。
|
||||
因此在开始自动追番之前，你需要准备好 [Mikan Project][mikan-site] 的 RSS 订阅地址。
|
||||
AutoBangumi 可以自动解析番剧聚合 RSS，根据字幕组以及番剧名称生成下载规则， 从而实现自动追番。
|
||||
以下以 [Mikan Project][mikan-site] 为例，介绍如何获取 RSS 订阅地址。
|
||||
|
||||
需要注意的是，目前 Mikan Project 主站已经被墙，当你不知道如何使用代理时请使用如下链接进行访问订阅：
|
||||
|
||||
@@ -21,8 +21,6 @@ https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符。
|
||||
|
||||
## Mikan Project 订阅贴士
|
||||
|
||||
由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点：
|
||||
|
||||
@@ -45,17 +45,17 @@ services:
|
||||
- AutoBangumi_config:/app/config
|
||||
- AutoBangumi_data:/app/data
|
||||
ports:
|
||||
- 7892:7892
|
||||
- "7892:7892"
|
||||
restart: unless-stopped
|
||||
dns:
|
||||
- 223.5.5.5
|
||||
network_mode: bridge
|
||||
|
||||
volumes:
|
||||
AutoBangumi_config:
|
||||
name: AutoBangumi_config
|
||||
AutoBangumi_data:
|
||||
name: AutoBangumi_data
|
||||
AutoBangumi_config:
|
||||
name: AutoBangumi_config
|
||||
AutoBangumi_data:
|
||||
name: AutoBangumi_data
|
||||
```
|
||||
|
||||
运行以下命令启动容器。
|
||||
@@ -72,7 +72,7 @@ docker compose up -d
|
||||
- [在 Windows/macOS 中安装 qBittorrent][qbittorrent-desktop]
|
||||
- [在 Linux 中安装 qBittorrent-nox][qbittorrent-nox]
|
||||
|
||||
## 获取 Mikan Project 的 RSS 链接
|
||||
## 获取聚合 RSS 链接 (以蜜柑计划的聚合 RSS 为例)
|
||||
|
||||
进入 [MiKan Project][mikan-project]，注册账号并登录，然后点击右下角的 **RSS** 按钮，复制链接。
|
||||
|
||||
@@ -85,7 +85,6 @@ https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
# 或者
|
||||
https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
```
|
||||
复制 token= 后面的内容。
|
||||
|
||||
详细步骤参考 [Mikan RSS][config-rss]
|
||||
|
||||
@@ -98,11 +97,15 @@ https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
2. 填入 Mikan RSS 的 Token。
|
||||
2. 点击 **Apply** 保存配置，此时 AB 会重启运行，当右上角的圆点变为绿色时，表示 AB 已经正常运行。
|
||||
|
||||
3. 点击右上角的添加按钮，勾选 **聚合 RSS**， 选择解析器类型，填入 Mikan RSS 的地址。
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
等待 AB 解析聚合 RSS，解析完成会自动添加番剧并且下载管理。
|
||||
|
||||
{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
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -8,11 +8,7 @@
|
||||
cd Auto_Bangumi
|
||||
```
|
||||
|
||||
2. 创建版本信息文件：
|
||||
|
||||
```powershell
|
||||
echo "VERSION='local'" > backend\src\module\__version__.py
|
||||
```
|
||||
2. 在 `backend\src` 目录下创建 `__version__.py` 文件并写入 `VERSION='local', 请注意文件编码格式为 `UTF-8`：
|
||||
|
||||
3. 新建 `python` 虚拟环境、激活并安装依赖（需保证 `python -V` 打印的版本符合 `Dockerfile` 中的要求，如 `FROM python:3.11-alpine AS APP`）
|
||||
|
||||
@@ -25,7 +21,7 @@
|
||||
4. 下载 WebUI 并安装：
|
||||
|
||||
```powershell
|
||||
Invoke-WebRequest -Uri "https://github.com/Rewrite0/Auto_Bangumi_WebUI/releases/latest/download/dist.zip" -OutFile "dist.zip"
|
||||
Invoke-WebRequest -Uri "https://github.com/EstrellaXD/Auto_Bangumi/releases/latest/download/dist.zip" -OutFile "dist.zip"
|
||||
Expand-Archive -Path "dist.zip"
|
||||
mv dist\* backend\src\templates
|
||||
```
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
### WebUI 地址
|
||||
|
||||
默认端口为 7892，请访问 `http://serverhost:7892`，如果你修改了端口，请记得同时更改 Docker 中的端口映射。
|
||||
默认端口为 7892，如果是服务器部署，请访问 `http://serverhost:7892`，如果本地部署可以访问 `http://localhost:7892` 。如果你修改了端口，请记得同时更改 Docker 中的端口映射。
|
||||
|
||||
### 默认用户名和密码
|
||||
|
||||
@@ -27,7 +27,12 @@
|
||||
|
||||
### 海报墙没有显示图片
|
||||
|
||||
AB 默认使用 `mikanani.me` 的地址作为海报图片的源地址，如果没有显示图片说明你访问 AB 主页的主机网络环境不能访问这些图片。
|
||||
- 如果你的版本是 3.0：
|
||||
AB 默认使用 `mikanani.me` 的地址作为海报图片的源地址，如果没有显示图片说明你访问 AB 主页的主机网络环境不能访问这些图片。
|
||||
- 如果你的版本是 3.1 以及以后：
|
||||
- 如果海报为图片错误 ICON，说明缺少图片，可以点击右上角菜单中的刷新海报获取 TMDB 海报。
|
||||
- 如果海报为图片无法加载，请清除浏览器缓存。
|
||||
- 使用 `mikanani.tv` 为 RSS 地址，在访问 WebUI 的时候客户端上如果有代理，可能会导致海报无法加载。为其添加 `direct` 规则即可。
|
||||
|
||||
## 3.0 是如何管理番剧的
|
||||
|
||||
@@ -47,12 +52,8 @@ AB 默认使用 `mikanani.me` 的地址作为海报图片的源地址，如果
|
||||
|
||||
### 没有开始自动下载怎么办：
|
||||
|
||||
- 检查 AutoBangumi 的日志，如果日志一切正常，说明是 qBittorrent 的设置问题，检查：
|
||||
- 设置 >> RSS >> 启用 RSS Torrent 自动下载
|
||||
- Options >> RSS >> Enable auto downloading of RSS torrents
|
||||
- 设置 >> RSS >> 启用获取 RSS 订阅
|
||||
- Options >> RSS >> Enable fetching RSS feeds
|
||||
- 检查 qb 配置，看是否有权限新建文件夹
|
||||
请检查 AutoBangumi 的日志，是否有添加种子相关的日志。
|
||||
- 如果没有，请检查订阅是否正确。
|
||||
|
||||
### 下载没有存储在正确的目录中
|
||||
|
||||
@@ -150,7 +151,7 @@ AB 中的过滤关键词是正则表达式，只会在建立规则的时候添
|
||||
- 如果 DNS 解析正常，添加代理。
|
||||
- 使用 TMDB 请添加代理。
|
||||
|
||||
### 如何给 Mikanani 添加代理
|
||||
### 如何给 Mikan 添加代理
|
||||
|
||||
AB 现在提供三种代理模式
|
||||
1. HTTP 以及 Socks 代理
|
||||
@@ -192,4 +193,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
|
||||
@@ -23,18 +23,18 @@ title: 排错流程
|
||||
[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
|
||||
```
|
||||
1. 如果出现如下 LOG，说明 AB 无法连接 qBittorrent，请检查 qBittorrent 是否正常运行，如果 qBittorrent 正常运行，转跳 [网络问题](/faq/常见问题#🌍-网络链接) 部分进行排查。
|
||||
1. 如果出现如下 LOG，说明 AB 无法连接 qBittorrent，请检查 qBittorrent 是否正常运行，如果 qBittorrent 正常运行，转跳 [网络问题](/faq/#🌍-网络链接) 部分进行排查。
|
||||
```
|
||||
[2022-07-09 22:01:24,534] WARNING: Cannot connect to qBittorrent, wait 5min and retry
|
||||
```
|
||||
2. 如果出现如下 LOG，说明 AB 无法连接到 Mikan RSS，请转跳到 [网络问题](/faq/常见问题#🌍-网络链接) 部分进行排查。
|
||||
2. 如果出现如下 LOG，说明 AB 无法连接到 Mikan RSS，请转跳到 [网络问题](/faq/#🌍-网络链接) 部分进行排查。
|
||||
```
|
||||
[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
|
||||
```
|
||||
3. 如果此时 QB 中没有下载任务，请转到 RSS 自动下载规则页面，检查 AB 建立的规则是否正确。
|
||||
1. 查看 RSS 订阅，如果是正常的 RSS 图标，说明 RSS 订阅正常，如果是**问题图标**，说明 RSS 订阅有问题，请检查 qBittorrent 与 Mikan RSS 的连通性。
|
||||
2. 如果没有任何下载规则，请检查 RSS 订阅是否是空白，`filter` 是否设置太多过滤值，转跳 [过滤问题](/faq/常见问题#下载以及关键词过滤) 。
|
||||
2. 如果没有任何下载规则，请检查 RSS 订阅是否是空白，`filter` 是否设置太多过滤值，转跳 [过滤问题](/faq/#下载以及关键词过滤) 。
|
||||
3. 检查添加的规则是否是正确的，如果出现错误，请到 [issue](https://www.github.com/EstrellaXD/Auto_Bangumi/issues) 反馈。
|
||||
4. 如果有下载规则没有下载，点击规则，并且检查右侧是否命中条目。如果没有命中条目，请删除一下过滤值。
|
||||
5. 检查自动下载规则中「总是暂停」是否关闭
|
||||
2
docs/feature/rename.md
Normal file
2
docs/feature/rename.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 重命名使用说明
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# WebUI 使用说明
|
||||
# RSS 管理使用说明
|
||||
|
||||
## 添加合集
|
||||
|
||||
26
docs/feature/search.md
Normal file
26
docs/feature/search.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# 搜索功能
|
||||
|
||||
在 3.1 版本之后 AB 添加了搜索功能，可以通过搜索功能快速找到想要的番剧。
|
||||
|
||||
## 使用搜索功能
|
||||
|
||||
搜索栏位于 AB 顶栏，可以在搜索栏右侧选择想要搜索的源站，比如：蜜柑计划、nyaa 等
|
||||
|
||||
选择对应的源站输入关键词，AB 即可自动解析搜索结果并展示。如果想要添加对应的番剧，点击卡片右侧的添加按钮即可。
|
||||
|
||||
## ⚠️注意
|
||||
|
||||
源站为 **Mikan** 是 AB 默认使用 `mikan` 解析器，如果使用其他源站，默认使用 TMDB 解析器。
|
||||
|
||||
## 增加源站
|
||||
|
||||
用户可以手动增加源站列表，只需要更改 `config/search_provider.json` 即可。
|
||||
默认为
|
||||
```json
|
||||
{
|
||||
"mikan": "https://mikanani.me/RSS/Search?searchstr=%s",
|
||||
"nyaa": "https://nyaa.si/?page=rss&q=%s&c=0_0&f=0",
|
||||
"dmhy": "http://dmhy.org/topics/rss/rss.xml?keyword=%s",
|
||||
"bangumi.moe": "https://bangumi.moe/rss/search/%s"
|
||||
}
|
||||
```
|
||||
@@ -24,9 +24,8 @@ title: 项目说明
|
||||
>
|
||||
</p>
|
||||
|
||||
**`AutoBangumi`** 是从 [Mikan Project](https://mikanani.me) 全自动追番整理下载工具。
|
||||
只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番、下载并整理文件，
|
||||
整理后的番剧名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。
|
||||
**`AutoBangumi`** 是基于 RSS 的全自动追番整理下载工具。只需要在 [Mikan Project][mikan] 等网站上订阅番剧，就可以全自动追番。
|
||||
并且整理完成的名称和目录可以直接被 [Plex][plex]、[Jellyfin][plex] 等媒体库软件识别，无需二次刮削。
|
||||
|
||||
## 功能说明
|
||||
|
||||
@@ -97,3 +96,8 @@ AutoBangumi 仅供学习交流使用。
|
||||
## Licence
|
||||
|
||||
[MIT licence](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/LICENSE)
|
||||
|
||||
[mikan]: https://mikanani.me
|
||||
[plex]: https://plex.tv
|
||||
[jellyfin]: https://jellyfin.org
|
||||
|
||||
|
||||
3
docs/home/pipline.md
Normal file
3
docs/home/pipline.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# AutoBangumi 是如何工作的
|
||||
|
||||
AutoBangumi 下简称 AB，的本质是一种 RSS 解析器。通过解析
|
||||
BIN
docs/image/config/add-rss.png
Normal file
BIN
docs/image/config/add-rss.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 106 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 101 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 94 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 93 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
BIN
docs/image/icons/rss.png
Normal file
BIN
docs/image/icons/rss.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.4 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.7 MiB After Width: | Height: | Size: 2.6 MiB |
@@ -8,7 +8,7 @@ titleTemplate: 自动追番，解放双手！
|
||||
hero:
|
||||
name: AutoBangumi
|
||||
text: 自动追番，解放双手！
|
||||
tagline: 从 Mikan Project 全自动 订阅解析、下载管理、重命名整理
|
||||
tagline: 从 RSS 全自动 订阅解析、下载管理、重命名整理
|
||||
# image:
|
||||
# dark: /image/icons/dark-logo.svg
|
||||
# light: /image/icons/light-logo.svg
|
||||
@@ -26,9 +26,9 @@ hero:
|
||||
|
||||
features:
|
||||
- icon:
|
||||
src: /image/icons/mikan-pic.png
|
||||
title: Mikan Project 订阅源
|
||||
details: 自动识别蜜柑计划 RSS 订阅格式，无需手动输入番剧，仅需订阅即可自动解析、下载、整理。
|
||||
src: /image/icons/rss.png
|
||||
title: RSS 订阅解析
|
||||
details: 自动识别解析各种番剧 RSS，无需手动输入番剧，仅需订阅即可自动解析、下载、整理。
|
||||
- icon:
|
||||
src: /image/icons/qbittorrent-logo.svg
|
||||
title: qBitTorrent 下载器
|
||||
|
||||
@@ -4,17 +4,20 @@
|
||||
"docs:dev": "vitepress dev",
|
||||
"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"
|
||||
"deploy:preview": "vercel --cwd .vitepress/dist",
|
||||
"documate:upload": "documate upload"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@documate/documate": "^0.2.0",
|
||||
"@vue/tsconfig": "^0.4.0",
|
||||
"medium-zoom": "^1.0.8",
|
||||
"typescript": "4.9.5",
|
||||
"vercel": "31.0.1",
|
||||
"vitepress": "1.0.0-beta.3",
|
||||
"vitepress": "1.0.0-rc.4",
|
||||
"vue": "3.3.4"
|
||||
},
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
"@vercel/analytics": "^1.0.1"
|
||||
"@documate/vue": "^0.3.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
1092
docs/pnpm-lock.yaml
generated
1092
docs/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
171
docs/use/使用说明.md
171
docs/use/使用说明.md
@@ -1,171 +0,0 @@
|
||||
# API
|
||||
|
||||
## 与 AutoBangumi 数据相关的 API
|
||||
|
||||
### `api/v1/log`
|
||||
|
||||
查看日志
|
||||
|
||||
```bash
|
||||
curl -X GET http://ab_host:7892/api/v1/log
|
||||
```
|
||||
|
||||
### `api/v1/data`
|
||||
|
||||
获得当前 AB 中的存储信息
|
||||
|
||||
```bash
|
||||
curl --request GET -sL \
|
||||
--url 'http://ab_host:7892/api/v1/data'\
|
||||
```
|
||||
|
||||
### `api/v1/resetRule`
|
||||
|
||||
重置 AB 的数据，程序会在下一轮检索中重新添加 RSS 订阅信息。
|
||||
|
||||
```bash
|
||||
curl --request GET -sL \
|
||||
--url 'http://ab_host:7892/api/v1/resetRule'\
|
||||
```
|
||||
|
||||
### `api/v1/removeRule/{name}`
|
||||
|
||||
删除规则
|
||||
|
||||
```bash
|
||||
curl --request GET -sL \
|
||||
--url 'http://ab_host:7892/api/v1/removeRule/{name}'\
|
||||
```
|
||||
|
||||
## 订阅相关的 API
|
||||
|
||||
如果番剧还在更新，请使用 subscribe 来订阅，如果番剧已经完结，请使用 collection 来下载。
|
||||
|
||||
### `api/v1/subscribe`
|
||||
|
||||
添加全集订阅
|
||||
|
||||
```bash
|
||||
curl --request POST -sL \
|
||||
--url 'http://host:7892/api/v1/subscribe'\
|
||||
--data '{"rss_link":"link"}'\
|
||||
--header 'Content-Type: application/json'
|
||||
```
|
||||
|
||||
### `api/v1/collection/`
|
||||
|
||||
```bash
|
||||
curl --request POST -sL \
|
||||
--url 'http://host:7892/api/v1/collection/'\
|
||||
--data '{"rss_link":"link"}'\
|
||||
--header 'Content-Type: application/json'
|
||||
```
|
||||
|
||||
# 环境变量说明
|
||||
|
||||
## 注意
|
||||
|
||||
环境变量相关配置在 `2.6` 以后的版本中已经移除，现在使用 `config.json` 来配置系统设置。
|
||||
|
||||
## 环境列表
|
||||
|
||||
| 环境变量 | 作用 | 参数 |
|
||||
| ------------------------ | ---------------------------------------------------- | -------------------- |
|
||||
| `TZ` | 时区 | `Asia/Shanghai` |
|
||||
| `AB_INTERVAL_TIME` | 间隔时间 | `7200` |
|
||||
| `AB_RENAME_FREQ` | 在一个运行周期内重命名频率 | `20` |
|
||||
| `AB_DOWNLOADER_HOST` | qBittorrent 的地址和端口号 | `localhost:8080` |
|
||||
| `AB_DOWNLOADER_USERNAME` | qBittorrent 的用户名 | `admin` |
|
||||
| `AB_DOWNLOADER_PASSWORD` | qBittorrent 的密码 | `adminadmin` |
|
||||
| `AB_METHOD` | 重命名方法 `normal` 保留字幕组信息， `pn` 为纯净模式 | `pn` |
|
||||
| `AB_GROUP_TAG` | 是否在下载规则中添加组名 | `False` |
|
||||
| `AB_DOWNLOAD_PATH` | qBittorrent 中的下载路径 | `/downloads/Bangumi` |
|
||||
| `AB_RSS` | RSS 订阅地址 | 必填项 |
|
||||
| `AB_ENABLE_TMDB` | 启动 TMDB 解析 | `False` |
|
||||
| `AB_LANGUAGE` | 选择语言 | `zh` |
|
||||
| `AB_NOT_CONTAIN` | 输入想要过滤的元素 | `720` |
|
||||
| `AB_DEBUG_MODE` | 调试模式 | `False` |
|
||||
| `AB_EP_COMPLETE` | 历史番剧下载 | `False` |
|
||||
| `AB_REMOVE_BAD_BT` | 碰到无法重命名的合集等，自动删除种子 | `False` |
|
||||
| `AB_WEBUI_PORT` | Web API | `7892 ` |
|
||||
| `AB_HTTP_PROXY` | HTTP 代理 | `127.0.0.1:6352` |
|
||||
| `AB_SOCKS` | SOCKS5 代理 | `HOST,PORT,USR,PWD` |
|
||||
| `AB_RENAME` | RENAME 开关 | `True` |
|
||||
| `AB_RSS_COLLECTOR` | RSS 解析器开关 | `True` |
|
||||
| `AB_RESET_FOLDER` | 修复错误命名文件夹 | `False` |
|
||||
|
||||
## 进阶参数说明
|
||||
|
||||
### 与 qBittorrent 连接
|
||||
|
||||
- `AB_DOWNLOADER_HOST`: qBittorrent 的地址和端口号，如果开启 HTTPS 请使用 `https://` 开头。
|
||||
|
||||
### 运行相关
|
||||
|
||||
`AB_INTERVAL_TIME`: 解析器的运行间隔时间，单位为秒，默认为 7200 秒，即两个小时检查一次 RSS 更新。
|
||||
|
||||
`AB_RENAME_FREQ`: 在一个运行周期内重命名频率，默认为 20，即 6 分钟运行一次。
|
||||
|
||||
### 文件路径以及重命名相关
|
||||
|
||||
`AB_METHOD`: 重命名方法
|
||||
|
||||
- `normal` 保留字幕组
|
||||
- `pn` 为纯净模式，不保留字幕组，不保留其他信息，只保留名称，会根据 `Season` 文件夹的名称重命名。
|
||||
- `advance` 为高级模式，基于文件夹名称重命名，不保留其他信息。
|
||||
- 源文件路径：`/downloads/Bangumi/约会大作战/Season 4/DATE A LIVE - 1.mp4` >> `/downloads/Bangumi/约会大作战/Season 1/约会大作战 S04E01.mp4`
|
||||
- `none` 为空模式，不重命名。
|
||||
|
||||
`AB_ENABLE_TMDB`: 启动 TMDB 解析, 建议同时启用代理。
|
||||
|
||||
`AB_LANGUAGE`: TMDB 解析后选择语言，仅在 `TMDB` 开启时有效。
|
||||
|
||||
- `zh` 中文
|
||||
- `jp` 日语
|
||||
|
||||
### 下载和过滤相关
|
||||
|
||||
`AB_GROUP_TAG`: 是否在下载规则中添加组名，方便查看。开启后规则命名为 [组名]规则名，关闭后规则命名为 [规则名]
|
||||
|
||||
`AB_NOT_CONTAIN`: 输入想要过滤的元素，如 720，1080，等。
|
||||
|
||||
- 不同的元素用 `|` 分隔，例如 `720|CHT`
|
||||
- 可以使用正则表达式，但是需要注意，特殊符号需要转义，例如 `\(` 表示 `(`。
|
||||
- 这个选项建议填写：`720|\d+-\d+`，如果过滤选项添加过多，会影响到正常的 RSS 识别。对于番剧单独的自定义可以在 qBitorrent 中自定义。
|
||||
|
||||
`AB_EP_COMPLETE`: 历史番剧下载，开启后，将会下载已加入时之前的剧集。
|
||||
|
||||
`AB_REMOVE_BAD_BT`: 碰到无法重命名的合集等，自动删除种子
|
||||
|
||||
`AB_RESET_FOLDER`: 修复错误命名文件夹，如 S01 >> Season 1
|
||||
|
||||
### 网络代理相关
|
||||
|
||||
`AB_WEBUI_PORT`: HTTP API Port
|
||||
|
||||
`AB_HTTP_PROXY`: 开启 HTTP 代理，填入 HTTP 代理服务器地址和端口号
|
||||
|
||||
`AB_SOCKS`:开启 SOCKS5 代理
|
||||
|
||||
- `HOST,PORT,USR,PWD`
|
||||
|
||||
### 调试模式
|
||||
|
||||
`AB_DEBUG_MODE`: 调试模式
|
||||
|
||||
### 功能开关
|
||||
|
||||
`AB_RENAME`: RENAME 开关
|
||||
|
||||
`AB_RSS_COLLECTOR`: RSS 解析器开关
|
||||
|
||||
# 如何正确的使用 AutoBangumi 以及 qBittorrent
|
||||
|
||||
## 如何使用 AB 重命名其他番剧
|
||||
|
||||
- 只需要在 QB 中将种子类型设置为 Bangumi 即可被 AB 识别并重命名。
|
||||
|
||||
## 以下操作不影响程序正常运行
|
||||
|
||||
- 在 QB 中更改自动下载规则，更改自动下载路径
|
||||
- 在 QB 中按照规范更改文件路径
|
||||
Reference in New Issue
Block a user