Repository navigation
Releases and Versions
- Outpace uses
MAJOR.MINOR.PATCHversion numbers. Read the release notes before upgrading; the supported compatibility subset and optional features are documented explicitly. - A release is a git tag
vX.Y.Z. Publishing one builds the binaries, theSHA256SUMSfile and the container images, and creates a GitHub Release. - The version a binary reports is the version in the source it was built from. The tag must match it.
- 1.0.0 is the first stable release. The 0.x tags (up to v0.9.0) were development builds. They are still listed on the releases page for history, but they aren't supported and the wiki doesn't describe them: run 1.0.0 or later. Version notes in the wiki only name releases newer than 1.0.0.
The latest published release is v1.2.1, a patch release on top of 1.2.0. See the GitHub Release for downloads, the 1.2.1 notes and 1.2.0 notes for recent changes, and the 1.0.0 notes for scope, upgrades and validation limits.
- GitHub Releases: https://github.com/outpace-stream/outpace-engine/releases. Each release lists its downloads and generated change notes.
-
Curated notes: for releases that have them, in
docs/releases/(including1.0.0.md,1.0.1.md,1.0.2.md,1.0.3.md,1.1.0.md,1.2.0.mdand1.2.1.md). - Milestones: https://github.com/outpace-stream/outpace-engine/milestones track what each version covers.
outpace --version
docker run --rm ghcr.io/outpace-stream/outpace-engine:1.2.1 --version
curl "http://127.0.0.1:6878/server/api?method=get_version" # needs OUTPACE_ACE_COMPAT=1get_version returns version, a numeric code (MAJOR*10000 + MINOR*100 + PATCH) and the
platform. It identifies Outpace, not an AceStream engine build.
edge builds report the workspace version at their source commit. During release
preparation this can be the upcoming version before that release is published. To find out exactly which commit an edge image contains:
docker image inspect ghcr.io/outpace-stream/outpace-engine:edge \
--format '{{ index .Config.Labels "org.opencontainers.image.revision" }}'Every edge build is also tagged sha-<full commit hash>. Pin that tag if you need a specific
build.
| Tag | Moves? | Architectures | Use for |
|---|---|---|---|
X.Y.Z (e.g. 1.2.1) |
No | amd64, arm64, arm/v7 | Production. Pin this. |
latest |
With each release | amd64, arm64, arm/v7 | Trying the newest release. |
X.Y.Z-minimal, minimal
|
Like X.Y.Z and latest
|
amd64, arm64, arm/v7 | Smaller scratch image. |
edge |
With every merge to main
|
amd64 | Testing unreleased features. |
sha-<commit> |
No | amd64 | Pinning one specific main build. |
A patch release with no new features or default changes:
-
Casting: a
playthat fails after the TV may already have acted on it is followed by oneStop, and the stream the TV has open ends when its cast is stopped, fails or is replaced, so a failed cast no longer leaves the TV playing (#497, #498). A failedplaycan take up to 5 seconds longer to answer. - A best-effort
x86_64-linux-androidarchive was attached after publication, for x86_64 emulator images, ChromeOS and Intel or AMD Android TV boxes (#505). See Installation and Android App.
A minor release with two opt-in features and no default changes:
-
Casting: with
OUTPACE_ENABLE_CAST=1, the engine finds DLNA/UPnP renderers on the LAN and tells one to play a live stream (/cast/*routes) (#488). - An optional SOCKS5 outbound proxy for peer, tracker and catalog
connections (
OUTPACE_PROXY,OUTPACE_PROXY_MODE) (#492). Stream status reports the active path asnetwork_path, and/network-policygains aproxyobject. - Stream status reports a start
phaseand, on failure, anerrorcode. Native start routes and/vod/...errors return a JSON{"error":{"code","message"}}body instead of plain text or no body; status codes are unchanged (#487, #493). See Playing Streams. - A disk-cached VOD download that would not fit is refused with
507and codeno_space;OUTPACE_VOD_DISK_RESERVE_BYTESsets the space to leave free (#489). - DHT lookups send the next query as soon as a reply frees a slot, instead of waiting out fixed 1.5-second rounds (#490).
A minor release with one opt-in feature and no default changes:
- Opt-in engine camouflage (
OUTPACE_ACESTREAM_IDENTITY, default off) presents one official Linux engine profile to peers, search, the catalog, UPnP and broadcast descriptors (#476). - With it off, DHT messages carry the engine's version tag, use one node id per process and send
no
implied_port; handshakes advertise the real listen port and host uptime.
A patch release with no new features or default changes:
- Live streams whose peers hold less history than
OUTPACE_PREBUFFER_MSnow start as soon as everything up to the live edge has arrived, instead of waiting for the 15-second startup deadline. The[prebuffer]log line reportsreason=BacklogExhausted(#474).
A patch release with no new features or default changes, and the first one built and published from the organization:
- The warm peer cache now opens when the data directory sits under an execute-only parent, as on Android and Termux. Before, every start there was cold (#456).
- With
OUTPACE_METRICS=1, at most two/metricsscrapes collect at once, each within two seconds. A scrape over either limit gets503withRetry-After: 1(#466). - A best-effort
armv7-linux-androideabiarchive is published for 32-bit Android (#459). - Archives, packages and images are attested by
outpace-stream/outpace-engineand verify with--repo outpace-stream/outpace-engine. The best-effort Android archives are not attested; check them against their.sha256file.
A patch release with no new features or default changes. It fixes live audio normalization:
- Normalization no longer ends live streams when a generation starts mid-GOP on a high-bitrate
source, when a source chunk is larger than 1 MiB, or when the upstream reconnects every few
seconds (#447). Failures and recoveries are logged under
[audio]. - AC3 signalled as ATSC stream type
0x81, which FFmpeg writes by default, is now converted instead of refused with422(#448). With normalization off, HLS now drops0x81/0x87tracks when the stream has AAC, as it already did for DVB-signalled AC3.
1.0.0 is the baseline the rest of this wiki describes. Compared with the 0.x development builds it adds:
New features
-
Timeshift: per-viewer rewind of live HLS (
OUTPACE_HISTORY_*). -
Managed HLS origins: HLS-origin descriptors, the opt-in relay
(
OUTPACE_MANAGED_HLS), gzip playlists, connection reuse,X-Outpace-Upstream-Status, and origin replay. -
SRT ingest, in builds with the
srtfeature (OUTPACE_SRT_*). -
Shared live audio normalisation for TS and HLS
(
OUTPACE_LIVE_AUDIO_NORMALIZE). -
Private peer mode and local descriptors (
OUTPACE_PRIVATE_PEERS,OUTPACE_PRIVATE_DESCRIPTORS,/network-policy). -
Support sources (
OUTPACE_SUPPORT_SOURCES,/support). - A Windows service (
outpace service install) and a macOS LaunchAgent; see Deployment. - A best-effort Android (
aarch64-linux-android) binary for Termux; see Installation. - An OpenWrt procd service and installer; see Routers and Small Devices.
-
.deband.rpmpackages with a systemd unit; see Installation. - A minimal
scratchimage (X.Y.Z-minimal) and theoutpace healthcheckcommand. - A FreeBSD x86_64 release binary; see Installation.
- Signed build provenance for release archives and images, checked with
gh attestation verify(see Installation). - Release binaries for ARMv6 hard-float (
arm-unknown-linux-musleabihf) and RISC-V 64 (riscv64gc-unknown-linux-musl); see Installation. -
Stream-name search, behind the separate default-off
OUTPACE_COMPAT_ACESTREAM_SERVICESsetting; client integration limits still apply. - Opt-in Prometheus metrics,
enabled with
OUTPACE_METRICS=1.
Fixes you'll notice
- An HLS stream whose source ends now returns its segments with
#EXT-X-ENDLISTinstead of503for ever. -
get_media_filesreportsmime: video/mp2tand a display filename for live streams, which the Android SDK needs. -
OUTPACE_PREBUFFER_TIMEOUT_MSis counted from the first media byte, and source gaps no longer restart it. - Stopping the daemon no longer waits for connected viewers to disconnect.
- One stuck stream cleanup no longer stops later idle streams from being cleaned up.
- The compatibility API rejects duplicated query parameters and file or stream selections it can't honour, while still accepting the Android SDK's duplicated descriptor parameters.
Validation
Before 1.0.0, the reviewed 7,500-second matched comparison against the original engine completed with more than 7,200 sampled active seconds per player, and the maintainer recorded production-replacement acceptance in #210. That acceptance is not a new passing soak of every later commit. Latency to live against the reference remains unmeasured; the historical reconnect stall was closed as inconclusive, not as causally fixed. See the 1.0.0 notes for the remaining limits.
Tags v0.1.0 to v0.9.0 were development builds published while the engine was being built. They lack most of the features above, have no build provenance, and get no fixes. If you still run one, upgrade to the latest release; see Upgrading. Their notes, such as the 0.9.0 notes, stay in the repository for history.
Multi-file/selected-file VOD (#79), optional broadcast discovery and metadata fields (#269), and original-engine HLS transport origination/support parity (#272) are explicitly deferred. VOD remains single-file; native VOD HLS has approximate byte-based segmentation, and PCR/keyframe seeking (#128) remains conditional on a demonstrated player failure. Managed HLS relay support does not establish original-engine HLS origination parity. These limitations do not disable supported live playback, native HLS or the documented broadcast subset. See the linked release notes for issue references and evidence requirements.
The Homebrew tap and
Scoop bucket contain the catalogs, pinned to
published release checksums. packaging/ stays in the engine repository because it builds
release packages and provides platform service/install files.
After publishing a release, clone both catalog repositories next to the engine checkout, create a topic branch in each, generate the manifests, and open a PR in each catalog:
gh repo clone outpace-stream/homebrew-outpace ../homebrew-outpace
gh repo clone outpace-stream/scoop-outpace ../scoop-outpace
git -C ../homebrew-outpace switch -c chore/update-outpace
git -C ../scoop-outpace switch -c chore/update-outpace
gh release download vX.Y.Z --repo outpace-stream/outpace-engine --pattern SHA256SUMS --dir /tmp/sums
python3 tools/release/package_manifests.py vX.Y.Z /tmp/sums/SHA256SUMS \
--homebrew-root ../homebrew-outpace --scoop-root ../scoop-outpaceThe generator requires explicit destination directories; it does not create Formula/ or
bucket/ inside the engine. Each catalog runs its own real-platform install checks.
The engine repository moved from jamezrin/outpace-stream to
outpace-stream/outpace-engine. GitHub redirects old repository links and Git remotes;
update local remotes with git remote set-url origin git@github.com:outpace-stream/outpace-engine.git.
The Android app is developed independently in
outpace-stream/outpace-android, with its own
version numbers. Its APK releases belong there; engine binaries remain in engine releases.
Container publication now targets ghcr.io/outpace-stream/outpace-engine. Existing personal-
namespace images at ghcr.io/jamezrin/outpace remain available for rollback. The initial
organization image is v1.0.1, and v1.0.2 is the first release published only there; older image
tags remain in the previous namespace. The binary
name, configuration, data paths and release archive names have not changed. Before switching
a deployment, verify the desired tag exists in the new namespace. See
Installation for historical attestation identity.
See Deployment. In short:
- Back up the data directory.
- Pin the new tag.
- Recreate the container (or restart the service).
- Check
/healthzand the logs.
Take extra care with active broadcasts when you roll back.
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