From 3babb9f5c7640e1a73b787f33cdf40a6dfc1228d Mon Sep 17 00:00:00 2001 From: Simon Ding Date: Sun, 27 Oct 2024 20:11:04 +0800 Subject: [PATCH] doc: update prowlarr setting --- doc/configuration.md | 33 +++++++-------------------------- doc/jackett.md | 21 +++++++++++++++++++++ doc/quick_start.md | 6 ++++-- 3 files changed, 32 insertions(+), 28 deletions(-) create mode 100644 doc/jackett.md diff --git a/doc/configuration.md b/doc/configuration.md index 8b7b040..455273e 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -2,7 +2,7 @@ 要正确使用此程序，需要配置好以下设置： -### TMDB设置 +### 1. TMDB设置 1. 因为此程序需要使用到 TMDB 的数据，使用此程序首先要申请一个 TMDB 的 Api Key. 申请教程请 google [tmdb api key申请](https://www.google.com/search?q=tmdb+api+key%E7%94%B3%E8%AF%B7) @@ -10,35 +10,16 @@ **注意：** TMDB可能需要翻墙才能使用，参考 [TMDB 访问问题](./tmdb.md) -### 索引器 +### 2. 索引器 -索引器是资源提供者，目前支持 torznab 协议，意味着 polarr 或者 jackett 都可以支持。请自行部署相关程序，或者使用的 docker compose 配置一起拉起 +使用配置页面索引器配置或者prowlarr设置，其中一个即可。 -推荐使用 linuxserver 的镜像：https://docs.linuxserver.io/images/docker-jackett/ +#### jackett配置参考 [jackett](./jackett.md) -#### 索引器配置 +#### prowlarr设置 -索引器配置这里以 jackett 为例。使用默认 docker compose 配置拉起后以 http://< ip >:9117 可访问 jackett 的主页。 - -1. 打开 jackett 主页后，点击页面上面的 Add indexer，会出现 BT/PT 站点列表，选择你需要的站点点击+号添加。如果是PT，请自行配置好相关配置 - -![add indexer](./assets/add_indexer.png) - -![search add](./assets/search_add.png) - - -2. 添加后主页即会显示相应的BT/PT站点，点击 *Copy Torznab Feed* 即得到了我们需要的地址 - -![copy feed](./assets/copy_feed.png) - -3. 回到我们的主程序 Polaris 当中，点击 *设置 -> 索引器设置* -> 点击+号增加新的索引器，输入一个名称，拷贝我们第2步得到的地址到地址栏 - -![polaris add indexer](./assets/polaris_add_indexer.png) - -4. 选相框中我们可以看到，还需要一个 API Key，我们回到 Jackett 中，在页面右上角，复制我们需要的 API Key： -![api key](./assets/jackett_api_key.png) - -5. 恭喜！你已经成功完成了索引器配置。如需要更多的站点，请重复相同的操作完成配置 +1) 取得prowlarr的url和api key， api key在 *Prowlarr 设置 -> 通用 -> API 密钥* 处取得 +2) 对应参数填到 polaris程序，*设置->prowlarr设置*当中 ### 下载器 diff --git a/doc/jackett.md b/doc/jackett.md new file mode 100644 index 0000000..ebd3e8b --- /dev/null +++ b/doc/jackett.md @@ -0,0 +1,21 @@ +## jackett 索引器配置 + +1. 打开 jackett 主页后，点击页面上面的 Add indexer，会出现 BT/PT 站点列表，选择你需要的站点点击+号添加。如果是PT，请自行配置好相关配置 + +![add indexer](./assets/add_indexer.png) + +![search add](./assets/search_add.png) + + +2. 添加后主页即会显示相应的BT/PT站点，点击 *Copy Torznab Feed* 即得到了我们需要的地址 + +![copy feed](./assets/copy_feed.png) + +3. 回到我们的主程序 Polaris 当中，点击 *设置 -> 索引器设置* -> 点击+号增加新的索引器，输入一个名称，拷贝我们第2步得到的地址到地址栏 + +![polaris add indexer](./assets/polaris_add_indexer.png) + +4. 选相框中我们可以看到，还需要一个 API Key，我们回到 Jackett 中，在页面右上角，复制我们需要的 API Key： +![api key](./assets/jackett_api_key.png) + +5. 恭喜！你已经成功完成了索引器配置。如需要更多的站点，请重复相同的操作完成配置 diff --git a/doc/quick_start.md b/doc/quick_start.md index c621c6a..5239396 100644 --- a/doc/quick_start.md +++ b/doc/quick_start.md @@ -62,12 +62,14 @@ Polaris 需要下载客户端的配合使用，目前支持 Transmission 和 Qbi 需要注意的是下载客户端内 /downloads 路径的映射地址要和 Polaris的/downloads路径映射保持一致。也就是说他俩都要映射到同一路径。 -## 安装 Jackett -Polaris 如果要正常工作，还需要一个索引客户端的支持，目前支持jackett索引客户端。 +## 安装 Jackett/Prowlarr + +Polaris 如果要正常工作，还需要一个索引客户端的支持，目前支持jackett/prowlarr索引客户端。推荐使用prowlarr，设置更简单 安装方式见： * [linuxserver/jackett](https://docs.linuxserver.io/images/docker-jackett/) + * [linuxserver/prowlarr](https://docs.linuxserver.io/images/docker-prowlarr/)