Files
polaris/README.md
2025-04-11 16:16:13 +08:00

101 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
![main_page](./doc/assets/main_page.png)
<h1 align="center">Polaris</h1>
<div align="center">
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/simon-ding/polaris/go.yml)
![GitHub Release](https://img.shields.io/github/v/release/simon-ding/polaris)
![GitHub Repo stars](https://img.shields.io/github/stars/simon-ding/polaris)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/simon-ding/polaris)
**Polaris 是一个电视剧和电影的追踪下载软件。对美剧动漫日剧都有良好的匹配支持多种存储方式webdav、alist、本地存储**
</div>
交流群: https://t.me/+8R2nzrlSs2JhMDgx
## 快速开始
若要体验请确保本机有docker环境然后执行
```bash
docker run -p 8080:8080 ghcr.io/simon-ding/polaris:latest
```
随后访问 http://127.0.0.1:8080 即可快速体验Polaris的功能
正式部署请参考 [【快速开始】](./doc/quick_start.md)
## Features
- [x] 电视剧自动追踪下载
- [x] 电影自动追踪下载
- [x] 本地、webdav、 [alist](https://github.com/alist-org/alist) 存储支持,使用 alist 存储支持秒传功能
- [x] 事件通知推送,目前支持 Pushover和 Bark还在扩充中
- [x] TMDB 代理支持
- [x] 用户认证
- [x] plex 刮削支持
- [x] NFO 刮削文件支持
- [x] BT/PT 支持
- [x] qbittorrent/transmission客户端支持
- [x] 支持导入plex watchlistplex里标记自动导入polaris
- [x] and more...
## 支持的平台
- linux/amd64
- linux/arm64
- linux/arm/v7
- linux/386
- linux/s390x
- linux/ppc64le
## FAQ
- [常见问题 FAQ](./doc/faq.md)
## Todos
- [ ] 更多通知客户端支持
- [ ] 更多第三方watchlist导入支持
- [ ] 手机客户端
## 截图
![main_page](./doc/assets/main_page.png)
![detail_page](./doc/assets/detail_page.png)
![anime](./doc/assets/anime_match.png)
## 运行原理
Polaris本身不提供任何资源要使其能正常工作需要同时安装一个下载客户端transmission和一个索引客户端jackett
Polaris通过索引客户端查询相关的BT/PT站点然后把查到的资源送到下载器等待下载器下载完成对应资源。下载完成后根据下载的对应资源整理到对应的文件夹里去
![](./doc/assets/yuanli.png)
<!-- ## 对比 sonarr/radarr
* 更好的中文支持
* 对于动漫、日剧的良好支持,配合国内站点基本能匹配上对应资源
* 支持 webdav 后端存储,可以配合 alist 或者阿里云来实现下载后实时传到云上的功能。这样外出就可以不依靠家里的宽带来看电影了,或者实现个轻 NAS 功能,下载功能放在本地,数据放在云盘
* golang 实现后端,相比于 .NET 更节省资源
* 一个程序同时实现了电影、电视剧功能,不需要装两个程序
* 当然 sonarr/radarr 也是非常优秀的开源项目,目前 Polaris 功能还没有 sonarr/radarr 丰富 -->
## Stargazers over time
[![Stargazers over time](https://starchart.cc/simon-ding/polaris.svg?variant=adaptive)](https://starchart.cc/simon-ding/polaris)
-------------
## 请我喝杯咖啡
<img src="./doc/assets/wechat.JPG" width=40% height=40%>