pion/awesome-pion

A curated list of awesome things related to Pion

Awesome Pion

A curated list of awesome things related to Pion

• Resources
  • Community
  • Examples
  • Deployments
  • Tools
  • Talks
• Projects Using Pion
  • Media API
  • DataChannel
  • Other APIs
• Companies Using Pion

Resources

Community

• Official Website
• Official Api GoDoc
• Official FAQ
• Official Slack Channel
• Official Mailing List

Examples

• Official example applications
• Full featured examples that use 3rd party libraries

Deployments

• ion-sfu

Tools

• gavv/webrtc-cli
• proemergotech/chrome-webrtc-packet-log-parser

Talks

• CommCon 2020
• Go Time Podcast
• PNW Remote Go Meetup
• WebRTC Live
• KrankyGeek 2019
• Programming Throwdown
• GopherCon 2019
• CommCon 2019
• AllThingsRTC 2019
• Seattle Video Tech 2018

Projects Using Pion

Media API

• ashellunts/ffmpeg-to-webrtc - Stream video from ffmpeg to web(rtc)
• Ragnar-H/TelloGo - Tello on the web via WebRTC
• deepch/RTSPtoWebRTC - RTSP to WebRTC using Pion WebRTC
• giongto35/cloud-game - Web-based Cloud Gaming service for Retro Games
• kdevb0x/quikface - Cross platform video chat
• machinesworking/myhome - Home grown security system
• dialup-inc/ascii - ASCII Roulette :: ascii art video chat on the cli
• pion/ion - Real-Distributed RTC System with pure Go and Flutter
• pion/rtwatch - Watch videos with friends using WebRTC
• pion/webrtc-voicemail - Create voicemails via WebRTC and Transcribe them.
• porjo/babelcast - A WebRTC audio broadcast server
• porjo/mumblet - Web-based Mumble client
• rviscarra/webrtc-remote-screen - Stream a remote desktop screen directly to your browser
• rviscarra/webrtc-speech-to-text - Speech transcription on the browser using WebRTC and Google Speech
• ~tslocum/harmony - Voice and text communications platform
• nurdism/neko - A self hosted virtual browser (rabb.it clone) that runs in docker.
• fletcherist/webrtc-voice-chat - Group voice chat
• mornin.fm - Instant audio conferencing service
• oliverpool/tello-webrtc-fpv - Tello drone control using WebRTC
• peer-calls/peer-calls - a video conferencing solution. Version 4 ships with a complete server rewrite in Go and the built-in Selective Forwarding Unit is powered by pion/webrtc's Media API. See it live at peercalls.com/beta.
• Galène - Videoconferencing server
• mzyy94/ns-remote - Play Nintendo Switch anyware
• Monibuca/plugin-webrtc - WebRTC plugin for Monibuca
• hakobera/go-ayame - Client library for WebRTC Signaling Server with Ayame
• MixinNetwork/kraken - High performance WebRTC SFU
• pion/rtsp-bench - RTSP -> WebRTC Server that generates a CPU Usage report
• screego - Screen sharing for developers
• Hexcord (mediaserver) - A mediaserver for forwarding WebRTC streams to an RTMP endpoint using ffmpeg
• Kerberos.io - Scalable video analytics and video management platform
• GRVYDEV/Project-Lightspeed - A self contained OBS -> FTL -> WebRTC live streaming server
• giongto35/cloud-morph - Decentralized self-hosted Cloud Gaming
• ReolinkCameraAPI/reolinkapigo - Reolink camera api in Go
• ahamlinman/hypcast - A web-based multi-party live television streamer
• sean-der/rtmp-to-webrtc - A RTMP server that publishes to WebRTC
• zyberzero/secure-videoconference - Video conference system where the user is identified by Bank ID
• sethkimmel3/roundtable.audio - Web app for hosting live, moderator-decentralized audio chat
• manishiitg/ion-sfu-actions - Useful utilites with ion-sdk-go on ion-sfu
• livekit/livekit-server - Scalable WebRTC SFU with native clients
• roboportal - Customizable robot control with onboard video streaming
• snapp-incubator/ghodrat - WebRTC media server stress testing tool
• sean-der/pion-ulaw-player - Send ulaw encoded audio from Pion to a WebRTC client in the browser

DataChannel

• Antonito/gfile - Direct file transfer over WebRTC
• ailabstw/webrtc-socket-proxy - Peer-to-peer TCP socket proxy using WebRTC
• cretz/webrtc-ipfs-signaling - Tech demo using JS-IPFS to do signaling for WebRTC
• decentraland/webrtc-broker - WebRTC message broker
• keroserene/snowflake - Pluggable Transport using WebRTC
• libp2p/go-libp2p-webrtc-direct - Browser-to-server, and server-to-server, direct communication over WebRTC without requiring signalling servers
• maxmcd/webtty - Share a terminal session over WebRTC
• nobonobo/ssh-p2p - SSH p2p tunneling server and client
• peterq/pan-light - Network disk client
• rtctunnel/rtctunnel - Network tunnels over WebRTC
• takutakahashi/wg-connect - Wireguard connect server using UDP hole punching
• anacrolix/torrent - Full-featured BitTorrent client package and utilities
• saljam/webwormhole - Peer authenticated WebRTC
• peer-calls/peer-calls - Video conferencing solution. Version 4 ships with a complete server rewrite in Go. Chat messages and file sharing is powered by pion/webrtc's DataChannel API when the SFU is enabled. See it live here.
• mosaicnetworks/babble - Distributed Consensus Middleware
• jsmouret/grpc-over-webrtc - gRPC over WebRTC
• termbacktime/termbacktime - Terminal recording and playback
• duality-solutions/web-bridge - Connecting HTTP servers and clients on disparate networks using WebRTC and blockchain signaling
• CortexFoundation/CortexTheseus - AI on Blockchain, Official Golang implementation
• tmitchel/workspace-sync - Tool that allows you to write code in one place and automatically keep a remote copy of the code in sync
• atotto/mibot - Home Rover Robot control
• levpaul/gecserv - UDP game server for an action MMO
• emiraganov/sharef - Sharef command line tool for sending streaming files
• muka/peerjs-go - PeerJS port to Go. Enables simple p2p via HTTP comms between web browser and IoT apps.
• snaka/go-whatsmyip - Discover your public IP address
• tuzig/webexec - WebRTC server for executing command over pseudo tty and piping it’s stdin & out over data channels
• sean-der/pion-webrtc-shared-socket - Use Pion WebRTC with a shared socket. Allows non-WebRTC and WebRTC over the same socket.
• szpnygo/gtc - gtc is a terminal chat app, using pion WebRTC datachannel.
• PiterWeb/RemoteController - Steam RemotePlay Alternative powered by P2P and the Web

Other APIs

• aler9/rtsp-simple-server - Ready-to-use RTSP / RTMP / LL-HLS server and proxy that allows to read, publish and proxy video and audio streams
• netbirdio/netbird - A Wireguard-based VPN which transports datagrams over an pion/ice connection.
• stv0g/cunicu - Another Wireguard-based VPN which transports datagrams over an pion/ice connection.
• l7mp/stunner - A Kubernetes ingress gateway for WebRTC.

Companies Using Pion

• snapp!
• 0x
• Cortex Labs
• Decentraland
• Duality Blockchain Solutions
• Fox.ONE
• Headroom
• InterPlanetary File System
• Kerberos.io
• L7mp Technologies
• LiveKit
• Mosaic Networks
• Muxable
• Neverinstall
• Piepacker
• RemoteMonster
• RingCentral
• Tandem
• Yous
• 100ms
• Carnegie Robotics LLC
• Softvelum

Contribute

Contributions welcome! Read the contribution guidelines first.

License

To the extent possible under law, Pion has waived all copyright and related or neighboring rights to this work.

awesome-pion's Issues

Create rules for projects in the list

@xsbchen what do you think of creating rules for projects in the list?

I think it would be nice to say Projects must be on the latest major version of Pion WebRTC, if they are not maybe we can mark them? It could be a good opportunity for others to help update the projects!

Add wiretrustee

Connect your devices into a single secure private WireGuard®-based mesh network.

Wiretrustee is using pion/ice to interconnect NAT-ed Wireguard peers.

• Website: https://wiretrustee.com/
• Repo: https://github.com/wiretrustee/wiretrustee

pion-http-proxy (p2p REST/JSON/GRPC over WebRTC)

Summary

There are a lot of use cases for easy p2p communication between browser and edge devices. Most stemming from giving users ultimate privacy and control over their own data. Breaking free of big brother cloud providers that offer convenient collection and "care" of user data.

There are many http client and server libraries, a vast body of knowledge and established best practices (e.g REST, JSON, GRPC) over HTTP(1,2,websockets). Implementations are available for most OS platforms and languages. However there is currently no well established project that solves the combination of the two issues: easy p2p over http APIs.

Developers looking to build web browser supported p2p APIs have to dive deep and master the complicated, unfamiliar, low level WebRTC APIs that are also hard to debug and test.

Motivation

A number of projects in the awesome-pion section approach this problem from slightly different perspectives.
https://github.com/jsmouret/grpc-over-webrtc
https://github.com/duality-solutions/web-bridge
https://github.com/rtctunnel/rtctunnel
https://github.com/keroserene/snowflake
https://github.com/decentraland/webrtc-broker
https://github.com/ailabstw/webrtc-socket-proxy
https://github.com/muka/peerjs-go

Maybe it's worth having a community conversation on joining forces for a minimum viable foundation for http over webrtc that enables other higher level solutions to be built on top.

There are two big sub-topics to cover:

1. Signaling
2. Message payload

Signaling

It seems like there is a potential to have a highly available community supported global p2p signaling network of servers.

For example for Ambianic.ai, we rely on the incredibly simple and powerful PeerJS Server that provides an ephemeral, privacy preserving, easy to scale, easy to maintain and extend foundation. We added a peer-room plugin for LAN peer discovery, which solves our use case allowing browser apps to discover and connect to other browser apps or IoT devices on the same WiFi/LAN. The idea and implementation was inspired ShareDrop. More on our particular use case and solution here.

The PeerJS Server deployment has had no unscheduled downtime in 2020 and was last patched over 6 months ago. It's been that reliable, useful and stable.

There are well known community networks for torrents , Tor, Matrix and blockchain support. It only makes sense to have one that has the minimal viable protocol for p2p connectivity that makes no assumptions about how peers will exchange messages once they connect. Nor should it make assumptions about what type of messages will be exchanged.

There is also a growing set of independently maintained public STUN servers, which is the other critical missing piece for p2p comms.

Here is a strawman for a minimal signaling server functionality:

1. Allow peers to register with a crypto safe PeerID (maybe uuid4)
2. Ephemeral (memory or cached) storage for registered peers that expires after a minute unless a peer renews its registration.
3. Allows a peers to send/receive RTC invite/response to/from another peer.

That's essentially what PeerJS Server does today. It has a plug-in architecture that allows higher level signaling protocols to be built on top. Similarly to STUN servers, PeerJS Servers are standalone and can be deployed for a private p2p network or shared with the community for public access.

Can we designate PeerJS Server as the minimum signaling server reference implementation or we need to design something different?

HTTP over WebRTC Payload Format

This problem can be split into stages:

1. Chunking HTTP/1 request and response payloads into pieces that safely travel over webrtc messages between all recent browser end points and pion. This would solve the vast majority of HTTP API use cases (REST, JSON, GRPC).
2. Emulate WebSockets sessions.
3. Emulate HTTP/2 pub/sub notifications.
4. Other protocol mappings as needed.

An initial primitive implementation for stage 1 on the browser side is available here. A corresponding http-over-webrtc-proxy implementation is available here (in Python).

Describe alternatives you've considered

There a few other OSS projects that have overlapping goals, but broader scope.

libp2p (an IPFS sub-project) has a webrtc subgroup with http over webrtc layer.

• https://github.com/libp2p/js-libp2p-webrtc-star
• https://github.com/libp2p/go-libp2p-http

The Matrix team is experimenting with p2p comms over http with browser support:

• https://matrix.org/blog/2020/06/02/introducing-p-2-p-matrix

go-radio is not available

The link https://github.com/go-radio/go-radio returns 404 error