webstreamr-github/README.md
2025-10-17 14:27:19 +00:00

2.7 KiB

WebStreamr

Tests GitHub release GitHub License

Stremio add-on which provides HTTP URLs from streaming websites.

Public instance

A public instance is available at https://webstreamr.hayd.uk. Hosting infrastructure for this instance is donated by ElfHosted, and independently maintained by Hayduk.

Hosting

Don't want to use the public instance, or concerned about reliability during periods of high use? It's open-source, you can host it yourself!

ElfHosted (easy mode)

Self-hosting to stressful? ElfHosted offer ready-to-go, turn-key WebStreamr instances with $1, 7-day trials. Additionally, 33% of your subscription directly supports your developer! ❤️

(ElfHosted also offer advanced private hosting of the top Stremio Addons, as well as turn-key bundles providing streaming from RealDebrid with Plex, Emby, or Jellyfin)

Self-Hosting

You can build an image using the Dockerfile and run it.

Alternatively, you can also start WebStreamr directly via

npm install
npm run build
npm start

Environment variables

CACHE_DIR

Optional. Directory for persistent caches using SQLite files. Default: OS tmp dir.

CONFIGURATION_DESCRIPTION

Optional. To customize the description shown on the configuration page.

DISABLED_EXTRACTORS

Optional. Comma separated list of extractors which should be disabled. E.g. doodstream,vidsrc

DISABLED_SOURCES

Optional. Comma separated list of sources which should be disabled. E.g. frembed,vidsrc

MANIFEST_ID

Optional. Add-on manifest ID. Default: webstreamr

MANIFEST_NAME

Optional. Add-on manifest name. Default: WebStreamr

PORT

Optional. Port of the node web server. Default: 51546

PROXY_CONFIG

Optional. Proxies which should be used based on domain. Supports minimatch. E.g. dood.to:http://USERNAME:PASSWORD@IP:PORT,*:socks5://172.17.0.1:1080 would use an http proxy for dood.to and a socks5 proxy for all other domains.

TMDB_ACCESS_TOKEN

Required. TMDB access token to get information like title and year for content. Use the API Read Access Token.