docs: 用 4.0 界面重拍文档截图,中英文分开,新增插件与下载器截图
- 25 张截图按 4.0 界面重拍(1280x800):中文站用 zh-CN 界面,en/ja 站用 docs/public/image/en/ 下的英文界面 - 首页预览图按站点语言切换 - 新增下载器页、插件市场、插件配置、插件设置 4 张截图 - 修正文档:插件目录在插件市场页;API 令牌在用户与访问控制中管理(security.login_tokens/mcp_tokens 为启动时导入的旧项);默认搜索源含 anibt
@@ -1,10 +1,14 @@
|
||||
<script setup lang="ts">
|
||||
import { useData } from 'vitepress'
|
||||
|
||||
// WebUI 只有中英文:中文站用中文截图,en/ja 站用英文截图
|
||||
const { lang } = useData()
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="container">
|
||||
<img
|
||||
src="/image/preview/window.png"
|
||||
:src="lang === 'zh-CN' ? '/image/preview/window.png' : '/image/en/preview/window.png'"
|
||||
alt="AutoBangumi WebUI Preview"
|
||||
class="webui-preview"
|
||||
data-zoomable
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
在 **设置 → 插件** 中管理插件:
|
||||
|
||||

|
||||
|
||||
- **允许未签名插件**:本地目录(`config/plugins/local/`)与 pip 安装的插件未经签名,开启后才会加载。插件与 AutoBangumi 在同一进程中运行,拥有完整权限,只启用你信任的插件。
|
||||
- **启用**:每个插件卡片上的开关。
|
||||
- **配置**:展开后按插件声明的配置表单填写,点击 **保存配置**。
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
安全设置用于限制登录入口和 MCP 服务访问。修改后需要点击底部 **保存并重启**。
|
||||
|
||||
- **登录 IP 白名单**:允许访问登录接口的 IPv4/IPv6 CIDR。为空表示允许所有 IP。
|
||||
- **登录 API 令牌**:允许通过 `Authorization: Bearer <token>` 访问受保护 API。
|
||||
- **MCP IP 白名单**:允许访问 MCP 服务的 IPv4/IPv6 CIDR。为空表示拒绝所有基于 IP 的 MCP 访问。
|
||||
- **MCP API 令牌**:允许通过 Bearer Token 访问 MCP 服务。
|
||||
|
||||
API 令牌与 MCP 令牌不在本节。请在 **设置 → 用户与访问控制 → API 令牌** 中创建与撤销,见 [REST API](/api/)。
|
||||
|
||||
## `config.json` 配置选项
|
||||
|
||||
@@ -16,12 +16,12 @@
|
||||
| 参数 | 说明 | 类型 | WebUI 选项 | 默认值 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `login_whitelist` | 登录 IP 白名单 | 字符串数组 | 登录 IP 白名单 | `[]` |
|
||||
| `login_tokens` | 登录 API 令牌 | 字符串数组 | 登录 API 令牌 | `[]` |
|
||||
| `login_tokens` | 旧版登录 API 令牌,见下方说明 | 字符串数组 | 无 | `[]` |
|
||||
| `mcp_whitelist` | MCP IP 白名单 | 字符串数组 | MCP IP 白名单 | `[]` |
|
||||
| `mcp_tokens` | MCP API 令牌 | 字符串数组 | MCP API 令牌 | `[]` |
|
||||
| `mcp_tokens` | 旧版 MCP API 令牌,见下方说明 | 字符串数组 | 无 | `[]` |
|
||||
| `webauthn_rp_id` | Passkey RP ID | 字符串 | 暂无 WebUI 项 | `""` |
|
||||
| `webauthn_origin` | Passkey Origin | 字符串 | 暂无 WebUI 项 | `""` |
|
||||
|
||||
::: warning
|
||||
令牌请使用足够长的随机字符串,并妥善保管。不要把真实令牌提交到公开仓库。
|
||||
::: info
|
||||
`login_tokens` 与 `mcp_tokens` 是 3.x 的旧配置项。AB 启动时把其中的令牌导入为 API 令牌(作用域分别为 `api` 与 `mcp`),然后清空这两项。
|
||||
:::
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
- **Downloader Type**: `qbittorrent` or `aria2`.
|
||||
- **Host**: Web API or RPC address. See [Downloader address](#downloader-address).
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
The LLM parser calls a large language model to parse RSS titles when regex parsing fails or when higher-quality parsing is desired.
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
## Parse Mode
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
- **Enable**: enables file organization and rename behavior.
|
||||
- **Rename Method**:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Network Settings
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
Network settings override external metadata endpoints and credentials. Click **Save & restart** after changing them.
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
Notifications now support multiple providers. Enable the global switch, then add, edit, enable/disable, remove or test individual providers. Click **Save & restart** after changing notification settings.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Passkey Settings
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
Passkey settings manage WebAuthn / Passkey credentials for the current account.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Player settings control the **Player** page in the sidebar.
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
- **Type**:
|
||||
- `jump`: opening the Player page jumps to the external media server.
|
||||
|
||||
@@ -6,6 +6,8 @@ From 4.0, downloaders, rename methods, notification channels, search sites and o
|
||||
|
||||
Manage plugins under **Settings → Plugins**:
|
||||
|
||||

|
||||
|
||||
- **Allow unsigned plugins**: plugins from the local directory (`config/plugins/local/`) or from pip are unsigned. They load only when this switch is on. Plugins run inside the AutoBangumi process with full privileges. Enable only plugins that you trust.
|
||||
- **Enabled**: the switch on each plugin card.
|
||||
- **Options**: expand the card, fill in the form that the plugin declares, then click **Save options**.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
The Config page has a searchable section rail on the left. `program` and `log` are global settings; after changing them, click **Save & restart** at the bottom.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Proxy
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
AutoBangumi supports HTTP, HTTPS and SOCKS5 proxies for RSS, search providers, TMDB, Bangumi, LLM providers and other outbound requests.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Search Providers
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
Search providers power WebUI torrent search and search-based subscription. Built-in providers are `mikan`, `anibt`, `nyaa` and `dmhy`; default providers cannot be deleted, but their URL templates can be edited.
|
||||
|
||||
@@ -16,7 +16,7 @@ https://example.com/search?q=%s
|
||||
|
||||
## PT Site (NexusPHP)
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
The NexusPHP mode generates a `torrentrss.php` RSS search template from a site URL, passkey and optional category IDs.
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
# Security Settings
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
Security settings restrict login and MCP access. Click **Save & restart** after changing them.
|
||||
|
||||
- **Login IP Whitelist**: IPv4/IPv6 CIDR ranges allowed to access login. Empty means all IPs are allowed.
|
||||
- **Login API Tokens**: bearer tokens that can access protected APIs.
|
||||
- **MCP IP Whitelist**: CIDR ranges allowed to access MCP. Empty means deny IP-based MCP access.
|
||||
- **MCP API Tokens**: bearer tokens for MCP.
|
||||
|
||||
API tokens and MCP tokens are not in this section. Create and revoke them in **Settings → Users & Access → API Tokens**. See [REST API](/en/api/).
|
||||
|
||||
## `config.json`
|
||||
|
||||
@@ -16,12 +16,12 @@ Section: `security`
|
||||
| Key | Description | Type | WebUI field | Default |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `login_whitelist` | Login IP whitelist | string array | Login IP Whitelist | `[]` |
|
||||
| `login_tokens` | Login API tokens | string array | Login API Tokens | `[]` |
|
||||
| `login_tokens` | Legacy login API tokens, see the note below | string array | none | `[]` |
|
||||
| `mcp_whitelist` | MCP IP whitelist | string array | MCP IP Whitelist | `[]` |
|
||||
| `mcp_tokens` | MCP API tokens | string array | MCP API Tokens | `[]` |
|
||||
| `mcp_tokens` | Legacy MCP API tokens, see the note below | string array | none | `[]` |
|
||||
| `webauthn_rp_id` | Passkey RP ID | string | config only | `""` |
|
||||
| `webauthn_origin` | Passkey origin | string | config only | `""` |
|
||||
|
||||
::: warning
|
||||
Use long random tokens and never commit real tokens to a public repository.
|
||||
::: info
|
||||
`login_tokens` and `mcp_tokens` are legacy 3.x keys. At startup, AB imports their tokens as API tokens (scope `api` and `mcp`) and then clears both keys.
|
||||
:::
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Software Update
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
The Software Update panel checks, applies and rolls back AutoBangumi updates.
|
||||
|
||||
|
||||
@@ -116,13 +116,13 @@ After installing AB, the WebUI will start automatically, but the main program wi
|
||||
1. Open the webpage. The default username is `admin` and the default password is `adminadmin`. Change these immediately after first login.
|
||||
2. Enter your downloader's address, port, username, and password.
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
3. Click **Apply** to save the configuration. AB will restart, and when the dot in the upper right corner turns green, it indicates AB is running normally.
|
||||
|
||||
4. Click the **+** button in the upper right corner, check **Aggregated RSS**, select the parser type, and enter your Mikan RSS URL.
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
Wait for AB to parse the aggregated RSS. Once parsing is complete, it will automatically add anime and manage downloads.
|
||||
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
|
||||
Click an anime poster on the homepage to manage individual anime entries.
|
||||
|
||||

|
||||

|
||||
|
||||
If an anime has multiple download rules (e.g., different subtitle groups), a rule selection popup will appear:
|
||||
|
||||

|
||||

|
||||
|
||||
After selecting a rule, the edit modal opens:
|
||||
|
||||

|
||||

|
||||
|
||||
## Notification Badges
|
||||
|
||||
@@ -76,7 +76,7 @@ If you delete the anime entry, it will be recreated on the next parse cycle.
|
||||
|
||||
Click **Advanced Settings** in the edit modal to access additional options:
|
||||
|
||||

|
||||

|
||||
|
||||
- **Season Offset**: Adjust the season number offset
|
||||
- **Episode Offset**: Adjust the episode number offset
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Since v3.2, AB includes a calendar view that shows your subscribed anime organized by broadcast day.
|
||||
|
||||

|
||||

|
||||
|
||||
## Features
|
||||
|
||||
|
||||
@@ -36,6 +36,8 @@ AB saves the torrent below the download path of the selected instance.
|
||||
|
||||
AB records the downloader that it added each torrent to. Rename and delete operations use that downloader.
|
||||
|
||||

|
||||
|
||||
- **Downloader page**: with more than one downloader, the list has a "Downloader" column. Pause, resume and delete go to the downloader of each torrent.
|
||||
- **Torrent lists**: the torrent lists of rules and of unmatched torrents show the downloader of each downloaded torrent.
|
||||
|
||||
|
||||
@@ -31,6 +31,8 @@ Changes on plugin cards are not part of the global save at the bottom of the set
|
||||
|
||||
### Configure a Plugin
|
||||
|
||||

|
||||
|
||||
1. Expand **Options** on the plugin card.
|
||||
2. Fill in the form. For list fields, use **Add row** and **Remove**.
|
||||
3. Click **Save options**.
|
||||
@@ -82,7 +84,9 @@ AB reads the signed plugin catalog from the GitHub release `plugins`. Before AB
|
||||
| `POST /api/v1/plugins/{id}/install` | Installs or updates the plugin and enables it |
|
||||
| `DELETE /api/v1/plugins/{id}` | Removes a plugin that you installed from the catalog. Local plugins do not change |
|
||||
|
||||
The "Plugin catalog" section of **Settings → Plugins** lets you browse the catalog and install, update and remove plugins. For signatures and the publish procedure, see [Signing and Distribution](/en/dev/plugins/signing).
|
||||
The **Plugin market** page lets you browse the catalog and install, update and remove plugins. To open it, click "Open plugin market" in **Settings → Plugins**. For signatures and the publish procedure, see [Signing and Distribution](/en/dev/plugins/signing).
|
||||
|
||||

|
||||
|
||||
## Plugin Interface
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ title: RSS Management
|
||||
|
||||
The RSS Manager page displays all your RSS subscriptions with their connection status.
|
||||
|
||||

|
||||

|
||||
|
||||
### Connection Status
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ The search feature relies on the main program's parser. The current version does
|
||||
|
||||
The search bar is located in the AB top bar. Click to open the search panel.
|
||||
|
||||

|
||||

|
||||
|
||||
Select the source site, enter keywords, and AB will automatically parse and display search results. To add an anime, click the add button on the right side of the card.
|
||||
|
||||
@@ -28,13 +28,13 @@ Since v3.2, you can manage search sources directly in the Settings page without
|
||||
|
||||
Navigate to **Config** → **Search Provider** to access the settings panel.
|
||||
|
||||

|
||||

|
||||
|
||||
From here you can:
|
||||
- **View** all configured search sources
|
||||
- **Add** new search sources with the "Add Provider" button
|
||||
- **Edit** existing source URLs
|
||||
- **Delete** custom sources (default sources mikan, nyaa, dmhy cannot be deleted)
|
||||
- **Delete** custom sources (default sources mikan, anibt, nyaa, dmhy cannot be deleted)
|
||||
|
||||
### URL Template Format
|
||||
|
||||
@@ -54,6 +54,7 @@ The following sources are built-in and cannot be deleted:
|
||||
| Source | URL Template |
|
||||
|--------|--------------|
|
||||
| mikan | `https://mikanani.me/RSS/Search?searchstr=%s` |
|
||||
| anibt | `https://anibt.net/rss/magnets.xml?q=%s` |
|
||||
| nyaa | `https://nyaa.si/?page=rss&q=%s&c=0_0&f=0` |
|
||||
| dmhy | `http://dmhy.org/topics/rss/rss.xml?keyword=%s` |
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ title: About
|
||||
<img
|
||||
title="AutoBangumi WebUI"
|
||||
alt="AutoBangumi WebUI"
|
||||
src="/image/preview/window.png"
|
||||
src="/image/en/preview/window.png"
|
||||
width=85%
|
||||
data-zoomable
|
||||
>
|
||||
|
||||
@@ -36,6 +36,8 @@
|
||||
|
||||
AB 记录每个种子被添加到的下载器。之后的重命名、删除都在该下载器上进行。
|
||||
|
||||

|
||||
|
||||
- **下载器页**:有多个下载器时,列表多出「下载器」列。暂停、恢复、删除等批量操作会发到每个种子所在的下载器。
|
||||
- **种子列表**:规则与未匹配种子的列表标出每个已下载种子所在的下载器。
|
||||
|
||||
|
||||
@@ -31,6 +31,8 @@ qBittorrent、aria2 下载器与各通知渠道由 AB 自带,不能停用,
|
||||
|
||||
### 配置插件
|
||||
|
||||

|
||||
|
||||
1. 展开插件卡片上的 **配置**。
|
||||
2. 填写表单。列表类型的字段可以 **添加一行** 或 **删除** 一行。
|
||||
3. 点击 **保存配置**。
|
||||
@@ -82,7 +84,9 @@ AB 从 GitHub release `plugins` 读取签名插件目录。AB 在安装前校验
|
||||
| `POST /api/v1/plugins/{id}/install` | 安装或升级插件,并启用它 |
|
||||
| `DELETE /api/v1/plugins/{id}` | 卸载从目录安装的插件。本地插件不受影响 |
|
||||
|
||||
在 **设置 → 插件** 的「插件目录」区域可以浏览目录,并安装、更新与卸载插件。签名与上架流程见 [签名与分发](/dev/plugins/signing)。
|
||||
在 **插件市场** 页面可以浏览目录,并安装、更新与卸载插件。在 **设置 → 插件** 中点「打开插件市场」进入该页面。签名与上架流程见 [签名与分发](/dev/plugins/signing)。
|
||||
|
||||

|
||||
|
||||
## 插件界面
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
- **查看** 所有已配置的搜索源
|
||||
- **添加** 新搜索源,使用"添加源"按钮
|
||||
- **编辑** 现有源的 URL
|
||||
- **删除** 自定义源(默认源 mikan、nyaa、dmhy 不能删除)
|
||||
- **删除** 自定义源(默认源 mikan、anibt、nyaa、dmhy 不能删除)
|
||||
|
||||
### URL 模板格式
|
||||
|
||||
@@ -54,6 +54,7 @@ https://example.com/rss/search?q=%s
|
||||
| 源 | URL 模板 |
|
||||
|----|----------|
|
||||
| mikan | `https://mikanani.me/RSS/Search?searchstr=%s` |
|
||||
| anibt | `https://anibt.net/rss/magnets.xml?q=%s` |
|
||||
| nyaa | `https://nyaa.si/?page=rss&q=%s&c=0_0&f=0` |
|
||||
| dmhy | `http://dmhy.org/topics/rss/rss.xml?keyword=%s` |
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
- **ダウンローダー種類**:`qbittorrent` または `aria2`。
|
||||
- **ホスト**:Web APIまたはRPCのアドレスです。
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
LLMパーサーは、正規表現解析が失敗した場合やより高品質な解析が必要な場合に、大規模言語モデルでRSSタイトルを解析します。
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
## 解析モード
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
- **有効化**:ファイル整理とリネームを有効化します。
|
||||
- **リネーム方式**:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ネットワーク設定
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
ネットワーク設定では外部メタデータサービスのURLと認証情報を上書きできます。変更後は **保存して再起動** をクリックしてください。
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
通知は複数のproviderに対応しています。全体スイッチを有効にした後、個別providerを追加、編集、有効/無効化、削除、テストできます。変更後は **保存して再起動** をクリックしてください。
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Passkey設定
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
Passkey設定では、現在のアカウントで使うWebAuthn / Passkey資格情報を管理します。
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
プレイヤー設定はサイドバーの **プレイヤー** ページで使われます。
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
- **種類**:
|
||||
- `jump`:プレイヤーページを開くと外部メディアサーバーへ移動します。
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
**設定 → プラグイン** でプラグインを管理します。
|
||||
|
||||

|
||||
|
||||
- **未署名プラグインを許可**:ローカルディレクトリ(`config/plugins/local/`)と pip でインストールしたプラグインは署名されていません。オンにしたときだけ読み込まれます。プラグインは AutoBangumi と同じプロセスで完全な権限を持って動作します。信頼できるプラグインだけを有効にしてください。
|
||||
- **有効**:各プラグインカードのスイッチです。
|
||||
- **設定**:カードを開き、プラグインが宣言したフォームに入力して **設定を保存** をクリックします。
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## WebUI
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
設定ページ左側のレールから検索とセクション移動ができます。`program` と `log` はグローバル設定です。変更後は下部の **保存して再起動** をクリックしてください。
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## プロキシ
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
AutoBangumiはHTTP、HTTPS、SOCKS5プロキシに対応しています。RSS、検索プロバイダー、TMDB、Bangumi、LLM providerなどの外部通信に使われます。
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 検索プロバイダー設定
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
検索プロバイダーはWebUIのTorrent検索と検索ベースの購読に使われます。内蔵providerは `mikan`、`anibt`、`nyaa`、`dmhy` です。既定providerは削除できませんが、URLテンプレートは編集できます。
|
||||
|
||||
@@ -16,7 +16,7 @@ https://example.com/search?q=%s
|
||||
|
||||
## PTサイト(NexusPHP)
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
NexusPHPモードでは、サイトURL、Passkey、任意のカテゴリIDから `torrentrss.php` のRSS検索テンプレートを生成します。
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
# セキュリティ設定
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
セキュリティ設定ではログイン入口とMCPアクセスを制限できます。変更後は **保存して再起動** をクリックしてください。
|
||||
|
||||
- **ログインIPホワイトリスト**:ログインを許可するIPv4/IPv6 CIDR。空の場合はすべて許可します。
|
||||
- **ログインAPIトークン**:`Authorization: Bearer <token>` で保護APIへアクセスするためのトークン。
|
||||
- **MCP IPホワイトリスト**:MCPアクセスを許可するCIDR。空の場合、IPベースのMCPアクセスを拒否します。
|
||||
- **MCP APIトークン**:MCP用Bearer Token。
|
||||
|
||||
APIトークンとMCPトークンはこのセクションにはありません。**設定 → Users & Access → API Tokens** で作成と取り消しを行います。[REST API](/ja/api/) を参照してください。
|
||||
|
||||
## `config.json`
|
||||
|
||||
@@ -16,12 +16,12 @@
|
||||
| キー | 説明 | 型 | WebUI項目 | 既定値 |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `login_whitelist` | ログインIPホワイトリスト | 文字列配列 | ログインIPホワイトリスト | `[]` |
|
||||
| `login_tokens` | ログインAPIトークン | 文字列配列 | ログインAPIトークン | `[]` |
|
||||
| `login_tokens` | 旧版のログインAPIトークン(下の注を参照) | 文字列配列 | なし | `[]` |
|
||||
| `mcp_whitelist` | MCP IPホワイトリスト | 文字列配列 | MCP IPホワイトリスト | `[]` |
|
||||
| `mcp_tokens` | MCP APIトークン | 文字列配列 | MCP APIトークン | `[]` |
|
||||
| `mcp_tokens` | 旧版のMCP APIトークン(下の注を参照) | 文字列配列 | なし | `[]` |
|
||||
| `webauthn_rp_id` | Passkey RP ID | 文字列 | 設定ファイルのみ | `""` |
|
||||
| `webauthn_origin` | Passkey Origin | 文字列 | 設定ファイルのみ | `""` |
|
||||
|
||||
::: warning
|
||||
トークンには十分長いランダム文字列を使い、公開リポジトリへコミットしないでください。
|
||||
::: info
|
||||
`login_tokens` と `mcp_tokens` は 3.x の旧設定項目です。AB は起動時にこれらのトークンを APIトークン(スコープ `api` と `mcp`)として取り込み、両方の項目を空にします。
|
||||
:::
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ソフトウェア更新
|
||||
|
||||
{width=700}{class=ab-shadow-card}
|
||||
{width=700}{class=ab-shadow-card}
|
||||
|
||||
ソフトウェア更新パネルでは、AutoBangumiの更新確認、適用、ロールバックができます。
|
||||
|
||||
|
||||
@@ -116,13 +116,13 @@ ABをインストール後、WebUIは自動的に起動しますが、メイン
|
||||
1. Webページを開きます。デフォルトのユーザー名は`admin`、デフォルトのパスワードは`adminadmin`です。初回ログイン後すぐに変更してください。
|
||||
2. ダウンローダーのアドレス、ポート、ユーザー名、パスワードを入力します。
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
3. **適用**をクリックして設定を保存します。ABが再起動し、右上のドットが緑色になると、ABが正常に動作していることを示します。
|
||||
|
||||
4. 右上の**+**ボタンをクリックし、**集約RSS**にチェックを入れ、パーサータイプを選択し、Mikan RSS URLを入力します。
|
||||
|
||||
{width=500}{class=ab-shadow-card}
|
||||
{width=500}{class=ab-shadow-card}
|
||||
|
||||
ABが集約RSSを解析するのを待ちます。解析が完了すると、自動的にアニメを追加し、ダウンロードを管理します。
|
||||
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
|
||||
ホームページでアニメのポスターをクリックして、個別のアニメエントリを管理します。
|
||||
|
||||

|
||||

|
||||
|
||||
アニメに複数のダウンロードルールがある場合(例:異なる字幕グループ)、ルール選択ポップアップが表示されます:
|
||||
|
||||

|
||||

|
||||
|
||||
ルールを選択すると、編集モーダルが開きます:
|
||||
|
||||

|
||||

|
||||
|
||||
## 通知バッジ
|
||||
|
||||
@@ -76,7 +76,7 @@ ABは継続的に**集約RSS**フィードを解析するため、不要にな
|
||||
|
||||
編集モーダルで**詳細設定**をクリックして、追加のオプションにアクセスします:
|
||||
|
||||

|
||||

|
||||
|
||||
- **シーズンオフセット**:シーズン番号オフセットを調整
|
||||
- **エピソードオフセット**:エピソード番号オフセットを調整
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
v3.2以降、ABには購読しているアニメを放送日ごとに整理して表示するカレンダービューが含まれています。
|
||||
|
||||

|
||||

|
||||
|
||||
## 機能
|
||||
|
||||
|
||||
@@ -36,6 +36,8 @@
|
||||
|
||||
AB は各トレントを追加したダウンローダーを記録します。その後のリネームと削除は、そのダウンローダーで行われます。
|
||||
|
||||

|
||||
|
||||
- **ダウンローダーページ**:ダウンローダーが複数あると「ダウンローダー」列が追加されます。一時停止、再開、削除などの一括操作は、各トレントがあるダウンローダーに送られます。
|
||||
- **トレント一覧**:ルールと未一致トレントの一覧に、ダウンロード済みトレントのダウンローダーが表示されます。
|
||||
|
||||
|
||||
@@ -31,6 +31,8 @@ qBittorrent・aria2 のダウンローダーと各通知チャネルは AB 自
|
||||
|
||||
### プラグインを設定する
|
||||
|
||||

|
||||
|
||||
1. プラグインカードの **設定** を展開します。
|
||||
2. フォームに入力します。リスト形式の項目は **行を追加** と **削除** で編集します。
|
||||
3. **設定を保存** をクリックします。
|
||||
@@ -82,7 +84,9 @@ AB は GitHub release `plugins` から署名済みプラグインカタログを
|
||||
| `POST /api/v1/plugins/{id}/install` | プラグインをインストールまたは更新し、有効にします |
|
||||
| `DELETE /api/v1/plugins/{id}` | カタログからインストールしたプラグインを削除します。ローカルプラグインには影響しません |
|
||||
|
||||
**設定 → プラグイン** の「Plugin catalog」(插件目录)セクションで、カタログを閲覧し、プラグインをインストール・更新・削除できます。署名と公開の手順は [署名と配布](/ja/dev/plugins/signing) を参照してください。
|
||||
**Plugin market**(插件市场)ページで、カタログを閲覧し、プラグインをインストール・更新・削除できます。**設定 → プラグイン** の「Open plugin market」からこのページを開きます。署名と公開の手順は [署名と配布](/ja/dev/plugins/signing) を参照してください。
|
||||
|
||||

|
||||
|
||||
## プラグインの画面
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ title: RSS管理
|
||||
|
||||
RSSマネージャーページには、すべてのRSS購読と接続ステータスが表示されます。
|
||||
|
||||

|
||||

|
||||
|
||||
### 接続ステータス
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ v3.1以降、ABにはアニメを素早く見つけるための検索機能が
|
||||
|
||||
検索バーはABのトップバーにあります。クリックして検索パネルを開きます。
|
||||
|
||||

|
||||

|
||||
|
||||
ソースサイトを選択し、キーワードを入力すると、ABが自動的に解析して検索結果を表示します。アニメを追加するには、カードの右側にある追加ボタンをクリックします。
|
||||
|
||||
@@ -28,13 +28,13 @@ v3.2以降、JSONファイルを編集せずに、設定ページで直接検索
|
||||
|
||||
**設定** → **検索プロバイダー**に移動して、設定パネルにアクセスします。
|
||||
|
||||

|
||||

|
||||
|
||||
ここから以下が可能です:
|
||||
- すべての設定済み検索ソースを**表示**
|
||||
- 「プロバイダーを追加」ボタンで新しい検索ソースを**追加**
|
||||
- 既存のソースURLを**編集**
|
||||
- カスタムソースを**削除**(デフォルトソースmikan、nyaa、dmhyは削除できません)
|
||||
- カスタムソースを**削除**(デフォルトソースmikan、anibt、nyaa、dmhyは削除できません)
|
||||
|
||||
### URLテンプレート形式
|
||||
|
||||
@@ -54,6 +54,7 @@ https://example.com/rss/search?q=%s
|
||||
| ソース | URLテンプレート |
|
||||
|--------|---------------|
|
||||
| mikan | `https://mikanani.me/RSS/Search?searchstr=%s` |
|
||||
| anibt | `https://anibt.net/rss/magnets.xml?q=%s` |
|
||||
| nyaa | `https://nyaa.si/?page=rss&q=%s&c=0_0&f=0` |
|
||||
| dmhy | `http://dmhy.org/topics/rss/rss.xml?keyword=%s` |
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ title: 概要
|
||||
<img
|
||||
title="AutoBangumi WebUI"
|
||||
alt="AutoBangumi WebUI"
|
||||
src="/image/preview/window.png"
|
||||
src="/image/en/preview/window.png"
|
||||
width=85%
|
||||
data-zoomable
|
||||
>
|
||||
|
||||
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 657 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 99 KiB |
BIN
docs/public/image/config/plugins.png
Normal file
|
After Width: | Height: | Size: 110 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 104 KiB |
BIN
docs/public/image/en/config/add-rss.png
Normal file
|
After Width: | Height: | Size: 656 KiB |
BIN
docs/public/image/en/config/downloader-type.png
Normal file
|
After Width: | Height: | Size: 102 KiB |
BIN
docs/public/image/en/config/downloader.png
Normal file
|
After Width: | Height: | Size: 100 KiB |
BIN
docs/public/image/en/config/llm-parser.png
Normal file
|
After Width: | Height: | Size: 100 KiB |
BIN
docs/public/image/en/config/manager.png
Normal file
|
After Width: | Height: | Size: 99 KiB |
BIN
docs/public/image/en/config/network.png
Normal file
|
After Width: | Height: | Size: 106 KiB |
BIN
docs/public/image/en/config/notifier-provider.png
Normal file
|
After Width: | Height: | Size: 93 KiB |
BIN
docs/public/image/en/config/notifier.png
Normal file
|
After Width: | Height: | Size: 88 KiB |
BIN
docs/public/image/en/config/passkey.png
Normal file
|
After Width: | Height: | Size: 95 KiB |
BIN
docs/public/image/en/config/player.png
Normal file
|
After Width: | Height: | Size: 99 KiB |
BIN
docs/public/image/en/config/plugins.png
Normal file
|
After Width: | Height: | Size: 106 KiB |
BIN
docs/public/image/en/config/program.png
Normal file
|
After Width: | Height: | Size: 103 KiB |
BIN
docs/public/image/en/config/proxy.png
Normal file
|
After Width: | Height: | Size: 90 KiB |
BIN
docs/public/image/en/config/search-provider-nexusphp.png
Normal file
|
After Width: | Height: | Size: 127 KiB |
BIN
docs/public/image/en/config/search-provider.png
Normal file
|
After Width: | Height: | Size: 101 KiB |
BIN
docs/public/image/en/config/security.png
Normal file
|
After Width: | Height: | Size: 106 KiB |
BIN
docs/public/image/en/config/update.png
Normal file
|
After Width: | Height: | Size: 106 KiB |
BIN
docs/public/image/en/feature/bangumi-edit-advanced.png
Normal file
|
After Width: | Height: | Size: 585 KiB |
BIN
docs/public/image/en/feature/bangumi-edit.png
Normal file
|
After Width: | Height: | Size: 649 KiB |
BIN
docs/public/image/en/feature/bangumi-list.png
Normal file
|
After Width: | Height: | Size: 1004 KiB |
BIN
docs/public/image/en/feature/calendar.png
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/public/image/en/feature/downloader-page.png
Normal file
|
After Width: | Height: | Size: 124 KiB |
BIN
docs/public/image/en/feature/plugin-config.png
Normal file
|
After Width: | Height: | Size: 109 KiB |
BIN
docs/public/image/en/feature/plugin-market.png
Normal file
|
After Width: | Height: | Size: 194 KiB |
BIN
docs/public/image/en/feature/rss-manager.png
Normal file
|
After Width: | Height: | Size: 52 KiB |
BIN
docs/public/image/en/feature/rule-select.png
Normal file
|
After Width: | Height: | Size: 622 KiB |
BIN
docs/public/image/en/feature/search-panel.png
Normal file
|
After Width: | Height: | Size: 354 KiB |
BIN
docs/public/image/en/feature/search-provider.png
Normal file
|
After Width: | Height: | Size: 99 KiB |
BIN
docs/public/image/en/preview/window.png
Normal file
|
After Width: | Height: | Size: 1.0 MiB |
|
Before Width: | Height: | Size: 640 KiB After Width: | Height: | Size: 589 KiB |
|
Before Width: | Height: | Size: 579 KiB After Width: | Height: | Size: 648 KiB |
|
Before Width: | Height: | Size: 942 KiB After Width: | Height: | Size: 1005 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 1.1 MiB |
BIN
docs/public/image/feature/downloader-page.png
Normal file
|
After Width: | Height: | Size: 124 KiB |
BIN
docs/public/image/feature/plugin-config.png
Normal file
|
After Width: | Height: | Size: 110 KiB |