|
| 1 | +# ============================================================================================================================ # |
| 2 | +# ██╗ ██╗███████╗███████╗███╗ ██╗███████╗████████╗ ██╗ ██╗██╗ ████████╗██╗███╗ ███╗ █████╗ ████████╗███████╗ # |
| 3 | +# ██║ ██║██╔════╝██╔════╝████╗ ██║██╔════╝╚══██╔══╝ ██║ ██║██║ ╚══██╔══╝██║████╗ ████║██╔══██╗╚══██╔══╝██╔════╝ # |
| 4 | +# ██║ ██║███████╗█████╗ ██╔██╗ ██║█████╗ ██║ ██║ ██║██║ ██║ ██║██╔████╔██║███████║ ██║ █████╗ # |
| 5 | +# ██║ ██║╚════██║██╔══╝ ██║╚██╗██║██╔══╝ ██║ ██║ ██║██║ ██║ ██║██║╚██╔╝██║██╔══██║ ██║ ██╔══╝ # |
| 6 | +# ╚██████╔╝███████║███████╗██║ ╚████║███████╗ ██║ ╚██████╔╝███████╗ ██║ ██║██║ ╚═╝ ██║██║ ██║ ██║ ███████╗ # |
| 7 | +# ╚═════╝ ╚══════╝╚══════╝╚═╝ ╚═══╝╚══════╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚══════╝ # |
| 8 | +# ============================================================================================================================ # |
| 9 | +# |
| 10 | +# For the most up-to-date documentation and variables, see https://github.com/DSmart33/Usenet-Ultimate |
| 11 | +# |
| 12 | +# All env var overrides follow the priority: env var > config.json > default. |
| 13 | +# Active overrides are logged at startup. |
| 14 | +# |
| 15 | +# ============================================================================== |
| 16 | +# ESSENTIAL ADDON SETUP |
| 17 | +# ============================================================================== |
| 18 | + |
| 19 | +# Base URL for the application (used in manifests, stream URLs, and NZB proxy links) |
| 20 | +# Must be publicly accessible if using with Stremio remotely |
| 21 | +BASE_URL=https://${USENET_ULTIMATE_HOSTNAME?} |
| 22 | + |
| 23 | +# HTTP server port |
| 24 | +PORT=1337 |
| 25 | + |
| 26 | +# ============================================================================== |
| 27 | +# INDEXER CONFIGURATION (ONE-TIME MIGRATION) |
| 28 | +# ============================================================================== |
| 29 | +# These values are migrated to config.json on first startup. |
| 30 | +# After initial setup, manage indexers through the web UI instead. |
| 31 | + |
| 32 | +# Single indexer |
| 33 | +#INDEXER_URL=https://your-indexer.com |
| 34 | +#INDEXER_API_KEY=your-api-key-here |
| 35 | + |
| 36 | +# Multiple indexers (comma-separated) |
| 37 | +#INDEXER_URL=https://indexer1.com,https://indexer2.com |
| 38 | +#INDEXER_API_KEY=key1,key2 |
| 39 | + |
| 40 | +# ============================================================================== |
| 41 | +# CACHE CONFIGURATION |
| 42 | +# ============================================================================== |
| 43 | +# Also migrated to config.json on first startup; manage via web UI after that. |
| 44 | + |
| 45 | +# Search result cache TTL in seconds (default: 43200 = 12 hours; 0 disables caching) |
| 46 | +#CACHE_TTL=43200 |
| 47 | + |
| 48 | +# ============================================================================== |
| 49 | +# INDEX MANAGER |
| 50 | +# ============================================================================== |
| 51 | +# Runtime overrides — these always take priority over config.json / web UI values. |
| 52 | + |
| 53 | +# Indexer manager type (options: newznab, prowlarr, nzbhydra) |
| 54 | +#INDEX_MANAGER=prowlarr |
| 55 | + |
| 56 | +# Prowlarr connection |
| 57 | +#PROWLARR_URL=http://prowlarr:9696 |
| 58 | +#PROWLARR_API_KEY=your-prowlarr-api-key |
| 59 | + |
| 60 | +# NZBHydra connection |
| 61 | +#NZBHYDRA_URL=http://nzbhydra:5076 |
| 62 | +#NZBHYDRA_API_KEY=your-nzbhydra-api-key |
| 63 | + |
| 64 | +# ============================================================================== |
| 65 | +# NZBDAV CONNECTION |
| 66 | +# ============================================================================== |
| 67 | + |
| 68 | +# NZBDav API and WebDAV configuration |
| 69 | +#NZBDAV_URL=http://nzbdav:3000 |
| 70 | +#NZBDAV_API_KEY=your-nzbdav-api-key |
| 71 | +#NZBDAV_WEBDAV_URL=http://nzbdav:3000 |
| 72 | +#NZBDAV_WEBDAV_USER=admin |
| 73 | +#NZBDAV_WEBDAV_PASS=your-webdav-password |
| 74 | + |
| 75 | +# ============================================================================== |
| 76 | +# BUILT-IN EASYNEWS INDEXER |
| 77 | +# ============================================================================== |
| 78 | + |
| 79 | +# Easynews integration (optional) |
| 80 | +#EASYNEWS_ENABLED=false |
| 81 | +#EASYNEWS_USERNAME=your-easynews-username |
| 82 | +#EASYNEWS_PASSWORD=your-easynews-password |
| 83 | + |
| 84 | +# ============================================================================== |
| 85 | +# STREAMING CONFIGURATION |
| 86 | +# ============================================================================== |
| 87 | + |
| 88 | +# Streaming mode (options: nzbdav, stremio) |
| 89 | +#STREAMING_MODE=nzbdav |
| 90 | + |
| 91 | +# Stream buffer size in megabytes (reduces micro-stalls on high-bitrate content) |
| 92 | +# Priority: STREAM_BUFFER_MB env var > config UI setting > 64 MB default |
| 93 | +#STREAM_BUFFER_MB=64 |
| 94 | + |
| 95 | +# ============================================================================== |
| 96 | +# HTTP PROXY |
| 97 | +# ============================================================================== |
| 98 | + |
| 99 | +# Proxy mode (options: disabled, http) |
| 100 | +#PROXY_MODE=disabled |
| 101 | +#PROXY_URL=http://your-proxy:8080 |
| 102 | + |
| 103 | +# ============================================================================== |
| 104 | +# NZB HEALTH CHECK |
| 105 | +# ============================================================================== |
| 106 | + |
| 107 | +# Zyclops verification service endpoint (for NZB health checking) |
| 108 | +# Override to point at a self-hosted Zyclops instance |
| 109 | +#ZYCLOPS_ENDPOINT=https://zyclops.elfhosted.com |
| 110 | + |
| 111 | +# NNTP-level health checks — define a primary Usenet provider via env vars |
| 112 | +# When HEALTH_CHECK_NNTP_HOST is set, it is prepended to any providers in config.json |
| 113 | +#HEALTH_CHECK_ENABLED=true |
| 114 | +#HEALTH_CHECK_NNTP_HOST=news.your-provider.com |
| 115 | +#HEALTH_CHECK_NNTP_PORT=563 |
| 116 | +#HEALTH_CHECK_NNTP_TLS=true |
| 117 | +#HEALTH_CHECK_NNTP_USER=your-usenet-username |
| 118 | +#HEALTH_CHECK_NNTP_PASS=your-usenet-password |
| 119 | + |
| 120 | +# ============================================================================== |
| 121 | +# ADMIN / MAINTENANCE |
| 122 | +# ============================================================================== |
| 123 | + |
| 124 | +# One-time password reset (remove after restart) |
| 125 | +# Format with username: RESET_PASSWORD=username:newpassword |
| 126 | +# Single-user shorthand: RESET_PASSWORD=newpassword |
| 127 | +#RESET_PASSWORD= |
0 commit comments