Skip to content

Latest commit

 

History

History
174 lines (146 loc) · 9.5 KB

README.md

File metadata and controls

174 lines (146 loc) · 9.5 KB
Raw

Deflix Stremio addon

Deflix addon for Stremio

Finds movies and TV shows from many different sources and automatically turns them into cached HTTP streams with a debrid service like RealDebrid, AllDebrid or Premiumize, for high speed 4k streaming and no P2P uploading.

Contents

  1. Features
  2. Install
  3. Run locally
    1. Configuration
    2. Warning
  4. Disclaimer

Features

  • Supports several debrid services
  • Finds movies and TV shows from many different sources
    • YTS
    • The Pirate Bay
    • 1337x
    • RARBG
    • ibit
    • Others like RapidMoviez and Scene-RLS are planned
  • Groups streams by quality so you don't have to choose between dozens of results
    • 720p
    • 1080p
    • 1080p 10bit
    • 2160p
    • 2160p 10bit
  • Configurable via the ⚙ button in Stremio

Other upcoming features: Support for more sources, grouping by bitrate, more custom options (language filter, show all single torrents instead of grouped by quality) and more

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.

Here's the official Deflix website, that guides you through the installation: https://www.deflix.tv/stremio

Note: This repository contains all the latest features and fixes. Some of them might not be publicly deployed yet. If you want to use the version of this repository, run the addon locally.

Run locally

Alternatively to using the publicly deployed version 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 (deflix-stremio.exe for Windows, deflix-stremio for macOS and Linux)
  3. Visit http://localhost:8080/configure in the browser to configure and install the addon in Stremio
  4. To stop the program press Ctrl-C (or ⌃-C on macOS) in the terminal windows where deflix-stremio is running

Or use Docker:

  1. Update the image: docker pull doingodswork/deflix-stremio
  2. Start the container: docker run --name deflix-stremio -p 8080:8080 doingodswork/deflix-stremio

    • Note: Ctrl-C only detaches from the container. It doesn't stop it.

    • When detached, you can attach again with docker attach deflix-stremio
  3. Visit http://localhost:8080/configure in the browser to configure and install the addon in Stremio
  4. To stop the container: docker stop deflix-stremio
  5. To start the (still existing) container again: docker start deflix-stremio

Configuration

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

Usage of deflix-stremio:
  -baseURL string
        Base URL of this service. It's used in a stream URL that's delivered to Stremio and later used to redirect to RealDebrid, AllDebrid and Premiumize. If you enable OAuth2 handling this will also be used for the redirects and to determine whether the state cookie is a secure one or not. (default "http://localhost:8080")
  -baseURL1337x string
        Base URL for 1337x (default "https://1337x.to")
  -baseURLad string
        Base URL for AllDebrid (default "https://api.alldebrid.com")
  -baseURLibit string
        Base URL for ibit (default "https://ibit.am")
  -baseURLpm string
        Base URL for Premiumize (default "https://www.premiumize.me/api")
  -baseURLrarbg string
        Base URL for RARBG (default "https://torrentapi.org")
  -baseURLrd string
        Base URL for RealDebrid (default "https://api.real-debrid.com")
  -baseURLtpb string
        Base URL for the TPB API (default "https://apibay.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")
  -cacheAgeXD duration
        Max age of cache entries for instant availability responses from RealDebrid, AllDebrid and Premiumize. The format must be acceptable by Go's 'time.ParseDuration()', for example "24h". (default 24h0m0s)
  -cachePath string
        Path for loading persisted caches on startup and persisting the current cache in regular intervals. An empty value will lead to 'os.UserCacheDir()+"/deflix-stremio/cache"'.
  -envPrefix string
        Prefix for environment variables
  -extraHeadersXD string
        Additional HTTP request headers to set for requests to RealDebrid, AllDebrid and Premiumize, in a format like "X-Foo: bar", separated by newline characters ("\n")
  -forwardOriginIP
        Forward the user's original IP address to RealDebrid and Premiumize. The first "X-Forwarded-For" entry will be used.
  -imdb2metaAddr string
        Address of the imdb2meta gRPC server. Won't be used if empty.
  -logEncoding string
        Log encoding. Can be "console" or "json", where "json" makes more sense when using centralized logging solutions like ELK, Graylog or Loki. (default "console")
  -logFoundTorrents
        Set to true to log each single torrent that was found by one of the torrent site clients (with DEBUG level)
  -logLevel string
        Log level to show only logs with the given and more severe levels. Can be "debug", "info", "warn", "error". (default "debug")
  -maxAgeTorrents duration
        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 is 7 days. (default 168h0m0s)
  -oauth2authURLpm string
        URL of the OAuth2 authorization endpoint of Premiumize (default "https://www.premiumize.me/authorize")
  -oauth2authURLrd string
        URL of the OAuth2 authorization endpoint of RealDebrid (default "https://api.real-debrid.com/oauth/v2/auth")
  -oauth2clientIDpm string
        Client ID for deflix-stremio on Premiumize
  -oauth2clientIDrd string
        Client ID for deflix-stremio on RealDebrid
  -oauth2clientSecretPM string
        Client secret for deflix-stremio on Premiumize
  -oauth2clientSecretRD string
        Client secret for deflix-stremio on RealDebrid
  -oauth2encryptionKey string
        OAuth2 data encryption key
  -oauth2tokenURLpm string
        URL of the OAuth2 token endpoint of Premiumize (default "https://www.premiumize.me/token")
  -oauth2tokenURLrd string
        URL of the OAuth2 token endpoint of RealDebrid (default "https://api.real-debrid.com/oauth/v2/token")
  -port int
        Port to listen on (default 8080)
  -redisAddr string
        Redis host and port, for example "localhost:6379". It's used for the redirect and stream cache. Keep empty to use in-memory go-cache.
  -redisCreds string
        Credentials for Redis. Password for Redis version 5 and older, username and password for Redis version 6 and newer. Use the colon character (":") for separating username and password. This implies you can't use a colon in the password when using Redis version 5 or older.
  -rootURL string
        Redirect target for the root (default "https://www.deflix.tv")
  -socksProxyAddrTPB string
        SOCKS5 proxy address for accessing TPB, required for accessing TPB via the TOR network (where "127.0.0.1:9050" would be typical value)
  -storagePath string
        Path for storing the data of the persistent DB which stores torrent results. An empty value will lead to 'os.UserCacheDir()+"/deflix-stremio/badger"'.
  -useOAUTH2
        Flag for indicating whether to use OAuth2 for Premiumize authorization. This leads to a different configuration webpage that doesn't require API keys. It requires a client ID to be configured.
  -webConfigurePath string
        Path to the directory with web files for the '/configure' endpoint. If empty, files compiled into the binary will be used

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, RARBG and ibit, which might be illegal in some countries. Streaming movies and TV shows from RealDebrid, AllDebrid or Premiumize 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, AllDebrid or Premiumize you can use a VPN.

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