# polaris

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

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

交流群： https://t.me/+8R2nzrlSs2JhMDgx

## 功能

- [x] 电视剧自动追踪下载
- [x] 电影自动追踪下载
- [x] webdav 存储支持，配合 [alist](https://github.com/alist-org/alist) 或阿里云等实现更多功能

## 对比 sonarr/radarr
* 更好的中文支持
* 支持 webdav 后端存储，可以配合 alist 或者阿里云来实现下载后实时传到云上的功能。这样外出就可以不依靠家里的宽带来看电影了，或者实现个轻 NAS 功能，下载功能放在本地，数据放在云盘
* golang 实现后端，相比于 .NET 更节省资源
* 一个程序同时实现了电影、电视剧功能，不需要装两个程序
* 当然 sonarr/radarr 也是非常优秀的开源项目，目前 Polaris 功能还没有 sonarr/radarr 丰富

## 快速开始

最简单部署 Polaris 的方式是使用 docker compose

```yaml
services:
  polaris:
    image: ghcr.io/simon-ding/polaris:latest
    restart: always
    volumes:
      - ./config/polaris:/app/data #程序配置文件路径
      - /downloads:/downloads #下载路径，需要和下载客户端配置一致
      - /data:/data #媒体数据存储路径，也可以启动自己配置webdav存储
    ports:
      - 8080:8080
  transmission:    #下载客户端，也可以不安装使用已有的
    image: lscr.io/linuxserver/transmission:latest
    container_name: transmission
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Asia/Shanghai
    volumes:
      - ./config/transmission:/config
      - /downloads:/downloads #此路径要与polaris下载路径保持一致
    ports:
      - 9091:9091
      - 51413:51413
      - 51413:51413/udp
```

拉起之后访问 http://< ip >:8080 的形式访问

## 配置

要正确使用此程序，需要配置好以下设置：

### TMDB设置
因为此程序需要使用到 TMDB 的数据，使用此程序首先要申请一个 TMDB 的 Api Key

### 索引器

索引器是资源提供者，目前支持 torznab 协议，意味着 polarr 或者 jackett 都可以支持。请自行部署相关程序。

推荐使用 linuxserver 的镜像：https://docs.linuxserver.io/images/docker-jackett/

### 下载器

资源由谁下载，目前可支持 tansmission，需要配置好对应下载器

### 存储设置

程序默认所有剧集和电影存储在 /data 路径下，如果想修改路径或者webdav存储，需要在存储配置下修改

## 开始使用

配置完了这些，开始享受使用此程序吧！可以搜索几部自己想看的电影或者电视机，加入想看列表。当剧集有更新或者电影有资源是就会自动下载对应资源了。



-------------

## 请我喝杯咖啡

<img src="assets/wechat.JPG" width=40% height=40%>