170 lines
8.8 KiB
Markdown
170 lines
8.8 KiB
Markdown
<p align="center">
|
||
<a href="https://github.com/LuckyPuppy514/jproxy">
|
||
<img alt="JProxy Logo" width="200" src="https://raw.githubusercontent.com/LuckyPuppy514/image/main/2023/2023-04-02/logo.png">
|
||
</a>
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://github.com/LuckyPuppy514/jproxy"><img alt="stars" src="https://badgen.net/github/stars/LuckyPuppy514/jproxy"/></a>
|
||
<a href="https://github.com/LuckyPuppy514/jproxy"><img alt="forks" src="https://badgen.net/github/forks/LuckyPuppy514/jproxy"/></a>
|
||
<a href="https://hub.docker.com/r/luckypuppy514/jproxy"><img alt="docker pulls" src="https://img.shields.io/docker/pulls/luckypuppy514/jproxy.svg"/></a>
|
||
<a href="https://github.com/LuckyPuppy514/jproxy/blob/main/LICENSE.txt"><img alt="MIT License" src="https://badgen.net/github/license/LuckyPuppy514/jproxy"/></a>
|
||
</p>
|
||
|
||
<div align="center">
|
||
<a href="https://github.com/LuckyPuppy514/jproxy/blob/main/README.md">简体中文</a> | English
|
||
</div>
|
||
|
||
- [🌟 Introduce](#-introduce)
|
||
- [🧱 Install](#-install)
|
||
- [Docker](#docker)
|
||
- [Windows](#windows)
|
||
- [☃️ Basic Configuration](#️-basic-configuration)
|
||
- [😘 Contributing](#-contributing)
|
||
- [👏 Related Efforts](#-related-efforts)
|
||
- [🃏 License](#-license)
|
||
|
||
## 🌟 Introduce
|
||
|
||
A proxy between `Sonarr / Radarr` and `Jackett / Prowlarr`, mainly used to optimize search and improve recognition rate
|
||
|
||
```mermaid
|
||
graph LR
|
||
1[Sonarr / Radarr] == request Jackett / Prowlarr Torznab interface ==> 2(JProxy) == proxy Sonarr / Radarr request ==> 3(Jackett / Prowlarr)
|
||
|
||
3(Jackett / Prowlarr) == return raw result ==> 2(JProxy) == return formatted result ==> 1(Sonarr / Radarr)
|
||
|
||
2(JProxy) == optimize search keywords ==> 2(JProxy)
|
||
2(JProxy) == format search result ==> 2(JProxy)
|
||
```
|
||
|
||
|
||
|
||
|
||
|
||
## 🧱 Install
|
||
|
||
### Docker
|
||
|
||
```text
|
||
version: '3.0'
|
||
services:
|
||
jproxy:
|
||
image: luckypuppy514/jproxy:latest
|
||
container_name: jproxy
|
||
restart: unless-stopped
|
||
environment:
|
||
- PUID=1000
|
||
- PGID=1000
|
||
- TZ=Asia/Shanghai
|
||
- JAVA_OPTS=-Xms512m -Xmx512m
|
||
ports:
|
||
- 8117:8117
|
||
volumes:
|
||
- /docker/jproxy/database:/app/database
|
||
```
|
||
|
||
If you want deploy via `docker run` ，see [docker-run.sh](https://github.com/LuckyPuppy514/jproxy/blob/main/docker/docker-run.sh)
|
||
|
||
| Parameter | Default | Description |
|
||
| :--------------------------: | :---------------: | :----------------------------------------------------------------------------------------------------------------------------: |
|
||
| PUID | 0 | User ID |
|
||
| PGID | 0 | Group ID |
|
||
| TZ | Asia/Shanghai | Timezone |
|
||
| JAVA_OPTS | -Xms512m -Xmx512m | JVM parameters |
|
||
| CACHE_EXPIRES | 4320 | Cache expiration time (minutes) |
|
||
| TOKEN_EXPIRES | 10080 | Login expiration time (minutes) |
|
||
| SYNC_INTERVAL | 3 | Synchronization interval (minutes) |
|
||
| RENAME_FILE | true | File rename switch (true/false) |
|
||
| MIN_COUNT | 8 | Append title of primary language (without season and episode number) to search while current result count less than this value |
|
||
| INDEXER_RESULT_CACHE_EXPIRES | 15 | Indexer result cache expiration time (minutes) |
|
||
|
||
If you need to set a proxy, you can append the corresponding proxy parameters in `JAVA_OPTS`
|
||
|
||
- HTTP Proxy
|
||
`-Xms512m -Xmx512m -Dhttp.proxyHost=192.168.6.2 -Dhttp.proxyPort=12345`
|
||
- SOCKS Proxy
|
||
`-Xms512m -Xmx512m -DsocksProxyHost=192.168.6.2 -DsocksProxyPort=54321`
|
||
|
||
### Windows
|
||
|
||
1. [Download jdk17](https://kutt.lckp.top/yrnerc), install and configure environment variables
|
||
2. [Download windows.zip](https://github.com/LuckyPuppy514/jproxy/releases) ，unzip to the installation directory
|
||
|
||
| Filename | Explanation | Remark |
|
||
| :----------------: | :-----------------------: | :-------------------------------------: |
|
||
| startup.bat | starup script | - |
|
||
| shutdown.bat | shutdown script | - |
|
||
| startup-daemon.bat | startup background script | hidden window running in the background |
|
||
| database | database | keep it while upgrade |
|
||
| config | configuration files | - |
|
||
| jproxy.jar | Runnable jar package | - |
|
||
|
||
## ☃️ Basic Configuration
|
||
|
||
- URL: `http://127.0.0.1:8117/login`
|
||
- User: `jproxy`
|
||
- Password: `jproxy@2023`
|
||
|
||
|
||
|
||
① Fill in `Sonarr Server Url`, `API KEY`, and `Indexer Address` in `System - Configure` (Jackett or Prowlarr)
|
||
|
||
|
||
|
||
|
||
💡 After saving, it should normally be as shown in the picture below ✅, otherwise please check the input and network connectivity
|
||
|
||
|
||
|
||
② For the first use, it is recommended to manually synchronize `Series Title` and `Series Rule` once (it will be automatically synchronized later)
|
||
|
||
|
||
|
||
|
||
③ Modify the `IP` and `Port` of the indexer to the `IP` and `Port` of JProxy, and append the path
|
||
|
||
Jackett
|
||
|
||
`http://192.168.6.15:9117/api/v2.0/......` ➡️ `http://192.168.6.14:8117/sonarr/jackett/api/v2.0/......`
|
||
|
||
|
||
|
||
Prowlarr
|
||
|
||
`http://192.168.6.15:9696` ➡️ `http://192.168.6.14:8117/sonarr/prowlarr`
|
||
|
||
|
||
|
||
And change `Authentication Required` to `Disabled for Local Addresses`
|
||
|
||
|
||
|
||
[🎗️ For advanced configuration and usage, see wiki](https://github.com/LuckyPuppy514/jproxy/wiki)
|
||
|
||
## 😘 Contributing
|
||
|
||
Feel free to dive in！[Open an issue](https://github.com/LuckyPuppy514/jproxy/issues/new/choose) or submit PRs.
|
||
|
||
- [arco-design-pro-vue](https://github.com/arco-design/arco-design-pro-vue)
|
||
- [spring-boot](https://github.com/spring-projects/spring-boot)
|
||
- [sqlite](https://github.com/sqlite/sqlite)
|
||
- [liquibase](https://github.com/liquibase/liquibase)
|
||
- [mybatis](https://github.com/mybatis/mybatis-3)
|
||
- [mybatis-plus](https://github.com/baomidou/mybatis-plus)
|
||
- [caffeine](https://github.com/ben-manes/caffeine)
|
||
- [knife4j](https://github.com/xiaoymin/knife4j)
|
||
- [charon](https://github.com/mkopylec/charon-spring-boot-starter)
|
||
- [jib](https://github.com/GoogleContainerTools/jib)
|
||
|
||
## 👏 Related Efforts
|
||
|
||
- [Sonarr](https://github.com/Sonarr/Sonarr)
|
||
- [Radarr](https://github.com/radarr/radarr)
|
||
- [Jackett](https://github.com/Jackett/Jackett)
|
||
- [Prowlarr](https://github.com/Prowlarr/Prowlarr)
|
||
- [qBittorrent](https://github.com/qbittorrent/qBittorrent)
|
||
|
||
## 🃏 License
|
||
|
||
[MIT](https://github.com/LuckyPuppy514/jproxy/blob/main/LICENSE) © LuckyPuppy514
|