Skip to main content

Full template for python web projects with Docker, GitHub Actions, PyPI, and more.

Project description

Quasarr connects JDownloader with Radarr and Sonarr. It also decrypts links protected by CAPTCHAs.

PyPI version Discord GitHub Sponsorship

Quasarr poses as a Newznab Indexer and a SABnzbd client. It will thus never work in parallel with a real NZB indexer and download client set up. Torrents are unaffected. To still use NZB indexers, you must set fixed download clients in the advanced indexer settings for Radarr/Sonarr.

Quasarr includes a solution to quickly and easily decrypt protected links. Active Sponsors get access to SponsorsHelper to do so automatically. Alternatively follow the link from the console output (or discord notification) to solve the CAPTCHA manually. Quasarr will confidently handle the rest.

Instructions

  • Set up at least one hostname for Quasarr to use
    • Chose your own or use the HOSTNAMES variable to provide a list of hostnames.
    • Always redact hostnames when creating issues in this repo.
    • Quasarr will become available once at least one suitable hostname is set.
  • Provide your My-JDownloader-Credentials
  • Set up Quasarr's URL as 'Newznab Indexer' and 'SABnzbd Download Client' in Sonarr/Radarr.
    • Leave settings at default
    • Use the API key from console output (or copy it from the Quasarr web UI)
    • Activity >> Queue >> Options
      • Enable Release Title
  • Note: Some JDownloader settings will be enforced by Quasarr on startup.

Docker

It is highly recommended to run the latest docker image with all optional variables set.

docker run -d \
  --name="Quasarr" \
  -p port:8080 \
  -v /path/to/config/:/config:rw \
  -e 'INTERNAL_ADDRESS'='http://192.168.0.1:8080' \
  -e 'EXTERNAL_ADDRESS'='https://foo.bar/' \
  -e 'DISCORD'='https://discord.com/api/webhooks/1234567890/ABCDEFGHIJKLMN' \
  -e 'HOSTNAMES'='https://pastebin.com/raw/eX4Mpl3'
  rix1337/docker-quasarr:latest
  • INTERNAL_ADDRESS is required so Radarr/Sonarr can reach Quasarr. Must include port!
  • EXTERNAL_ADDRESS is optional and used in Discord notifications.
  • DISCORD is optional and must be a valid Discord Webhook URL.
  • HOSTNAMES is optional and allows skipping the manual hostname step during setup.
    • Must be a publicly available HTTP or HTTPs link
    • Must be a raw .ini / text file (not html or json)
    • Must contain at least one valid Hostname per line ab = xyz

Manual setup

Use this only in case you cant run the docker image.

pip install

  • Requires Python 3.12 or later

  --port=8080
  --discord=https://discord.com/api/webhooks/1234567890/ABCDEFGHIJKLMN
  --external_address=https://foo.bar/
  --hostnames=https://pastebin.com/raw/eX4Mpl3
  • --discord see DISCORDdocker variable
  • --external_address see EXTERNAL_ADDRESSdocker variable
  • --hostnames see HOSTNAMESdocker variable

Roadmap

  • Assume there are zero known issues unless you find one or more open issues in this repository.
    • Stability improvements and bugfixes require your help.
    • Report problems by opening a new issue in this repository.
    • Issues must be reproducible and include logs / screenshots.
  • The feature set is considered complete. Don't expect feature upgrades.
    • Most feature requests can be satisfied by:
      • Existing settings in Radarr/Sonarr
      • Existing settings in JDownloader
        • You can set up link filters for undesired mirrors there.
        • The same applies to filtering out offline links.
      • Existing tools from the *arr ecosystem that integrate directly with Radarr/Sonarr
    • There are no hostname integrations in active development.
  • Pull requests are welcome. Especially for new and popular hostnames.
    • Always reach out on Discord before starting work on a new feature.
    • Please follow the existing code style and project structure.
    • Please provide proof of functionality (screenshots/examples) when submitting your pull request.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quasarr-0.9.9.tar.gz (104.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quasarr-0.9.9-py3-none-any.whl (116.9 kB view details)

Uploaded Python 3

File details

Details for the file quasarr-0.9.9.tar.gz.

File metadata

  • Download URL: quasarr-0.9.9.tar.gz
  • Upload date:
  • Size: 104.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for quasarr-0.9.9.tar.gz
Algorithm Hash digest
SHA256 dfdcdeef49eeac9930d186df0d4042f02e27ed8521b2612a80425bfc940c8398
MD5 581ff9f26adba8b4c7272996f9e9d856
BLAKE2b-256 5fc71ce8634f2838d43c5fa1c7e6885a467561d7668083f933060c490c8dc025

See more details on using hashes here.

File details

Details for the file quasarr-0.9.9-py3-none-any.whl.

File metadata

  • Download URL: quasarr-0.9.9-py3-none-any.whl
  • Upload date:
  • Size: 116.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for quasarr-0.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8cd1368b1542a639d3e221d5702c51158c53672a4ad99ba5ce3aff998c4aabb4
MD5 0b695e8d3ded8abcc121b47c8aae76ad
BLAKE2b-256 04783f144a7c6c492105e0fd44a8829f73240da622a7d2ba141295e87eeb309c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page