13. Environment Variables Reference

Complete reference for all environment variables used in docker-rtmp-multistream.

Quick Configuration

For a practical guide on using these variables, see the Configuration Guide.

13.1 System Variables

13.1.1 PUBLISH_IP_RANGE

Description: IP address range allowed to publish streams to the relay. Uses CIDR notation.

Type: String (CIDR notation)

Default: 172.17.0.0/16,192.168.0.0/16

Used by: Authentication system (auth.conf)

Examples:

PUBLISH_IP_RANGE=192.168.0.0/16   # Entire local network
PUBLISH_IP_RANGE=192.168.1.0/24   # Specific subnet
PUBLISH_IP_RANGE=192.168.1.50/32  # Single IP address

See also: Security

13.2 Twitch Variables

13.2.1 TWITCH_KEY

Description: Stream key provided by Twitch. Setting this variable enables the Twitch service.

Type: String

Default: "" (empty, service disabled)

Required: Yes (to enable Twitch)

Used by: Twitch application config

Example:

TWITCH_KEY=live_123456789_abcdefghijklmnopqrstuvwxyz

See also: Twitch Configuration

13.2.2 TWITCH_PARTNER

Description: Boolean flag indicating whether the user is a Twitch Partner with transcoding services. When TRUE, uses simple relay pattern (passthrough) like YouTube. When FALSE, uses transformer pattern (FFmpeg re-encoding).

Type: Boolean (TRUE / FALSE, case insensitive)

Default: FALSE

Required: No

Used by: Twitch service configuration script (90_configure_twitch.sh)

Values:

TRUE (or true): Partner mode - Simple relay with no transcoding. Stream is forwarded directly to Twitch, preserving full source quality for Twitch's multi-bitrate transcoding services. All transformer-related variables (TWITCH_HEIGHT, TWITCH_FPS, etc.) are ignored in this mode.
FALSE (or false): Non-partner mode (default) - Transformer pattern with FFmpeg re-encoding. Allows full control over output quality, resolution, bitrate, and codec. Useful for bandwidth optimization or streaming to Twitch without partner transcoding.

Example:

# Partner mode (simple relay, no encoding)
TWITCH_PARTNER=TRUE

# Non-partner mode (default, with encoding)
TWITCH_PARTNER=FALSE

Service Pattern Selection

The TWITCH_PARTNER setting determines which nginx configuration files are enabled:

Partner mode: Enables apps/twitch-partner.conf (simple relay)
Non-partner mode: Enables transformers/twitch.conf + apps/twitch.conf (transformer pattern)

13.2.3 TWITCH_AUDIO_BITRATE

Description: Audio bitrate for the Twitch stream. 160k is the maximum supported by Twitch.

Type: String (with 'k' suffix)

Default: 160k

Required: No

Used by: Twitch transformer

Examples:

TWITCH_AUDIO_BITRATE=160k  # Maximum quality
TWITCH_AUDIO_BITRATE=128k  # Good quality

13.2.4 TWITCH_CODEC

Description: Video codec for Twitch encoding. Typically shouldn't be changed.

Type: String

Default: libx264

Required: No

Used by: Twitch transformer

Possible values: libx264, libx264rgb, other FFmpeg-supported codecs

13.2.5 TWITCH_ENDPOINT

Description: Twitch ingest server identifier. Choose the server closest to your location.

Type: String (server code)

Default: jfk (New York)

Required: No

Used by: Twitch application config

Common values: - jfk - New York, NY - lax - Los Angeles, CA - dfw - Dallas, TX - ord - Chicago, IL - sea - Seattle, WA - iad - Ashburn, VA - fra - Frankfurt, Germany - lhr - London, UK - syd - Sydney, Australia - sin - Singapore - gru - São Paulo, Brazil

See also: Twitch Ingest Endpoints

13.2.6 TWITCH_FFMPEG_THREADS

Description: Number of CPU threads for FFmpeg encoding. 0 means auto-optimize.

Type: Integer

Default: 0

Required: No

Used by: Twitch transformer

Examples:

TWITCH_FFMPEG_THREADS=0   # Auto-optimize (recommended)
TWITCH_FFMPEG_THREADS=4   # Limit to 4 threads
TWITCH_FFMPEG_THREADS=8   # Use 8 threads

When to override: When streaming to multiple services to ensure fair CPU distribution.

13.2.7 TWITCH_FPS

Description: Frames per second for the Twitch stream.

Type: Integer

Default: 60

Required: No

Used by: Twitch transformer (for bitrate calculation)

Common values: 60, 50, 30, 25, 24

See also: Twitch Quality Settings

13.2.8 TWITCH_HEIGHT

Description: Video height in pixels. Width is calculated automatically to maintain aspect ratio.

Type: Integer

Default: 720

Required: No

Used by: Twitch transformer

Common values: 1080, 900, 720, 540, 480

Note: Twitch recommends 720p for most non-partner streams due to lack of guaranteed transcoding.

13.2.9 TWITCH_KBITS_PER_VIDEO_FRAME

Description: Bitrate multiplier for video encoding. Actual bitrate = TWITCH_KBITS_PER_VIDEO_FRAME * TWITCH_FPS.

Type: Integer

Default: 75

Required: No

Used by: Twitch transformer

Recommended values: - 100 for 1080p (results in 6000 kbps @ 60fps) - 75 for 720p (results in 4500 kbps @ 60fps)

Formula: bitrate = TWITCH_KBITS_PER_VIDEO_FRAME * TWITCH_FPS

Examples:

TWITCH_KBITS_PER_VIDEO_FRAME=100  # 1080p: 6000 kbps @ 60fps
TWITCH_KBITS_PER_VIDEO_FRAME=75   # 720p: 4500 kbps @ 60fps
TWITCH_KBITS_PER_VIDEO_FRAME=50   # 540p: 3000 kbps @ 60fps

See also: Twitch Bitrate Reference

13.2.10 TWITCH_X264_PRESET

Description: x264 encoding preset. Controls speed vs quality trade-off.

Type: String

Default: medium

Required: No

Used by: Twitch transformer

Possible values (fastest to slowest): - ultrafast - Extremely fast, lowest quality - superfast - Very fast, low quality - veryfast - Fast, moderate quality - faster - Faster, good quality - fast - Fast, good quality - medium - Default, balanced - slow - Slower, better quality - slower - Much slower, high quality - veryslow - Extremely slow, highest quality

Recommendation: Presets slower than medium offer diminishing returns. Use fast or veryfast if CPU is constrained.

See also: x264 Encoding Guide

13.3 YouTube Variables

13.3.1 YOUTUBE_KEY

Description: Stream key provided by YouTube. Setting this variable enables the YouTube service.

Type: String

Default: "" (empty, service disabled)

Required: Yes (to enable YouTube)

Used by: YouTube application config

Example:

YOUTUBE_KEY=abcd-efgh-ijkl-mnop-qrst

See also: YouTube Configuration

13.4 Archive Variables

13.4.1 ARCHIVE_PATH

Description: Directory path inside the container where streams are archived. Setting this variable enables archiving.

Type: String (filesystem path)

Default: "" (empty, archiving disabled)

Required: Yes (to enable archiving)

Used by: Archive service configuration

Example:

ARCHIVE_PATH=/archive

Important: - Path must exist inside container - Must be writable by nginx user (UID:GID 100:101) - Map to host directory via Docker volume for persistence

See also: Archive Configuration

13.4.2 ARCHIVE_SUFFIX

Description: File extension for archived stream files.

Type: String

Default: flv

Required: No

Used by: Archive service configuration

Common values: flv, mp4, mkv

Example:

ARCHIVE_SUFFIX=mp4

Note: File format depends on stream encoding. flv is the most compatible with RTMP streams.

13.5 See Also

Configuration Overview - How configuration works
Adding Services - Define custom environment variables