Meta tags:
description= 🐙 Octoplex is a Docker-native live video restreamer. - rfwatson/octoplex;
Headings (most frequently used words):
octoplex, with, docker, destination, uh, oh, navigation, restreaming, server, saved, searches, and, files, start, interface, security, contributing, footer, run, all, in, one, client, flags, rtmp, rtmps, search, code, repositories, users, issues, pull, requests, provide, feedback, rfwatson, menu, use, to, filter, your, results, more, quickly, folders, latest, commit, history, repository, table, of, contents, quick, user, interfaces, how, it, works, installation, starting, interacting, web, advanced, acknowledgements, licence, about, releases, 17, packages, contributors, languages, screenshots, engine, only, if, you, ll, locally, command, line, cli, subcommand, reference, mode, authentication, admin, password, api, tokens, url, incoming, streams, tls, obs, ffmpeg, running, bug, reports, topics, resources, license, policy, stars, watchers, forks, homebrew, from, github, list, destinations, add, update, stop, remove, rtsp, rtsps, compose,
Text of the page (most frequently used words):
#octoplex (99), server (81), the (68), and (50), docker (44), all (41), for (35), with (35), one (30), destination (29), you (28), tls (28), your (27), #client (25), start (25), see (24), security (23), from (21), github (20), run (20), rtmp (18), listen (18), web (18), live (17), rtmps (17), host (16), interface (16), 8080 (15), localhost (15), api (15), address (14), ffmpeg (13), 8443 (13), url (12), rtsp (12), rtsps (12), default (12), set (12), must (12), can (11), other (11), name (11), yaml (11), stop (11), log (11), this (10), terminal (10), flags (10), skip (10), code (10), use (9), interfaces (9), any (9), enabled (9), signed (9), valid (9), verify (9), that (8), contributing (8), view (8), running (8), certificate (8), none (8), add (8), authentication (8), auth (8), mode (8), file (8), connections (8), error (7), reload (7), license (7), data (7), rfwatson (7), install (7), tip (7), enable (7), restreaming (7), obs (7), when (7), are (7), 127 (7), more (7), key (7), token (7), remove (7), destinations (7), not (6), latest (6), local (6), ports (6), network (6), image (6), flag (6), launch (6), non (6), process (6), stream (6), only (6), http (6), false (6), help (6), receive (6), hosts (6), enterprise (6), navigation (5), page (5), mediamtx (5), open (5), compose (5), bind (5), environment (5), var (5), tui (5), connect (5), level (5), input (5), copy (5), self (5), section (5), disable (5), streams (5), com (5), admin (5), password (5), path (5), user (5), update (5), list (5), search (5), community (4), there (4), was (4), while (4), loading (4), please (4), releases (4), readme (4), resources (4), video (4), restreamer (4), source (4), reports (4), also (4), octo_listen (4), sock (4), ghcr (4), homebrew (4), installation (4), variable (4), engine (4), advanced (4), mp4 (4), 1936 (4), 1935 (4), configuration (4), both (4), bound (4), requests (4), https (4), pass (4), quick (4), info (4), sources (4), destination_id (4), interactive (4), command (4), line (4), platform (4), features (4), settings (4), encoder (4), buf (4), actions (4), issues (4), support (4), time (3), manage (3), docs (3), stars (3), app (3), topics (3), native (3), software (3), bug (3), octo_listen_tls (3), unless (3), services (3), configured (3), container (3), then (3), warning (3), may (3), networks (3), text (3), entirely (3), traffic (3), octo_server_url (3), credentials (3), them (3), cli (3), starts (3), tokens (3), loopback (3), addresses (3), insecure (3), allow (3), auto (3), testing (3), internal (3), before (3), custom (3), remote (3), description (3), true (3), hostname (3), public (3), linux (3), macos (3), print (3), streaming (3), single (3), subcommand (3), locally (3), files (3), main (3), workflows (3), commit (3), insights (3), pull (3), another (3), tab (3), window (3), refresh (3), session (3), sign (3), saved (3), documentation (3), feedback (3), grade (3), copilot (3), solutions (3), explore (3), footer (2), repository (2), forks (2), 102 (2), policy (2), licence (2), mit (2), built (2), acknowledgements (2), volumes (2), stopped (2), restart (2), instead (2), details (2), octo_docker_host (2), containers (2), socket (2), has (2), connecting (2), proxy (2), daemon (2), rtsp_transport (2), tcp (2), 8332 (2), disabled (2), 8554 (2), flv (2), cert (2), trusted (2), deploying (2), plain (2), listeners (2), listens (2), otherwise (2), full (2), options (2), octo_stream_key (2), feed (2), incoming (2), serving (2), domain (2), example (2), values (2), reset (2), dir (2), they (2), printed (2), logs (2), first (2), but (2), regenerate (2), binds (2), require (2), even (2), requires (2), secure (2), read (2), don (2), control (2), note (2), provides (2), browser (2), warn (2), debug (2), show (2), alias (2), write (2), oci (2), compatible (2), launching (2), pem (2), encoded (2), used (2), grpc (2), state (2), home (2), version (2), reference (2), rtmp_url (2), need (2), interacting (2), installed (2), laptop (2), same (2), machine (2), runs (2), starting (2), build (2), brew (2), development (2), change (2), restream (2), focus (2), content (2), point (2), how (2), works (2), screenshots (2), out (2), metrics (2), automatic (2), protols (2), toml (2), main_test (2), sum (2), mod (2), cli_test (2), gen (2), dockerfile (2), mockery (2), goreleaser (2), gitignore (2), dockerignore (2), internalapi (2), proto (2), mise (2), frontend (2), assets (2), 271 (2), commits (2), last (2), message (2), menu (2), quality (2), discussions (2), appearance (2), cancel (2), available (2), searches (2), repositories (2), business (2), developer (2), customer (2), devops (2), perform, action, share, personal, information, cookies, contact, status, privacy, terms, 2026, inc, scss, html, typescript, languages, contributors, packages, sep, 2025, report, watching, watchers, activity, livestreaming, about, released, under, agpl, tview, website, lgpl, apache, makes, free, most, notably, driver, container_name, recommended, natively, via, download, release, design, needs, terminate, inside, mounted, effectively, root, access, evaluate, trade, offs, carefully, unsure, consider, through, just, either, import, into, store, above, sent, invalid, ssl, accept, certificates, following, untrusted, ensure, accessible, behind, reverse, explicitly, your_unique_stream_key, these, covered, anyone, pushing, unsolicited, unique, match, scheme, would, observe, cross, origin, errors, websocket, correctly, 192, 168, mydomain, api_token, foo, admin_password, bar, your_data_dir, needed, exactly, once, startup, after, won, able, retrieve, again, accessing, generates, securely, stores, completely, acknowledge, risk, refuses, always, never, which, designed, automatically, protects, its, whenever, anything, than, putting, fully, served, allows, some, overridden, unavailable, verification, octo_log_level, implies, octo_log_file, stderr, octo_log_to_file, jrottenberg, scratch, octo_image_name_ffmpeg, alpine, octo_image_name_mediamtx, optional, falls, back, sdk, docker_host, unix, ssh, 2375, octo_tls_key, certifcate, octo_tls_cert, octo_insecure_allow_no_auth, clients, octo_auth, octo_web, including, protocol, port, necessary, directory, storing, persistent, library, caches, octo_data_dir, env, modes, screen, existing, stdout, force, make, 036e2a81, dc85, 4758, ab04, 303849f35cd3, ships, remotely, usually, disables, validation, forget, replace, strings, own, placeholder, besides, off, calls, clean, lightweight, does, remotehost, different, want, cloud, long, unattended, debugging, pick, pair, unarchive, binary, somewhere, alternatively, grab, tap, using, desktop, setup, mac, active, between, double, check, exercise, extra, caution, facing, alpha, multiple, twitch, youtube, facebook, handles, reconnection, wiring, spins, ingest, rebroadcast, anywhere, followed, already, launched, try, now, visiting, graphical, based, real, controls, two, equivalent, functionality, supports, examples, etc, ideal, below, table, contents, scripting, automation, uis, health, generation, reconnections, drop, broadcast, fly, unlimited, items, history, date, folders, tags, branches, additional, star, fork, notification, notifications, dismiss, alert, switched, accounts, resetting, create, qualifiers, our, query, filter, results, quickly, submit, include, email, contacted, every, piece, take, very, seriously, provide, syntax, tips, clear, users, jump, pricing, premium, ons, powered, collections, trending, archive, program, accelerator, maintainer, lab, programs, fund, developers, sponsors, partners, trust, center, forum, skills, ebooks, events, webinars, stories, type, topic, industries, government, manufacturing, financial, healthcare, industry, cases, devsecops, modernization, case, nonprofits, startups, small, medium, teams, enterprises, company, size, marketplace, changelog, blog, why, leaks, secret, protection, find, fix, vulnerabilities, application, changes, review, plan, track, work, instant, dev, environments, codespaces, automate, workflow, integrate, external, tools, mcp, registry, new, direct, agents, issue, merge, better, creation, toggle,
Text of the page (random words):
a docker native live video restreamer github skip to content navigation menu toggle navigation sign in appearance settings platform ai code creation github copilot write better code with ai github copilot app direct agents from issue to merge mcp registry new integrate external tools developer workflows actions automate any workflow codespaces instant dev environments issues plan and track work code review manage code changes application security github advanced security find and fix vulnerabilities code security secure your code as you build secret protection stop leaks before they start explore why github documentation blog changelog marketplace view all features solutions by company size enterprises small and medium teams startups nonprofits by use case app modernization devsecops devops ci cd view all use cases by industry healthcare financial services manufacturing government view all industries view all solutions resources explore by topic ai software development devops security view all topics explore by type customer stories events webinars ebooks reports business insights github skills support services documentation customer support community forum trust center partners view all resources open source community github sponsors fund open source developers programs security lab maintainer community accelerator github stars archive program repositories topics trending collections enterprise enterprise solutions enterprise platform ai powered developer platform available add ons github advanced security enterprise grade security features copilot for business enterprise grade ai features premium support enterprise grade 24 7 support pricing search or jump to search code repositories users issues pull requests search clear search syntax tips provide feedback we read every piece of feedback and take your input very seriously include my email address so i can be contacted cancel submit feedback saved searches use saved searches to filter your results more quickly name query to see all available qualifiers see our documentation cancel create saved search sign in sign up appearance settings resetting focus you signed in with another tab or window reload to refresh your session you signed out in another tab or window reload to refresh your session you switched accounts on another tab or window reload to refresh your session dismiss alert message rfwatson octoplex public notifications you must be signed in to change notification settings fork 2 star 102 code issues 0 pull requests 0 discussions actions security and quality 0 insights additional navigation options code issues pull requests discussions actions security and quality insights rfwatson octoplex main branches tags go to file code open more actions menu folders and files name name last commit message last commit date latest commit history 271 commits 271 commits github workflows github workflows assets assets frontend frontend internal internal mise mise proto internalapi v1 proto internalapi v1 dockerignore dockerignore gitignore gitignore goreleaser yaml goreleaser yaml mockery yaml mockery yaml contributing md contributing md dockerfile dockerfile license license readme md readme md security md security md buf gen yaml buf gen yaml buf yaml buf yaml cli_test go cli_test go docker compose yaml docker compose yaml go mod go mod go sum go sum main go main go main_test go main_test go protols toml protols toml view all files repository files navigation readme contributing license security more items octoplex octoplex is a docker native live video restreamer restream live video to unlimited destinations add and remove destinations on the fly broadcast with obs or any rtmp or rtsp encoder automatic reconnections on drop automatic tls certificate generation for rtmps and rtsps web and terminal uis with live metrics and health command line interface for scripting and automation table of contents quick start user interfaces screenshots how it works installation docker engine only if you ll run octoplex locally octoplex homebrew from github with docker starting octoplex all in one client server interacting with octoplex command line interface cli list destinations add a destination update a destination start a destination stop a destination remove a destination subcommand reference server flags client flags all in one mode web interface security tls admin password and api tokens server url incoming streams restreaming with octoplex restreaming with obs rtmp rtmps restreaming with ffmpeg rtmp rtmps rtsp rtsps advanced running with docker docker run docker compose contributing bug reports acknowledgements licence quick start install octoplex see the installation section below launch all in one mode starts the server and the terminal ui in a single process ideal for local testing octoplex run point your encoder obs ffmpeg etc at the rtmp server full examples are in restreaming with octoplex rtmp localhost 1935 live stream key live or if your encoder supports rtmps rtmps localhost 1936 live self signed tls certificate by default that s it your local restreamer is live user interfaces octoplex provides two interactive user interfaces with equivalent functionality terminal ui launch in your terminal for a text based interface with real time metrics and interactive controls web ui launch in your browser for a graphical user interface if you followed the quick start section then you ve already launched the terminal ui you can try out the web interface now by visiting http localhost 8080 see web interface for more screenshots web terminal ui how it works octoplex server runs on your docker host as a container or daemon process and spins up mediamtx and ffmpeg containers that ingest your feed and rebroadcast it anywhere you point them it handles reconnection tls and container wiring so you can focus on your content obs octoplex encoder rtmp s restream to multiple destinations v twitch tv youtube facebook other destinations ️ warning alpha software octoplex is in active development features and configuration settings may change between releases double check your security configuration and exercise extra caution before deploying to public facing networks see the security section for more installation docker engine only if you ll run octoplex locally linux see https docs docker com engine install macos https docs docker com desktop setup install mac install octoplex homebrew octoplex can be installed using homebrew on macos or linux brew tap rfwatson octoplex brew install octoplex from github alternatively grab the latest build for your platform from the releases page unarchive the octoplex binary and copy it somewhere in your path with docker see running with docker starting octoplex octoplex can run as a single process all in one or in a client server pair mode pick this when you all in one are testing locally debugging or streaming from the same machine that runs docker e g your laptop client server want the server on a remote host e g cloud vm for long running or unattended streams all in one octoplex run starts the octoplex server and the terminal ui in one process docker must be running on the same machine client server start the server on the host that has docker octoplex server start connect the interactive tui client from your laptop or any host octoplex client start host my remotehost com if on a different host client start is a lightweight tui and does not need docker to be installed stop the server and clean up any docker resources on the remote host octoplex server stop interacting with octoplex command line interface cli besides the interactive tui you can also control octoplex with one off command line calls don t forget to replace placeholder strings with your own values ℹ️ tip octoplex ships with a self signed tls certificate by default when connecting remotely you ll usually need tls skip verify or k warning this disables certificate validation use only on trusted networks list destinations octoplex client destination list tls skip verify add a destination octoplex client destination add name name url rtmp_url tls skip verify make a note of the destination id that is printed to the terminal e g 036e2a81 dc85 4758 ab04 303849f35cd3 update a destination octoplex client destination update id destination_id name name url rtmp_url tls skip verify start a destination octoplex client destination start id destination_id tls skip verify stop a destination octoplex client destination stop id destination_id tls skip verify remove a destination octoplex client destination remove id destination_id tls skip verify ℹ️ tip pass force or f to remove the destination even if it s live subcommand reference subcommand description octoplex run launch both server and client in a single process octoplex server start start the octoplex server octoplex server stop stop the octoplex server octoplex server credentials reset regenerate api token and admin password and print to stdout octoplex client start start the octoplex tui client octoplex client destination list list existing destinations octoplex client destination add add a destination octoplex client destination update update a destination octoplex client destination remove remove a destination octoplex client destination start start streaming to a destination octoplex client destination stop stop streaming to a destination octoplex version print the version octoplex help print help screen server flags flag alias modes env var default description help h all show help data dir server all in one credentials octo_data_dir home local state octoplex linux or home library caches octoplex macos directory for storing persistent state and logs listen l server octo_listen 127 0 0 1 8080 listen address for non tls api and web traffic ️ must be set to a valid ip address to receive connections from other hosts use 0 0 0 0 8080 to bind to all network interfaces pass none to disable entirely listen tls a server octo_listen_tls 127 0 0 1 8443 listen address for tls api and web traffic ️ must be set to a valid ip address to receive connections from other hosts use 0 0 0 0 8443 to bind to all network interfaces pass none to disable entirely server url u server octo_server_url http localhost 8080 the public address of the server including protocol hostname and port if necessary web w server octo_web true enable web server auth server octo_auth auto authentication mode for clients one of none auto and token see security insecure allow no auth server octo_insecure_allow_no_auth false allow auth none when bound to non local addresses see security tls cert server all in one octo_tls_cert path to custom tls certifcate pem encoded must be valid for hostname used for grpc rtmps and rtsps connections tls key server all in one octo_tls_key path to custom tls key pem encoded must be valid for hostname used for grpc rtmps and rtsps connections docker host server octo_docker_host optional the docker host to connect to e g ssh user host 2375 if not set falls back to the docker sdk s docker_host environment variable or the default unix socket stream key server all in one octo_stream_key live stream key e g rtmp rtmp example com live rtmp enabled server all in one true enable rtmp server rtmp listen server all in one 127 0 0 1 1935 listen address for rtmp sources ️ must be set to a valid ip address to receive connections from other hosts see listen rtmps enabled server all in one true enable rtmps server rtmps listen server all in one 127 0 0 1 1936 listen address for rtmps sources ️ must be set to a valid ip address to receive connections from other hosts see listen rtsp enabled server all in one false enable rtsp server rtsp listen server all in one 127 0 0 1 8554 listen address for rtsp sources ️ must be set to a valid ip address to receive connections from other hosts see listen rtsps enabled server all in one false enable rtsps server rtsps listen server all in one 127 0 0 1 8332 listen address for rtsps sources ️ must be set to a valid ip address to receive connections from other hosts see listen image name mediamtx server all in one octo_image_name_mediamtx ghcr io rfwatson mediamtx alpine latest oci compatible image for launching mediamtx image name ffmpeg server all in one octo_image_name_ffmpeg ghcr io jrottenberg ffmpeg 7 1 scratch oci compatible image for launching ffmpeg log to file server all in one octo_log_to_file false log to a file instead stderr log file server all in one octo_log_file path to a log file to write implies log to file log level server all in one octo_log_level info log level one of debug info warn or error client flags flag alias default description help h show help host h localhost 8443 remote octoplex server to connect to tls skip verify k false skip tls certificate verification insecure api token t api token see security log file path to log file log level info log level one of debug info warn or error all in one mode ℹ️ when running in all in one mode octoplex run some flags may be overridden or unavailable web interface octoplex provides a built in web interface that allows you to manage your live streams from any browser ℹ️ note the web interface is enabled by default to disable it launch octoplex with octoplex server start web false the web interface is served from your server url by default this is http localhost 8080 or https localhost 8443 and can be configured to a custom url with the server url flag or octo_server_url environment variable see server flags for more details security read this section before putting octoplex on any network you don t fully control authentication octoplex automatically protects its internal api and web interface whenever it binds to anything other than localhost ℹ️ tip octoplex never requires authentication in all in mode mode octoplex run which is designed for quick secure local testing when you run octoplex server start auth auto the default if the api is bound only to localhost loopback addresses octoplex requires no authentication if it s bound to any other network interface then both the web interface and api require authentication see admin password and api tokens auth token always require authentication even on loopback auth none disable authentication completely but only for localhost binds if you set auth none with any non loopback api listen addresses you must also pass insecure allow no auth to acknowledge the risk otherwise the server refuses to start admin password and api tokens the first time octoplex server starts with authentication enabled it generates and securely stores an admin password for accessing the web interface an api token for the terminal ui and cli they are both printed to the logs exactly once on first startup after this you won t be able to retrieve them again but you can regenerate them octoplex server credentials reset add data dir your_data_dir if needed api_token foo admin_password bar server url when serving octoplex from a non localhost domain the s...
|
