UwUDev/ygege
GitHub: UwUDev/ygege
基于 Nostr 协议的 ygg.gratis 高性能种子索引器,支持与 Prowlarr/Jackett 及 *arr 应用集成。
Stars: 541 | Forks: 46
基于 Nostr 协议的 [ygg.gratis](https://ygg.gratis) 高性能索引器,使用 Rust 编写
## https://discord.gg/rcsgdzNrvJ
## [法律免责声明](DISCLAIMER-fr.md)
**主要特性**:
- 连接到 ygg.gratis 的 Nostr 中继 (`wss://relay.ygg.gratis`)
- 无需账号或身份标识 —— ygg.gratis 是公开的
- 启动时根据延迟自动对中继进行排序
- 近乎即时的搜索
- 内存占用低
- 高度模块化的 Torrent 搜索(按名称、种子、下载、发布日期等)
- 可选的 Tor 支持,用于匿名化与中继的连接
- 集成 TMDB/IMDB,支持通过 ID 进行解析
- 兼容 Prowlarr、Jackett 以及所有 \*arr 应用
## 编译前提条件
- Rust 1.85.0+
# 安装
Ygégé 提供了现成的 Docker 镜像。
要开始 Docker 的部署和配置,请参阅 [Docker 专属指南](https://ygege.lila.ws/installation/docker-guide)。
## Docker
要使用您自己的优化配置构建自定义 Docker 镜像,请参阅 [Docker 构建指南](https://ygege.lila.ws/installation/docker-guide)。
## 手动安装
要从源代码编译应用程序,请遵循 [手动安装指南](https://ygege.lila.ws/installation/source-guide)。
## IMDB 和 TMDB 配置
要启用 IMDB 和 TMDB 的元数据获取,请遵循 [TMDB 和 IMDB 支持指南](https://ygege.lila.ws/tmdb-imdb) 中的说明。
## Tor 支持
Ygégé 可以通过 Tor 路由其与 Nostr 中继的连接,以匿名化流量。
| 环境变量 | 默认值 | 描述 |
|--------------------------|--------|-------------|
| `USE_TOR` | `false` | 启用 Tor 路由 (`true`/`false`) |
| `TOR_PROXY` | `127.0.0.1:9050` | Tor SOCKS5 代理地址 |
Docker Compose 示例:
```
environment:
USE_TOR: "true"
TOR_PROXY: "127.0.0.1:9050" # Optionnel si valeur par défaut
```
## 集成到 Prowlarr
Ygégé 可以作为 Prowlarr 的自定义索引器使用。要设置它,请找到您的 AppData 目录(位于 Prowlarr 的 `/system/status` 页面中),并将仓库中的 `ygege.yml` 文件复制到 `{您的 prowlarr appdata 路径}/Definitions/Custom` 文件夹中,您可能需要创建 `Custom` 文件夹。
完成后,重启 Prowlarr 并进入索引器设置,您应该能在可用索引器列表中看到 Ygégé。
## 集成到 Jackett
Ygégé 可以作为 Jackett 的自定义索引器使用。要设置它,请找到您的 Jackett AppData 目录,并将仓库中的 `ygege.yml` 文件复制到 `{您的 jackett appdata 路径}/cardigann/definitions/` 文件夹中。如果 `cardigann/definitions/` 子文件夹不存在,您可能需要创建它。
完成后,重启 Jackett 并进入索引器设置。您应该能在可用索引器列表中看到 Ygégé。
# 文档
## 用户文档
完整文档可在 [ygege.lila.ws](https://ygege.lila.ws) 获取:
- [入门指南](https://ygege.lila.ws/getting-started)
- [安装](https://ygege.lila.ws/installation/docker-guide)
- [配置](https://ygege.lila.ws/configuration)
- [集成 (Prowlarr/Jackett)](https://ygege.lila.ws/integrations/prowlarr)
- [API 文档](https://ygege.lila.ws/api)
- [常见问题](https://ygege.lila.ws/faq)
## 开发者文档
要为项目做出贡献或了解内部工作机制:
- [贡献指南](docs/contribution-fr.md)
- [CI/CD 流水线](docs/ci_implementation-fr.md)
- [PR 预览工作流](docs/preview_workflow-fr.md)
- [发布工作流](docs/release_workflow-fr.md)
标签:BitTorrent, Docker, IMDB, Jackett, Nostr 协议, Prowlarr, Radarr, Rust, Sonarr, TMDB, Tor 匿名网络, 元数据, 去中心化, 可视化界面, 安全防御评估, 文件共享, 流媒体聚合, 种子搜索, 索引器, 网络安全, 网络流量审计, 请求拦截, 资源爬虫, 通知系统, 隐私保护