doc: update

2026-04-21 11:17:30 +08:00 · 2024-10-10 17:30:55 +08:00
parent bf2aeaa2d0
commit 9b0fb42043
5 changed files with 92 additions and 27 deletions
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
 ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/simon-ding/polaris)


-Polaris 是一个电视剧和电影的追踪软件。配置好了之后，当剧集或者电影播出后，会第一时间下载对应的资源。支持本地存储或者webdav。
+Polaris 是一个电视剧和电影的追踪下载软件。对动漫日剧美剧都有良好的匹配，支持webdav或者本地存储。

 ![main_page](./doc/assets/main_page.png)
 ![detail_page](./doc/assets/detail_page.png)
@@ -16,7 +16,7 @@ Polaris 是一个电视剧和电影的追踪软件。配置好了之后，当剧

 ## 快速开始

-使用此程序参考 [【快速开始】](https://simonding.gitbook.io/polaris/quick_start)
+使用此程序参考 [【快速开始】](./doc/quick_start.md)

 ## Features

@@ -40,13 +40,13 @@ Polaris 是一个电视剧和电影的追踪软件。配置好了之后，当剧
 - [ ] 手机客户端


-## 原理
+## 运行原理

-本程序不提供任何视频相关资源，所有的资源都通过 jackett/prowlarr 所对接的BT/PT站点提供。
-    
-1. 此程序通过调用 jackett/prowlarr API搜索相关资源，然后匹配上对应的剧集
-2. 把搜索到的资源送到下载器下载
-3. 下载完成后归入对应的路径
+Polaris本身不提供任何资源，要使其能正常工作，需要同时安装一个下载客户端（transmission）和一个索引客户端（jackett）。
+
+Polaris通过索引客户端查询相关的BT/PT站点，然后把查到的资源送到下载器，等待下载器下载完成对应资源。下载完成后，根据下载的对应资源，整理到对应的文件夹里去
+
+![](./doc/assets/yuanli.png)

 ## 对比 sonarr/radarr
 * 更好的中文支持
--- a/doc/assets/yuanli.png
+++ b/doc/assets/yuanli.png
--- a/doc/configuration.md
+++ b/doc/configuration.md
@@ -3,10 +3,13 @@
 要正确使用此程序，需要配置好以下设置：

 ### 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)

 2. 拿到 TMDB Api Key之后，请填到 *设置 -> 常规设置 -> TMDB Api Key里*

+**注意：** TMDB可能需要翻墙才能使用，参考 [TMDB 访问问题](./tmdb.md)
+
 ### 索引器

 索引器是资源提供者，目前支持 torznab 协议，意味着 polarr 或者 jackett 都可以支持。请自行部署相关程序，或者使用的 docker compose 配置一起拉起
@@ -39,7 +42,7 @@

 ### 下载器

-资源下载器，目前可支持 tansmission，请配置好对应配置
+资源下载器，目前可支持 tansmission/qbittorrent，请配置好对应配置

 ![transmission](./assets/downloader.png)

--- a/doc/quick_start.md
+++ b/doc/quick_start.md
@@ -1,8 +1,71 @@
-## 快速开始
+# 快速开始

-最简单部署 Polaris 的方式是使用 docker compose，Polaris要完整运行另外需要一个索引客户端和一个下载客户端。索引客户端支持 polarr 或 jackett，下载客户端目前只支持 transmission。
+## 安装 Polaris

-下面是一个示例 docker-compose 配置，为了简单起见，一起拉起了 transmission 和 jackett，你也可选择单独安装
+### Docker Compose 方式安装
+
+最简单使用本程序的方式是通过docker compose，下面内容保存成 docker-compose.yml，然后执行 docker compose up -d, 即可拉起程序。
+
+```yaml
+services:
+  polaris:
+    image: ghcr.io/simon-ding/polaris:latest
+    restart: always
+    environment:
+      - PUID=99
+      - PGID=100
+      - TZ=Asia/Shanghai
+    volumes:
+      - <配置文件路径>:/app/data #程序配置文件路径
+      - <下载路径>:/downloads #下载路径，需要和下载客户端配置一致
+      - <媒体文件路径>:/data #媒体数据存储路径，也可以启动自己配置webdav存储
+    ports:
+      - 8080:8080
+```
+
+### Docker 方式安装
+
+也可以通过原始 docker 命令的方式安装 Polaris：
+
+```bash
+docker run -d \
+    -v <配置文件路径>:/app/data \
+    -v <下载路径>:/downloads \
+    -v <媒体文件路径>:/data \
+    -e PUID=99 \
+    -e PGID=100 \
+    -e TZ=Asia/Shanghai \
+    -p 8080:8080 \
+    --restart always \
+    ghcr.io/simon-ding/polaris:latest
+```
+
+拉起之后访问 http://< ip >:8080 即可访问 Polaris 的主页：
+
+![](./assets/main_page.png)
+
+## 安装下载客户端
+
+Polaris 需要下载客户端的配合使用，目前支持 Transmission 和 Qbittorrent。推荐使用linuxserver镜像进行安装
+
+ * [linuxserver/transmission](https://docs.linuxserver.io/images/docker-transmission)
+
+ * [linuxserver/qbittorrent](https://docs.linuxserver.io/images/docker-qbittorrent/)
+
+需要注意的是下载客户端内 /downloads 路径的映射地址要和 Polaris的/downloads路径映射保持一致。也就是说他俩都要映射到同一路径。
+
+## 安装 Jackett
+Polaris 如果要正常工作，还需要一个索引客户端的支持，目前支持jackett索引客户端。
+
+安装方式见：
+
+ * [linuxserver/jackett](https://docs.linuxserver.io/images/docker-jackett/)
+
+
+
+## 联合安装
+
+如果觉得一个个安装麻烦，也可以使用下面docker compose文件，一键拉起所有组件

 **注意：** transmission 的下载路径映射要和 polaris 保持一致，如果您不知道怎么做，请保持默认设置。

@@ -11,6 +74,10 @@ services:
  polaris:
    image: ghcr.io/simon-ding/polaris:latest
    restart: always
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Asia/Shanghai
    volumes:
      - ./config/polaris:/app/data #程序配置文件路径
      - /downloads:/downloads #下载路径，需要和下载客户端配置一致
@@ -43,27 +110,16 @@ services:
    restart: unless-stopped
 ```

-拉起之后访问 http://< ip >:8080 的形式访问
+复制上面文件保存成 docker-compose.yml 文件，然后执行下面命令

+```bash
+docker compose up -d
+```

-![](./assets/main_page.png)

 ## 配置

 详细配置请看 [配置篇](./configuration.md)


-## 开始使用
-
-1. 完成配置之后，我们就可以在右上角的搜索按钮里输入我们想看的电影、电视剧。
-  ![search](./assets/search_series.png)
-
-2. 找到对应电影电视剧后，点击加入想看列表
-  ![add](./assets/add_series.png)
-
-3. 当电影有资源、或者电视剧有更新时，程序就会自动下载对应资源到指定的存储。对于剧集，您也可以进入剧集的详细页面，点击搜索按钮来自己搜索对应集的资源。
-
-
-到此，您已经基本掌握了此程序的使用方式，请尽情体验吧！
-

--- a/doc/tmdb.md
+++ b/doc/tmdb.md
@@ -0,0 +1,6 @@
+# TMDB 访问问题
+
+由于国内特殊的网络环境，访问 tmdb 可能需要翻墙代理，有两种解决方案
+
+1. 设置路由器全局代理，openwrt等第三方路由固件可以实现这个功能
+2. 使用程序代理功能，*常规->代理地址* 中设置，格式如 http://192.168.0.10:1080