Skip to main content

How To: Add A Custom Search Engine To TorBox

TorBox allows you to bring your own indexers for use inside of Stremio and the API. Also known as BYOI.

TorBox allows you to add your very own custom indexers using the big 3 search engines, directly inside of our TorBox Voyager Search API. This allows for the ultimate customization giving you the following:

  • Allowing you to use any indexer or tracker available, even private ones.

  • Resiliency against any down times of internal searches that TorBox may have.

  • More results, allowing you to easily download from your own sources.

Prerequisites

  • A publicly hosted instance of Prowlarr, Jackett, or NZBHydra2. You can host one on a VPS for close to $5/mo, or buy one from our friends at ElfHosted.

  • Access to indexers or trackers. There are some free ones, but the best and fastest ones are private, requiring invites or paid admission.

  • Be on a paid TorBox plan. To do Usenet searching, you also must be on the Pro TorBox plan.

Current Compatibility

  • Prowlarr - Supports Torrents and Usenet

  • Jackett - Supports Torrents

  • NZBHydra2 - Supports Usenet

We may add more options such as Torznab or Newznab in the future! (But most of these applications allow you to add those anyways)

Text Guide:

  1. First go to the settings page, under the "Search" section. You will see the below screen (assuming you are on a paid plan). If you aren't already on a paid plan, you can get on here.

  2. To add your first search engine, click the "Add New Search Engine" button. This will open the below modal, where you can then fill in the publicly available "Search Engine URL" and the respective "Search Engine API Key". Note: Make sure the API key is 100% correct, including capitalization as most of the search engines are particular about it.

  3. After that, select the search engine type. This can be either "Jackett", "Prowlarr" or "NZBHydra2". Since all are handled very differently internally, you must choose the correct one which corresponds with the URL and API key you provided in the above boxes.

  4. Next choose the "Search Engine Download Type". This is either "Torrents" or "NZBs" (for Usenet). This is important to choose the correct ones corresponding the the type of search engine you have chosen. For example, "NZBHydra2" currently only has Usenet searching, while "Jackett" only has torrent searching. "Prowlarr" works with both torrents and nzbs.

  5. Assuming all information is correct, click the "Add Search Engine" button. This will be sent to the API for verification. It will make sure all of the information is correct, and will check what indexers or trackers are available to search from given the "Search Engine Download Type". It will also check the URL to make sure that TorBox will be able to access it with the given API key. If it is all successful, you will get the below alert meaning it was a success. If not everything is correct, it will tell you exactly what is wrong with your search engine, so you may rectify it.

  6. Now you should see the below screen with your search engine and all of the available trackers or indexers available from this search engine. (You may need to refresh the page if it doesn't show up right off the bat).

  7. You are now fully set up! You can now enable the "Use Active Search Engines In Stremio Addon" setting if you want to use your search engines inside of the TorBox Stremio Addon.

  8. There are also controls available to you.

    1. "Modify" allows you to modify settings about the search engine such as URL, API key, and type. This allows you to make any changes necessary such as if you reset the API key or something similar.

    2. "Check Config" allows you to have TorBox check your config, including the URL accessibility, the API key, and get any new trackers or indexers that may be available. Note that even if you enable or disable trackers or indexers inside of the application, the API will still use them, even if they don't show on the UI.

    3. "Disable" and "Enable" does exactly that, disables or enables the search engine from being used. If disabled, TorBox will not use the search engine for any applicable searches. Enable will re-enable the search engine to be used in said applicable searches.

    4. "Delete" will delete the search engine completely. Make sure you don't accidentally click this!

If you don't have a way to host your Prowlarr, Jackett or NZBHydra2 instances you can click on the glowing buttons to easily purchase and get automatically set up with a private instance. Offered by our friends at ElfHosted!

Did this answer your question?