Repository navigation
Environment Variables
Every OUTPACE_* variable the daemon reads, A to Z. Each name links to its topic on the
Configuration page, which explains accepted values, validation and when to
change it. See Command Line for commands and flags.
Restart the daemon after any change. Booleans accept exactly 1, true, 0 or false.
Variables marked "exact 1" turn on only for the string 1. Avail. says where a variable
is available: all means every release (v1.0.0 and later); 1.1.0 means v1.1.0 and
later (also in edge and builds from main); 1.2.0 means v1.2.0 and later (also in edge
and builds from main); edge means current main and the edge image, not yet in a
numbered release; srt build requires the optional srt feature.
See Releases and Versions for publication status.
| Variable | Default | Avail. | Purpose |
|---|---|---|---|
OUTPACE_ACE_COMPAT |
false |
all | Turn on the AceStream-compatible /ace/* and /server/api routes. |
OUTPACE_COMPAT_ACESTREAM_SERVICES |
false |
all | Separate opt-in for external stream-name search. |
OUTPACE_ACE_PEERS |
unset | all | Extra bootstrap peers, as IPv4:port separated by commas. |
OUTPACE_ACESTREAM_IDENTITY |
false |
1.1.0 | Present the official engine's identity on the public network. |
OUTPACE_ACESTREAM_IDENTITY_ASN |
looked up | 1.1.0 | Autonomous system number. Set together with the country. |
OUTPACE_ACESTREAM_IDENTITY_COUNTRY |
looked up | 1.1.0 | ISO country code. Set together with the ASN. |
OUTPACE_ACESTREAM_IDENTITY_DEVICE_ID |
random, saved | 1.1.0 | 40-hex device id. Saved under the data directory when unset. |
OUTPACE_ACESTREAM_IDENTITY_HARDWARE_KEY |
from this host | 1.1.0 | 40-hex hardware key. Required where memory size can't be read. |
OUTPACE_ACESTREAM_IDENTITY_PLATFORM |
linux |
1.1.0 | Claimed platform. Only linux is accepted. |
OUTPACE_ACESTREAM_IDENTITY_USER_AGENT |
engine UA | 1.1.0 | User-Agent for search and AceStream web hosts. |
OUTPACE_ACESTREAM_IDENTITY_VERSION |
3.2.11 |
1.1.0 | Claimed engine version, X.Y.Z. |
OUTPACE_ALLOW_NON_GLOBAL_BROADCAST_SOURCE |
off | all | Exact 1: allow private and loopback broadcast pull sources. |
OUTPACE_ALLOW_NON_GLOBAL_TRANSPORT |
off | all | Exact 1: allow transport-file URLs on private hosts. |
OUTPACE_BEP9_CONTENT_ID_FALLBACK |
false |
all | Resolve content ids from peer metadata when the catalog fails. |
OUTPACE_BIND |
127.0.0.1:6878 |
all | HTTP API address. The container sets 0.0.0.0:6878. Casting needs a LAN address. |
OUTPACE_BROADCAST_OPTIONS |
{} |
all | Per-broadcast metadata profiles (JSON). |
OUTPACE_BROADCAST_CATALOG_REGISTER |
false |
edge | Register public broadcasts with the AceStream catalog. |
OUTPACE_BROADCAST_SOURCES |
{} |
all | HTTP(S) MPEG-TS pull sources started at boot (JSON). Treat as a secret. |
OUTPACE_CACHE_DIR |
<data dir>/cache |
all | Disk-cache root. Wiped at startup. |
OUTPACE_CACHE_TYPE |
memory |
all | Where seeding pieces are kept: memory or disk. |
OUTPACE_DATA_DIR |
platform data dir + outpace
|
all | Identity and broadcast state. The container uses /var/lib/outpace. |
OUTPACE_ENABLE_CAST |
false |
1.2.0 | Add the /cast/* routes for DLNA/UPnP renderers. Needs a LAN OUTPACE_BIND. |
OUTPACE_ENABLE_INBOUND |
true |
all | Accept inbound peers and announce to trackers and the DHT. |
OUTPACE_ENABLE_PORT_MAPPING |
false |
all | Ask the router to open the peer port with UPnP or NAT-PMP. |
OUTPACE_ENABLE_SEEDING |
true |
all | Upload to the peers you download from. |
OUTPACE_EXPERIMENTAL_ACE_COMPAT |
unset | all | Deprecated name for OUTPACE_ACE_COMPAT. |
OUTPACE_FFMPEG_PATH |
ffmpeg |
all | FFmpeg executable, used only for audio normalisation. |
OUTPACE_HISTORY_BYTES |
128 MiB | all | Timeshift memory per source. |
OUTPACE_HISTORY_SECONDS |
0 (off) |
all | How far back viewers can rewind, up to 3600 seconds. |
OUTPACE_HISTORY_TOTAL_BYTES |
256 MiB | all | Timeshift memory shared by all sources. |
OUTPACE_HLS_AUDIO_NORMALIZE |
false |
all | Convert AC3 and MPEG audio to AAC for live HLS. |
OUTPACE_HLS_SEGMENT_DURATION_MS |
5000 |
all | Target HLS segment length. |
OUTPACE_HLS_SEGMENT_PACKETS |
65536 |
all | Size ceiling per segment, in 188-byte packets. |
OUTPACE_HLS_STARTUP_SEGMENTS |
6 |
all | Segments ready before the first playlist is returned. |
OUTPACE_HLS_STARTUP_TIMEOUT_MS |
45000 |
all | HLS startup wait before answering 503. |
OUTPACE_HLS_WINDOW_SEGMENTS |
8 |
all | Segments kept in the live playlist. |
OUTPACE_LIVE_AUDIO_NORMALIZE |
false |
all | Convert audio once per source, for TS and HLS. |
OUTPACE_MANAGED_HLS |
false |
all | Relay HLS-origin descriptors locally instead of redirecting players. |
OUTPACE_MAX_ACTIVE_UPSTREAMS |
4 |
all | Peers one stream downloads from at once. |
OUTPACE_MAX_INBOUND |
64 |
all | Total inbound peer connections. |
OUTPACE_MAX_INBOUND_PER_STREAM |
16 |
all | Inbound connections per stream. 0 means no per-stream cap. |
OUTPACE_MAX_PARALLEL_CONNECT |
12 |
all | Peers dialled at once while searching. |
OUTPACE_MAX_PIECE_ADVANCE |
256 |
all | Pieces scheduled in one forward step. |
OUTPACE_MAX_REASM_PIECES_AHEAD |
512 |
all | Pieces accepted ahead of the playback cursor. |
OUTPACE_MAX_SESSIONS |
0 (unlimited) |
all | Cap on concurrent sources. |
OUTPACE_MAX_UNCHOKED |
8 |
all | Stable desired unchoke count per stream, plus one rotating optimistic peer. 0 still selects one optimistic peer; this is not an instantaneous wire-visible cap. |
OUTPACE_METRICS |
false |
all | Serve Prometheus metrics at GET /metrics. |
OUTPACE_PEER_LISTEN |
0.0.0.0:8621 |
all | TCP peer listener. Its port is also the announced port. |
OUTPACE_PORT_MAP_BACKEND |
auto |
all |
auto, upnp, natpmp or none. |
OUTPACE_PORT_MAP_EXTERNAL_PORT |
the peer port | all | External port to request from the router. |
OUTPACE_PREBUFFER_BYTES |
128 MiB | all | Cap on the startup buffer. |
OUTPACE_PREBUFFER_MS |
30000 |
all | Media to collect before playback starts. 0 disables it. |
OUTPACE_PREBUFFER_TIMEOUT_MS |
15000 |
all | Longest startup wait after the first media byte. |
OUTPACE_PREFETCH_PIECES |
automatic | all | Pieces behind the live edge to start at. |
OUTPACE_PRIVATE_DESCRIPTORS |
unset | all | Local descriptor files, as an alias-to-path JSON object. |
OUTPACE_PRIVATE_PEERS |
unset | all | Allowlist that switches on private peer mode. |
OUTPACE_PROXY |
unset | 1.2.0 | SOCKS5 proxy for peer, tracker and catalog connections, socks5://[user:password@]host:port. Treat as a secret when it has credentials. |
OUTPACE_PROXY_MODE |
off |
1.2.0 |
off, on or fallback (proxy only after a live start finds no peers). |
OUTPACE_REQUEST_CHECK_INTERVAL_MS |
1000 |
all | How often outstanding piece requests are checked. |
OUTPACE_REQUEST_TIMEOUT_MS |
1500 |
all | Wait for a piece before asking another peer. |
OUTPACE_RTMP_BIND |
127.0.0.1:1935 |
all | RTMP ingest address. The container sets 0.0.0.0:1935. |
OUTPACE_SEED_DEBUG |
unset | all | Log every inbound seeding message. Very verbose. |
OUTPACE_SEED_RETENTION_SECS |
45 |
all | Seconds of recent pieces kept per live stream. |
OUTPACE_SEED_STORE_BYTES |
128 MiB | all | Ceiling on retained pieces per stream. |
OUTPACE_SEED_TTL_SECS |
300 |
all | Safety net that frees seeding data nothing owns. |
OUTPACE_SESSION_BUFFER |
256 |
all | Per-viewer fan-out queue depth. |
OUTPACE_SRT_BIND |
unset (off) | srt build | SRT ingest address (UDP). |
OUTPACE_SRT_LATENCY_MS |
120 |
srt build | SRT receiver latency, 20–2000 ms. |
OUTPACE_SRT_MAX_CONNECTIONS |
4 |
srt build | Simultaneous SRT connections, 1–16. |
OUTPACE_SRT_PASSPHRASE_FILE |
unset | srt build | SRT passphrase file. Required with OUTPACE_SRT_BIND. |
OUTPACE_STALE_UPSTREAM_TIMEOUT_MS |
12000 |
all | Rebuild the peer pool after this long without progress. |
OUTPACE_SUPPORT_SOURCES |
unset (off) | all | Streams kept running and seeding with no viewer (JSON). |
OUTPACE_TRACKER_ALLOW_NON_GLOBAL |
off | all | Exact 1: allow announcing to trackers on private addresses. |
OUTPACE_TRACKERS |
built-in public tracker | all | Trackers written into new broadcasts. |
OUTPACE_VOD_DISK_RESERVE_BYTES |
256 MiB | 1.2.0 | Free space a disk-cached VOD download must leave. |
Variables named OUTPACE_TEST_*, OUTPACE_DHT_COMPARE_* or OUTPACE_RUN_* belong to the test
suite. The repository's Compose file also reads OUTPACE_IMAGE, OUTPACE_HTTP_HOST,
OUTPACE_HTTP_PORT, OUTPACE_RTMP_HOST and OUTPACE_RTMP_PORT; see
Configuration.
This wiki is generated from docs/wiki/ in the main repository. To fix or improve a page, open a pull request there; the wiki is republished automatically when it merges, and edits made in the wiki web UI are overwritten.
Start
Watching
Publishing and peers
- Broadcasting
- Seeding and Peers
- Engine Camouflage
- NAT and Port Mapping
- Private Peer Mode
- Outbound Proxy
Running it
- Deployment
- Routers and Small Devices
- Migrating from AceStream Engine
- Support Sources and Operations
- Troubleshooting
- Releases and Versions
Success stories