diff --git a/README.md b/README.md index 0ba2058..eb418fe 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,41 @@ 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](https://www.themoviedb.org/settings/api).