deflix-stremio

README

Deflix Stremio addon

Deflix addon for Stremio

Looks up your selected movie on YTS, The Pirate Bay, 1337x and ibit and automatically turns your selected torrent into a debrid/cached stream, for high speed and no P2P uploading.

Currently supported providers:

• https://real-debrid.com

More providers will be supported in the future!

Other upcoming features: Support for TV shows, more custom options (e.g. show all single torrents instead of grouped by quality) and more

Contents

1. Install
2. Run locally
   1. Configuration
   2. Warning
3. Tools
   1. rd-tester
   2. rd-proxy
4. Disclaimer

Install

This addon is a remote addon, so it's an HTTP web service and Stremio just sends HTTP requests to it. You dont't need to run any untrusted code on your machine.

1. Get your RealDebrid API token from https://real-debrid.com/apitoken
2. Enter the addon URL in the search box of the addons section of Stremio, like this:
   • https://stremio.deflix.tv/YOUR-API-TOKEN/manifest.json

     (replace YOUR-API-TOKEN by your actual API token!)

That's it!

Optionally you can also add -remote to your token, which will lead to your "remote traffic" being used, which allows you to share your RealDebrid account (and API token) with friends. (⚠️When sharing your account and not using remote traffic, you might get suspended - see RealDebrid's terms and faq!)

Run locally

Alternatively you can also run the addon locally and use that in Stremio. The addon is written in Go and compiles to a single executable file without dependencies, so it's really easy to run on your machine.

You can use one of the precompiled binaries from GitHub:

1. Download the binary for your OS from https://github.com/doingodswork/deflix-stremio/releases
2. Simply run the executable binary
3. To stop the program press Ctrl-C (or ⌃-C on macOS)

Or use Docker:

1. docker pull doingodswork/deflix-stremio
2. docker run --name deflix-stremio -p 8080:8080 doingodswork/deflix-stremio
3. To stop the container: docker stop deflix-stremio

Then similar to installing the publicly hosted addon you enter the URL in the search box of the addon section of Stremio. But as URL you use http://localhost:8080/YOUR-API-TOKEN/manifest.json.

Configuration

The following options can be configured via either command line argument or environment variable:

Usage of deflix-stremio:
  -baseURL1337x string
        Base URL for 1337x (default "https://1337x.to")
  -baseURLibit string
        Base URL for ibit (default "https://ibit.am")
  -baseURLrd string
        Base URL for RealDebrid (default "https://api.real-debrid.com")
  -baseURLtpb string
        Base URL for TPB (default "https://thepiratebay.org")
  -baseURLyts string
        Base URL for YTS (default "https://yts.mx")
  -bindAddr string
        Local interface address to bind to. "localhost" only allows access from the local host. "0.0.0.0" binds to all network interfaces. (default "localhost")
  -cacheAgeRD time.ParseDuration
        Max age of cache entries for instant availability responses from RealDebrid. The format must be acceptable by Go's time.ParseDuration, for example "24h". (default 24h0m0s)
  -cacheAgeTorrents time.ParseDuration
        Max age of cache entries for torrents found per IMDb ID. The format must be acceptable by Go's time.ParseDuration, for example "24h". (default 24h0m0s)
  -cacheMaxMB int
        Max number of megabytes to be used for the in-memory cache. Default (and minimum!) is 160 MB. (default 160)
  -cachePath os.UserCacheDir()+"/deflix-stremio/"
        Path for loading a persisted cache on startup and persisting the current cache in regular intervals. An empty value will lead to os.UserCacheDir()+"/deflix-stremio/".
  -envPrefix string
        Prefix for environment variables
  -extraHeaderRD string
        Additional HTTP request header to set for request to RealDebrid
  -logLevel string
        Log level to show only logs with the given and more severe levels. Can be "trace", "debug", "info", "warn", "error", "fatal", "panic". (default "debug")
  -port int
        Port to listen on (default 8080)
  -rootURL string
        Redirect target for the root (default "https://www.deflix.tv")
  -streamURLaddr string
        Address to be used in a stream URL that's delivered to Stremio and later used to redirect to RealDebrid (default "http://localhost:8080")
  -tpbRetries int
        Number of retries in case TPB times out. Each retry will be done after the previous connection is closed.

If you want to configure deflix-stremio via environment variables, you can use the according environment variable keys, like this: baseURL1337x -> BASE_URL_1337X. If you want to use an environment variable prefix you have to set it with the command line argument (for example -envPrefix DEFLIX and then the environment variable for the previous example would be DEFLIX_BASE_URL_1337X.

Warning

If you run this web service on your local laptop or server, i.e. if you self-host this, you should know the following:

Deflix doesn't download or upload any torrents, but it does send HTTP requests to YTS, The Pirate Bay, 1337x and ibit, which might be illegal in some countries. Streaming movies from RealDebrid might also be illegal in some countries.

To encrypt your traffic so that your ISP can't see where those HTTP requests are sent and to not expose your real IP address to RealDebrid you can use a VPN.

Tools

This repository also contains some useful tools for running deflix-stremio in production:

rd-tester

rd-tester is a command line program that tests if the RealDebrid API can be used from the machine where the program is executed. It uses the magnet URL of "Big Buck Bunny" to do so and requires a RealDebrid API token.

Usage of rd-tester:
  -apiToken string
        RealDebrid API token
  -baseURL string
        Base URL of RealDebrid (default "https://api.real-debrid.com")
  -extraHeader string
        Additional header to set, for example for a proxy. Format: "X-Foo: bar"

rd-proxy

rd-proxy is a reverse proxy for proxying requests to RealDebrid. This can be necessary when RealDebrid blocks the IP of the server where deflix-stremio runs on, because you can then use a bunch of cheap, low-powered servers with fresh IPs for proxying, without having to run deflix-stremio on them.

Usage of rd-proxy:
  -apiKeyHeader string
        Header key for the API key, e.g. "X-Proxy-Apikey"
  -apiKeys string
        List of comma separated API keys that the proxy allows
  -bindAddr string
        Local interface address to bind to. "localhost" only allows access from the local host. "0.0.0.0" binds to all network interfaces. (default "localhost")
  -port int
        Port to listen on (default 8080)
  -targetURL string
        Proxy target URL (default "https://api.real-debrid.com")

Disclaimer

Deflix

• doesn't host any media files or torrents
• doesn't provide link lists to media files or torrents
• isn't a torrent indexer
• doesn't facilitate the sharing of any media files or torrents