quasarr 2.0.0__tar.gz → 2.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of quasarr might be problematic. Click here for more details.
- {quasarr-2.0.0 → quasarr-2.1.1}/PKG-INFO +72 -43
- {quasarr-2.0.0 → quasarr-2.1.1}/README.md +71 -42
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/api/__init__.py +4 -4
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/api/arr/__init__.py +55 -33
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/api/config/__init__.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/api/packages/__init__.py +115 -54
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/api/sponsors_helper/__init__.py +13 -5
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/__init__.py +117 -6
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/linkcrypters/filecrypt.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/auth.py +16 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/html_templates.py +65 -10
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/version.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/al.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/by.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/dd.py +2 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/dj.py +2 -2
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/dl.py +8 -2
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/dt.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/dw.py +6 -7
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/fx.py +4 -4
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/he.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/mb.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/nk.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/nx.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/sf.py +4 -2
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/sj.py +2 -2
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/sl.py +3 -3
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/wd.py +1 -1
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/wx.py +4 -3
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr.egg-info/PKG-INFO +72 -43
- {quasarr-2.0.0 → quasarr-2.1.1}/LICENSE +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/api/captcha/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/api/statistics/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/linkcrypters/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/linkcrypters/al.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/linkcrypters/hide.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/packages/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/al.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/by.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/dd.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/dj.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/dl.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/dt.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/dw.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/he.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/mb.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/nk.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/nx.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/sf.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/sj.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/sl.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/wd.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/downloads/sources/wx.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/cloudflare.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/html_images.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/imdb_metadata.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/jd_cache.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/log.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/myjd_api.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/notifications.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/obfuscated.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/sessions/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/sessions/al.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/sessions/dd.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/sessions/dl.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/sessions/nx.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/shared_state.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/statistics.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/utils.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/providers/web_server.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/search/sources/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/storage/__init__.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/storage/config.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/storage/setup.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr/storage/sqlite_database.py +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr.egg-info/SOURCES.txt +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr.egg-info/dependency_links.txt +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr.egg-info/entry_points.txt +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr.egg-info/not-zip-safe +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr.egg-info/requires.txt +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/quasarr.egg-info/top_level.txt +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/setup.cfg +0 -0
- {quasarr-2.0.0 → quasarr-2.1.1}/setup.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: quasarr
|
|
3
|
-
Version: 2.
|
|
3
|
+
Version: 2.1.1
|
|
4
4
|
Summary: Quasarr connects JDownloader with Radarr, Sonarr and LazyLibrarian. It also decrypts links protected by CAPTCHAs.
|
|
5
5
|
Home-page: https://github.com/rix1337/Quasarr
|
|
6
6
|
Author: rix1337
|
|
@@ -25,7 +25,7 @@ Dynamic: license-file
|
|
|
25
25
|
Dynamic: requires-dist
|
|
26
26
|
Dynamic: summary
|
|
27
27
|
|
|
28
|
-
#
|
|
28
|
+
#
|
|
29
29
|
|
|
30
30
|
<img src="https://raw.githubusercontent.com/rix1337/Quasarr/main/Quasarr.png" data-canonical-src="https://raw.githubusercontent.com/rix1337/Quasarr/main/Quasarr.png" width="64" height="64" />
|
|
31
31
|
|
|
@@ -41,7 +41,8 @@ indexers. It simply does not know what NZB files are.
|
|
|
41
41
|
Quasarr includes a solution to quickly and easily decrypt protected links.
|
|
42
42
|
[Active monthly Sponsors get access to SponsorsHelper to do so automatically.](https://github.com/rix1337/Quasarr?tab=readme-ov-file#sponsorshelper)
|
|
43
43
|
Alternatively, follow the link from the console output (or discord notification) to solve CAPTCHAs manually.
|
|
44
|
-
Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonkey](https://www.tampermonkey.net/) to be
|
|
44
|
+
Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonkey](https://www.tampermonkey.net/) to be
|
|
45
|
+
installed in your browser.
|
|
45
46
|
|
|
46
47
|
# Instructions
|
|
47
48
|
|
|
@@ -56,9 +57,11 @@ Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonk
|
|
|
56
57
|
|
|
57
58
|
## FlareSolverr (Optional)
|
|
58
59
|
|
|
59
|
-
FlareSolverr is **optional** but **required for some sites** (e.g., AL) that use Cloudflare protection. You can skip
|
|
60
|
+
FlareSolverr is **optional** but **required for some sites** (e.g., AL) that use Cloudflare protection. You can skip
|
|
61
|
+
FlareSolverr during setup and configure it later via the web UI.
|
|
60
62
|
|
|
61
63
|
If using FlareSolverr, provide your URL including the version path:
|
|
64
|
+
|
|
62
65
|
```
|
|
63
66
|
http://192.168.1.1:8191/v1
|
|
64
67
|
```
|
|
@@ -69,11 +72,13 @@ http://192.168.1.1:8191/v1
|
|
|
69
72
|
|
|
70
73
|
## Quasarr
|
|
71
74
|
|
|
72
|
-
> ⚠️ Quasarr requires at least one valid hostname to start. It does not provide or endorse any specific sources, but
|
|
75
|
+
> ⚠️ Quasarr requires at least one valid hostname to start. It does not provide or endorse any specific sources, but
|
|
76
|
+
> community-maintained lists are available:
|
|
73
77
|
|
|
74
78
|
🔗 **[https://quasarr-host.name](https://quasarr-host.name)** — community guide for finding hostnames
|
|
75
79
|
|
|
76
|
-
📋 Alternatively, browse community suggestions via [pastebin search](https://pastebin.com/search?q=hostnames+quasarr) (
|
|
80
|
+
📋 Alternatively, browse community suggestions via [pastebin search](https://pastebin.com/search?q=hostnames+quasarr) (
|
|
81
|
+
login required).
|
|
77
82
|
|
|
78
83
|
> Authentication is optional but strongly recommended.
|
|
79
84
|
>
|
|
@@ -84,8 +89,9 @@ http://192.168.1.1:8191/v1
|
|
|
84
89
|
|
|
85
90
|
## JDownloader
|
|
86
91
|
|
|
87
|
-
> ⚠️ If using Docker:
|
|
88
|
-
> JDownloader's download path must be available to Radarr/Sonarr/LazyLibrarian with **identical internal and external
|
|
92
|
+
> ⚠️ If using Docker:
|
|
93
|
+
> JDownloader's download path must be available to Radarr/Sonarr/LazyLibrarian with **identical internal and external
|
|
94
|
+
path mappings**!
|
|
89
95
|
> Matching only the external path is not sufficient.
|
|
90
96
|
|
|
91
97
|
1. Start and connect JDownloader to [My JDownloader](https://my.jdownloader.org)
|
|
@@ -94,7 +100,8 @@ http://192.168.1.1:8191/v1
|
|
|
94
100
|
<details>
|
|
95
101
|
<summary>Fresh install recommended</summary>
|
|
96
102
|
|
|
97
|
-
Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloader's settings to enable
|
|
103
|
+
Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloader's settings to enable
|
|
104
|
+
Radarr/Sonarr/LazyLibrarian integration.
|
|
98
105
|
|
|
99
106
|
</details>
|
|
100
107
|
|
|
@@ -102,7 +109,8 @@ Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloade
|
|
|
102
109
|
|
|
103
110
|
## Radarr / Sonarr
|
|
104
111
|
|
|
105
|
-
> ⚠️ **Sonarr users:** Set all shows (including anime) to the **Standard** series type. Quasarr cannot find releases for
|
|
112
|
+
> ⚠️ **Sonarr users:** Set all shows (including anime) to the **Standard** series type. Quasarr cannot find releases for
|
|
113
|
+
> shows set to Anime/Absolute.
|
|
106
114
|
|
|
107
115
|
|
|
108
116
|
Add Quasarr as both a **Newznab Indexer** and **SABnzbd Download Client** using your Quasarr URL and API Key.
|
|
@@ -118,9 +126,11 @@ Add Quasarr as both a **Newznab Indexer** and **SABnzbd Download Client** using
|
|
|
118
126
|
<summary>Restrict results to a specific mirror</summary>
|
|
119
127
|
|
|
120
128
|
Append the mirror name to your Newznab URL:
|
|
129
|
+
|
|
121
130
|
```
|
|
122
131
|
/api/dropbox/
|
|
123
132
|
```
|
|
133
|
+
|
|
124
134
|
Only releases with `dropbox` in a link will be returned. If the mirror isn't available, the release will fail.
|
|
125
135
|
|
|
126
136
|
</details>
|
|
@@ -136,27 +146,29 @@ Only releases with `dropbox` in a link will be returned. If the mirror isn't ava
|
|
|
136
146
|
|
|
137
147
|
### SABnzbd+ Downloader
|
|
138
148
|
|
|
139
|
-
| Setting
|
|
140
|
-
|
|
149
|
+
| Setting | Value |
|
|
150
|
+
|----------|----------------------------|
|
|
141
151
|
| URL/Port | Your Quasarr host and port |
|
|
142
|
-
| API Key
|
|
143
|
-
| Category | `docs`
|
|
152
|
+
| API Key | Your Quasarr API Key |
|
|
153
|
+
| Category | `docs` |
|
|
144
154
|
|
|
145
155
|
### Newznab Provider
|
|
146
156
|
|
|
147
|
-
| Setting | Value
|
|
148
|
-
|
|
149
|
-
| URL
|
|
150
|
-
| API
|
|
157
|
+
| Setting | Value |
|
|
158
|
+
|---------|----------------------|
|
|
159
|
+
| URL | Your Quasarr URL |
|
|
160
|
+
| API | Your Quasarr API Key |
|
|
151
161
|
|
|
152
162
|
### Fix Import & Processing
|
|
153
163
|
|
|
154
164
|
**Importing:**
|
|
165
|
+
|
|
155
166
|
- Enable `OpenLibrary api for book/author information`
|
|
156
167
|
- Set Primary Information Source to `OpenLibrary`
|
|
157
168
|
- Add to Import languages: `, Unknown` (German users: `, de, ger, de-DE`)
|
|
158
169
|
|
|
159
170
|
**Processing → Folders:**
|
|
171
|
+
|
|
160
172
|
- Add your Quasarr download path (typically `/downloads/Quasarr/`)
|
|
161
173
|
|
|
162
174
|
</details>
|
|
@@ -185,18 +197,18 @@ docker run -d \
|
|
|
185
197
|
ghcr.io/rix1337/quasarr:latest
|
|
186
198
|
```
|
|
187
199
|
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
+
| Parameter | Description |
|
|
201
|
+
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
202
|
+
| `INTERNAL_ADDRESS` | **Required.** Internal URL so Radarr/Sonarr/LazyLibrarian can reach Quasarr. **Must include port.** |
|
|
203
|
+
| `EXTERNAL_ADDRESS` | Optional. External URL (e.g. reverse proxy). Always protect external access with authentication. |
|
|
204
|
+
| `DISCORD` | Optional. Discord webhook URL for notifications. |
|
|
205
|
+
| `HOSTNAMES` | Optional. URL to a hostname list to skip manual setup. Must be a publicly accessible `HTTP`/`HTTPS` link, point to a raw `.ini` or plain text file (not HTML or JSON), and contain at least one hostname per line in the format `ab = xyz`. |
|
|
206
|
+
| `USER` | Username to protect the web UI. |
|
|
207
|
+
| `PASS` | Password to protect the web UI. |
|
|
208
|
+
| `AUTH` | Authentication mode. Supported values: `form` or `basic`. |
|
|
209
|
+
| `SILENT` | Optional. If `True`, silences all Discord notifications except SponsorHelper error messages. |
|
|
210
|
+
| `DEBUG` | Optional. If `True`, enables debug logging. |
|
|
211
|
+
| `TZ` | Optional. Timezone. Incorrect values may cause HTTPS/SSL issues. |
|
|
200
212
|
|
|
201
213
|
# Manual setup
|
|
202
214
|
|
|
@@ -236,7 +248,8 @@ Most feature requests can be satisfied by:
|
|
|
236
248
|
- There are no hostname integrations in active development unless you see an open pull request
|
|
237
249
|
[here](https://github.com/rix1337/Quasarr/pulls).
|
|
238
250
|
- **Pull requests are welcome!** Especially for popular hostnames.
|
|
239
|
-
- A short guide to set up required dev services is found
|
|
251
|
+
- A short guide to set up required dev services is found
|
|
252
|
+
in [/docker/dev-setup.md](https://github.com/rix1337/Quasarr/blob/main/docker/dev-setup.md)
|
|
240
253
|
- Always reach out on Discord before starting work on a new feature to prevent waste of time.
|
|
241
254
|
- Please follow the existing code style and project structure.
|
|
242
255
|
- Anti-bot measures must be circumvented fully by Quasarr. Thus, you will need to provide a working solution for new
|
|
@@ -258,18 +271,30 @@ Image access is limited to [active monthly GitHub sponsors](https://github.com/u
|
|
|
258
271
|
|
|
259
272
|
1. Start your [sponsorship](https://github.com/users/rix1337/sponsorship) first.
|
|
260
273
|
2. Open [GitHub Classic Token Settings](https://github.com/settings/tokens/new?type=classic)
|
|
261
|
-
3. Name it (e.g., `SponsorsHelper`) and choose unlimited expiration
|
|
274
|
+
3. Name it (e.g., `SponsorsHelper`) and choose unlimited expiration
|
|
262
275
|
4. Enable these scopes:
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
276
|
+
- `read:packages`
|
|
277
|
+
- `read:user`
|
|
278
|
+
- `read:org`
|
|
266
279
|
5. Click **Generate token** and copy it for the next steps
|
|
267
280
|
|
|
268
281
|
---
|
|
269
282
|
|
|
283
|
+
## 🔐 Quasarr API Key Setup
|
|
284
|
+
|
|
285
|
+
1. Open your Quasarr web UI in a browser
|
|
286
|
+
2. On the main page, expand **"Show API Settings"**
|
|
287
|
+
3. Copy the **API Key** value
|
|
288
|
+
4. Use this value for the `QUASARR_API_KEY` environment variable
|
|
289
|
+
|
|
290
|
+
> **Note:** The API key is required for SponsorsHelper to communicate securely with Quasarr. Without it, all requests
|
|
291
|
+
> will be rejected with a 401/403 error.
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
270
295
|
## 🐋 Docker Login
|
|
271
296
|
|
|
272
|
-
⚠️ **
|
|
297
|
+
⚠️ **If not logged in, the image will not download.**
|
|
273
298
|
|
|
274
299
|
```bash
|
|
275
300
|
echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
|
|
@@ -286,6 +311,7 @@ echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
|
|
|
286
311
|
docker run -d \
|
|
287
312
|
--name='SponsorsHelper' \
|
|
288
313
|
-e 'QUASARR_URL'='http://192.168.0.1:8080' \
|
|
314
|
+
-e 'QUASARR_API_KEY'='your_quasarr_api_key_here' \
|
|
289
315
|
-e 'DEATHBYCAPTCHA_TOKEN'='2FMum5zuDBxMmbXDIsADnllEFl73bomydIpzo7...' \
|
|
290
316
|
-e 'GITHUB_TOKEN'='ghp_123.....456789' \
|
|
291
317
|
-e 'FLARESOLVERR_URL'='http://10.10.0.1:8191/v1' \
|
|
@@ -297,10 +323,13 @@ docker run -d \
|
|
|
297
323
|
ghcr.io/rix1337-sponsors/docker/helper:latest
|
|
298
324
|
```
|
|
299
325
|
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
326
|
+
| Parameter | Description |
|
|
327
|
+
|---------------------------------|---------------------------------------------------------------------------------------|
|
|
328
|
+
| `QUASARR_URL` | Local URL of Quasarr (e.g., `http://192.168.0.1:8080`) |
|
|
329
|
+
| `QUASARR_API_KEY` | Your Quasarr API key (found in Quasarr web UI under "API Settings") |
|
|
330
|
+
| `DEATHBYCAPTCHA_TOKEN` | [DeathByCaptcha](https://deathbycaptcha.com/register?refid=6184288242b) account token |
|
|
331
|
+
| `GITHUB_TOKEN` | Classic GitHub PAT with the scopes listed above |
|
|
332
|
+
| `FLARESOLVERR_URL` | Local URL of [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) |
|
|
333
|
+
| `NX_USER` / `NX_PASS` | Optional. NX account credentials |
|
|
334
|
+
| `JUNKIES_USER` / `JUNKIES_PASS` | Optional. Junkies account credentials |
|
|
335
|
+
| `JUNKIES_HOSTER` | Optional. Preferred hoster for Junkies links |
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
#
|
|
2
2
|
|
|
3
3
|
<img src="https://raw.githubusercontent.com/rix1337/Quasarr/main/Quasarr.png" data-canonical-src="https://raw.githubusercontent.com/rix1337/Quasarr/main/Quasarr.png" width="64" height="64" />
|
|
4
4
|
|
|
@@ -14,7 +14,8 @@ indexers. It simply does not know what NZB files are.
|
|
|
14
14
|
Quasarr includes a solution to quickly and easily decrypt protected links.
|
|
15
15
|
[Active monthly Sponsors get access to SponsorsHelper to do so automatically.](https://github.com/rix1337/Quasarr?tab=readme-ov-file#sponsorshelper)
|
|
16
16
|
Alternatively, follow the link from the console output (or discord notification) to solve CAPTCHAs manually.
|
|
17
|
-
Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonkey](https://www.tampermonkey.net/) to be
|
|
17
|
+
Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonkey](https://www.tampermonkey.net/) to be
|
|
18
|
+
installed in your browser.
|
|
18
19
|
|
|
19
20
|
# Instructions
|
|
20
21
|
|
|
@@ -29,9 +30,11 @@ Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonk
|
|
|
29
30
|
|
|
30
31
|
## FlareSolverr (Optional)
|
|
31
32
|
|
|
32
|
-
FlareSolverr is **optional** but **required for some sites** (e.g., AL) that use Cloudflare protection. You can skip
|
|
33
|
+
FlareSolverr is **optional** but **required for some sites** (e.g., AL) that use Cloudflare protection. You can skip
|
|
34
|
+
FlareSolverr during setup and configure it later via the web UI.
|
|
33
35
|
|
|
34
36
|
If using FlareSolverr, provide your URL including the version path:
|
|
37
|
+
|
|
35
38
|
```
|
|
36
39
|
http://192.168.1.1:8191/v1
|
|
37
40
|
```
|
|
@@ -42,11 +45,13 @@ http://192.168.1.1:8191/v1
|
|
|
42
45
|
|
|
43
46
|
## Quasarr
|
|
44
47
|
|
|
45
|
-
> ⚠️ Quasarr requires at least one valid hostname to start. It does not provide or endorse any specific sources, but
|
|
48
|
+
> ⚠️ Quasarr requires at least one valid hostname to start. It does not provide or endorse any specific sources, but
|
|
49
|
+
> community-maintained lists are available:
|
|
46
50
|
|
|
47
51
|
🔗 **[https://quasarr-host.name](https://quasarr-host.name)** — community guide for finding hostnames
|
|
48
52
|
|
|
49
|
-
📋 Alternatively, browse community suggestions via [pastebin search](https://pastebin.com/search?q=hostnames+quasarr) (
|
|
53
|
+
📋 Alternatively, browse community suggestions via [pastebin search](https://pastebin.com/search?q=hostnames+quasarr) (
|
|
54
|
+
login required).
|
|
50
55
|
|
|
51
56
|
> Authentication is optional but strongly recommended.
|
|
52
57
|
>
|
|
@@ -57,8 +62,9 @@ http://192.168.1.1:8191/v1
|
|
|
57
62
|
|
|
58
63
|
## JDownloader
|
|
59
64
|
|
|
60
|
-
> ⚠️ If using Docker:
|
|
61
|
-
> JDownloader's download path must be available to Radarr/Sonarr/LazyLibrarian with **identical internal and external
|
|
65
|
+
> ⚠️ If using Docker:
|
|
66
|
+
> JDownloader's download path must be available to Radarr/Sonarr/LazyLibrarian with **identical internal and external
|
|
67
|
+
path mappings**!
|
|
62
68
|
> Matching only the external path is not sufficient.
|
|
63
69
|
|
|
64
70
|
1. Start and connect JDownloader to [My JDownloader](https://my.jdownloader.org)
|
|
@@ -67,7 +73,8 @@ http://192.168.1.1:8191/v1
|
|
|
67
73
|
<details>
|
|
68
74
|
<summary>Fresh install recommended</summary>
|
|
69
75
|
|
|
70
|
-
Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloader's settings to enable
|
|
76
|
+
Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloader's settings to enable
|
|
77
|
+
Radarr/Sonarr/LazyLibrarian integration.
|
|
71
78
|
|
|
72
79
|
</details>
|
|
73
80
|
|
|
@@ -75,7 +82,8 @@ Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloade
|
|
|
75
82
|
|
|
76
83
|
## Radarr / Sonarr
|
|
77
84
|
|
|
78
|
-
> ⚠️ **Sonarr users:** Set all shows (including anime) to the **Standard** series type. Quasarr cannot find releases for
|
|
85
|
+
> ⚠️ **Sonarr users:** Set all shows (including anime) to the **Standard** series type. Quasarr cannot find releases for
|
|
86
|
+
> shows set to Anime/Absolute.
|
|
79
87
|
|
|
80
88
|
|
|
81
89
|
Add Quasarr as both a **Newznab Indexer** and **SABnzbd Download Client** using your Quasarr URL and API Key.
|
|
@@ -91,9 +99,11 @@ Add Quasarr as both a **Newznab Indexer** and **SABnzbd Download Client** using
|
|
|
91
99
|
<summary>Restrict results to a specific mirror</summary>
|
|
92
100
|
|
|
93
101
|
Append the mirror name to your Newznab URL:
|
|
102
|
+
|
|
94
103
|
```
|
|
95
104
|
/api/dropbox/
|
|
96
105
|
```
|
|
106
|
+
|
|
97
107
|
Only releases with `dropbox` in a link will be returned. If the mirror isn't available, the release will fail.
|
|
98
108
|
|
|
99
109
|
</details>
|
|
@@ -109,27 +119,29 @@ Only releases with `dropbox` in a link will be returned. If the mirror isn't ava
|
|
|
109
119
|
|
|
110
120
|
### SABnzbd+ Downloader
|
|
111
121
|
|
|
112
|
-
| Setting
|
|
113
|
-
|
|
122
|
+
| Setting | Value |
|
|
123
|
+
|----------|----------------------------|
|
|
114
124
|
| URL/Port | Your Quasarr host and port |
|
|
115
|
-
| API Key
|
|
116
|
-
| Category | `docs`
|
|
125
|
+
| API Key | Your Quasarr API Key |
|
|
126
|
+
| Category | `docs` |
|
|
117
127
|
|
|
118
128
|
### Newznab Provider
|
|
119
129
|
|
|
120
|
-
| Setting | Value
|
|
121
|
-
|
|
122
|
-
| URL
|
|
123
|
-
| API
|
|
130
|
+
| Setting | Value |
|
|
131
|
+
|---------|----------------------|
|
|
132
|
+
| URL | Your Quasarr URL |
|
|
133
|
+
| API | Your Quasarr API Key |
|
|
124
134
|
|
|
125
135
|
### Fix Import & Processing
|
|
126
136
|
|
|
127
137
|
**Importing:**
|
|
138
|
+
|
|
128
139
|
- Enable `OpenLibrary api for book/author information`
|
|
129
140
|
- Set Primary Information Source to `OpenLibrary`
|
|
130
141
|
- Add to Import languages: `, Unknown` (German users: `, de, ger, de-DE`)
|
|
131
142
|
|
|
132
143
|
**Processing → Folders:**
|
|
144
|
+
|
|
133
145
|
- Add your Quasarr download path (typically `/downloads/Quasarr/`)
|
|
134
146
|
|
|
135
147
|
</details>
|
|
@@ -158,18 +170,18 @@ docker run -d \
|
|
|
158
170
|
ghcr.io/rix1337/quasarr:latest
|
|
159
171
|
```
|
|
160
172
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
+
| Parameter | Description |
|
|
174
|
+
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
175
|
+
| `INTERNAL_ADDRESS` | **Required.** Internal URL so Radarr/Sonarr/LazyLibrarian can reach Quasarr. **Must include port.** |
|
|
176
|
+
| `EXTERNAL_ADDRESS` | Optional. External URL (e.g. reverse proxy). Always protect external access with authentication. |
|
|
177
|
+
| `DISCORD` | Optional. Discord webhook URL for notifications. |
|
|
178
|
+
| `HOSTNAMES` | Optional. URL to a hostname list to skip manual setup. Must be a publicly accessible `HTTP`/`HTTPS` link, point to a raw `.ini` or plain text file (not HTML or JSON), and contain at least one hostname per line in the format `ab = xyz`. |
|
|
179
|
+
| `USER` | Username to protect the web UI. |
|
|
180
|
+
| `PASS` | Password to protect the web UI. |
|
|
181
|
+
| `AUTH` | Authentication mode. Supported values: `form` or `basic`. |
|
|
182
|
+
| `SILENT` | Optional. If `True`, silences all Discord notifications except SponsorHelper error messages. |
|
|
183
|
+
| `DEBUG` | Optional. If `True`, enables debug logging. |
|
|
184
|
+
| `TZ` | Optional. Timezone. Incorrect values may cause HTTPS/SSL issues. |
|
|
173
185
|
|
|
174
186
|
# Manual setup
|
|
175
187
|
|
|
@@ -209,7 +221,8 @@ Most feature requests can be satisfied by:
|
|
|
209
221
|
- There are no hostname integrations in active development unless you see an open pull request
|
|
210
222
|
[here](https://github.com/rix1337/Quasarr/pulls).
|
|
211
223
|
- **Pull requests are welcome!** Especially for popular hostnames.
|
|
212
|
-
- A short guide to set up required dev services is found
|
|
224
|
+
- A short guide to set up required dev services is found
|
|
225
|
+
in [/docker/dev-setup.md](https://github.com/rix1337/Quasarr/blob/main/docker/dev-setup.md)
|
|
213
226
|
- Always reach out on Discord before starting work on a new feature to prevent waste of time.
|
|
214
227
|
- Please follow the existing code style and project structure.
|
|
215
228
|
- Anti-bot measures must be circumvented fully by Quasarr. Thus, you will need to provide a working solution for new
|
|
@@ -231,18 +244,30 @@ Image access is limited to [active monthly GitHub sponsors](https://github.com/u
|
|
|
231
244
|
|
|
232
245
|
1. Start your [sponsorship](https://github.com/users/rix1337/sponsorship) first.
|
|
233
246
|
2. Open [GitHub Classic Token Settings](https://github.com/settings/tokens/new?type=classic)
|
|
234
|
-
3. Name it (e.g., `SponsorsHelper`) and choose unlimited expiration
|
|
247
|
+
3. Name it (e.g., `SponsorsHelper`) and choose unlimited expiration
|
|
235
248
|
4. Enable these scopes:
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
249
|
+
- `read:packages`
|
|
250
|
+
- `read:user`
|
|
251
|
+
- `read:org`
|
|
239
252
|
5. Click **Generate token** and copy it for the next steps
|
|
240
253
|
|
|
241
254
|
---
|
|
242
255
|
|
|
256
|
+
## 🔐 Quasarr API Key Setup
|
|
257
|
+
|
|
258
|
+
1. Open your Quasarr web UI in a browser
|
|
259
|
+
2. On the main page, expand **"Show API Settings"**
|
|
260
|
+
3. Copy the **API Key** value
|
|
261
|
+
4. Use this value for the `QUASARR_API_KEY` environment variable
|
|
262
|
+
|
|
263
|
+
> **Note:** The API key is required for SponsorsHelper to communicate securely with Quasarr. Without it, all requests
|
|
264
|
+
> will be rejected with a 401/403 error.
|
|
265
|
+
|
|
266
|
+
---
|
|
267
|
+
|
|
243
268
|
## 🐋 Docker Login
|
|
244
269
|
|
|
245
|
-
⚠️ **
|
|
270
|
+
⚠️ **If not logged in, the image will not download.**
|
|
246
271
|
|
|
247
272
|
```bash
|
|
248
273
|
echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
|
|
@@ -259,6 +284,7 @@ echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
|
|
|
259
284
|
docker run -d \
|
|
260
285
|
--name='SponsorsHelper' \
|
|
261
286
|
-e 'QUASARR_URL'='http://192.168.0.1:8080' \
|
|
287
|
+
-e 'QUASARR_API_KEY'='your_quasarr_api_key_here' \
|
|
262
288
|
-e 'DEATHBYCAPTCHA_TOKEN'='2FMum5zuDBxMmbXDIsADnllEFl73bomydIpzo7...' \
|
|
263
289
|
-e 'GITHUB_TOKEN'='ghp_123.....456789' \
|
|
264
290
|
-e 'FLARESOLVERR_URL'='http://10.10.0.1:8191/v1' \
|
|
@@ -270,10 +296,13 @@ docker run -d \
|
|
|
270
296
|
ghcr.io/rix1337-sponsors/docker/helper:latest
|
|
271
297
|
```
|
|
272
298
|
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
299
|
+
| Parameter | Description |
|
|
300
|
+
|---------------------------------|---------------------------------------------------------------------------------------|
|
|
301
|
+
| `QUASARR_URL` | Local URL of Quasarr (e.g., `http://192.168.0.1:8080`) |
|
|
302
|
+
| `QUASARR_API_KEY` | Your Quasarr API key (found in Quasarr web UI under "API Settings") |
|
|
303
|
+
| `DEATHBYCAPTCHA_TOKEN` | [DeathByCaptcha](https://deathbycaptcha.com/register?refid=6184288242b) account token |
|
|
304
|
+
| `GITHUB_TOKEN` | Classic GitHub PAT with the scopes listed above |
|
|
305
|
+
| `FLARESOLVERR_URL` | Local URL of [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) |
|
|
306
|
+
| `NX_USER` / `NX_PASS` | Optional. NX account credentials |
|
|
307
|
+
| `JUNKIES_USER` / `JUNKIES_PASS` | Optional. Junkies account credentials |
|
|
308
|
+
| `JUNKIES_HOSTER` | Optional. Preferred hoster for Junkies links |
|
|
@@ -25,7 +25,7 @@ def get_api(shared_state_dict, shared_state_lock):
|
|
|
25
25
|
|
|
26
26
|
# Auth: routes must come first, then hook
|
|
27
27
|
add_auth_routes(app)
|
|
28
|
-
add_auth_hook(app, whitelist_prefixes=['/api', '/api/' '/sponsors_helper/', '/download/'])
|
|
28
|
+
add_auth_hook(app, whitelist_prefixes=['/api', '/api/', '/sponsors_helper/', '/download/'])
|
|
29
29
|
|
|
30
30
|
setup_arr_routes(app)
|
|
31
31
|
setup_captcha_routes(app)
|
|
@@ -66,7 +66,7 @@ def get_api(shared_state_dict, shared_state_lock):
|
|
|
66
66
|
# JDownloader status
|
|
67
67
|
jd_status = f"""
|
|
68
68
|
<div class="status-bar">
|
|
69
|
-
<span class="status-
|
|
69
|
+
<span class="status-pill {'success' if jd_connected else 'error'}">
|
|
70
70
|
{'✅' if jd_connected else '❌'} JDownloader {'Connected' if jd_connected else 'Disconnected'}
|
|
71
71
|
</span>
|
|
72
72
|
</div>
|
|
@@ -389,8 +389,8 @@ def get_api(shared_state_dict, shared_state_lock):
|
|
|
389
389
|
</script>
|
|
390
390
|
"""
|
|
391
391
|
# Add logout link for form auth
|
|
392
|
-
logout_html = '<
|
|
393
|
-
return render_centered_html(info
|
|
392
|
+
logout_html = '<a href="/logout">Logout</a>' if show_logout_link() else ''
|
|
393
|
+
return render_centered_html(info, footer_content=logout_html)
|
|
394
394
|
|
|
395
395
|
@app.get('/regenerate-api-key')
|
|
396
396
|
def regenerate_api_key():
|