Repository navigation
Routers and Small Devices
Outpace runs on routers, NAS boxes and single-board computers, but they have far less RAM and flash than a server. This page collects what changes on them.
| Device | Use |
|---|---|
| OpenWrt router | The OpenWrt installer below. It picks the right build. |
| Raspberry Pi 2/3/4/5, most ARM NAS boxes |
armv7-unknown-linux-musleabihf (32-bit) or aarch64-unknown-linux-musl (64-bit OS) from Installation. |
| Raspberry Pi Zero/1 |
arm-unknown-linux-musleabihf (ARMv6). |
| RISC-V boards |
riscv64gc-unknown-linux-musl. |
| x86 mini PC or appliance |
x86_64-unknown-linux-musl. |
All Linux release binaries are static (musl), so they run on any distribution, including ones without glibc. Check Installation for which other architectures a release has.
The defaults suit a server. The large buffers are per stream (and the session buffer per viewer), so on a small device cap them and allow one stream at a time:
| Variable | Default | Small device |
|---|---|---|
OUTPACE_MAX_SESSIONS |
0 (unlimited) |
1 |
OUTPACE_SEED_STORE_BYTES |
128 MiB |
33554432 (32 MiB) |
OUTPACE_PREBUFFER_BYTES |
128 MiB |
16777216 (16 MiB) |
OUTPACE_SESSION_BUFFER |
256 |
64 |
OUTPACE_CACHE_TYPE |
memory |
disk, on USB or other external storage only |
- On 32-bit systems each in-memory pool is capped at about 512 MiB whatever you set.
- Don't put
OUTPACE_CACHE_DIRon the router's internal flash: the cache is rewritten constantly and wears flash out. Use USB storage, or keep the memory cache with a small seed store. - See Configuration for every setting.
The repository's
packaging/openwrt/
directory has a procd service, a UCI configuration with the small-device settings above, and an
installer. It is tested under procd on OpenWrt 24.10.
Download the repository to the router, then run the installer as root with the release you want. The installer and its files come from the repository; the binary comes from the release:
cd /tmp
wget -O outpace-src.tar.gz https://github.com/outpace-stream/outpace-engine/archive/refs/heads/main.tar.gz
tar -xzf outpace-src.tar.gz
sh outpace-engine-main/packaging/openwrt/install.sh 1.2.1The installer:
- reads the router's architecture from
/etc/openwrt_releaseand downloads the matching release archive; - checks the archive against
SHA256SUMS; - installs
/usr/bin/outpace,/etc/init.d/outpaceand/etc/config/outpace, and creates an unprivilegedoutpaceuser; - leaves the service disabled.
To install a binary you already have, run install.sh --binary /path/to/outpace instead.
Running the installer again upgrades the binary and keeps your configuration.
| OpenWrt architecture | Release build |
|---|---|
x86_64 |
x86_64-unknown-linux-musl |
aarch64_* |
aarch64-unknown-linux-musl |
arm_* with VFP/NEON (e.g. arm_cortex-a7_neon-vfpv4) |
armv7-unknown-linux-musleabihf |
arm_arm1176jzf-s_vfp |
arm-unknown-linux-musleabihf |
riscv64_* |
riscv64gc-unknown-linux-musl |
Only releases that ship an architecture's build can be installed on it. Every release from 1.0.0 on ships all five.
MIPS routers (for example MT7621 or ath79 boards) are not supported. Most have too little flash and RAM for Outpace, and Rust supports MIPS only as a tier 3 target.
Enable and start it:
uci set outpace.main.enabled=1
uci commit outpace
/etc/init.d/outpace enable
/etc/init.d/outpace start
logread -e outpace- Edit
/etc/config/outpaceto change settings, then run/etc/init.d/outpace restart. The named options cover the common settings. Anything else goes inlist env 'NAME=value'. - The API listens on
127.0.0.1:6878. To reach it from the LAN, setoption bindto the router's LAN address, for example192.168.1.1:6878. Never bind it on the WAN. -
/etc/outpaceholds the node identity and broadcast keys. It and the binary are kept acrosssysupgrade. - To take part as a full peer, open TCP 8621 on the WAN in the firewall, or turn on port mapping on a router that runs UPnP.
These run FreeBSD. The FreeBSD x86_64 binary covers them. Treat a
firewall carefully: keep the API on 127.0.0.1 and open only the peer port.
- Installation: every binary and image.
- Deployment: systemd, Docker Compose and reverse proxies.
- NAT and Port Mapping: making the peer port reachable.
- OpenWrt Router: a reported setup on an ASUS TUF-AX6000.
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