ion

module
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 12, 2020 License: MIT

README

ION

ION is a distributed RTC system written by pure go and flutter

Financial Contributors on Open Collective Build Status MIT slack Go Report Card

Wiki

https://github.com/pion/ion/wiki

Architecture

arch

Contributor

SDK

ion-sdk-js

ion-sdk-flutter

APP

ion-app-web

ion-app-flutter

Screenshots

iOS/Android

PC/HTML5

How to use

Docker commands require the ionnet docker network

First run:

docker network create ionnet
Deployment
1. Clone
git clone https://github.com/pion/ion
2. Setup

Firstly pull images. Skip this command if you want build images locally

docker-compose pull
3. Run
docker-compose up
4. Expose Ports

(Skip if only exposing locally)

Ensure the following ports are exposed or forwarded.

5000-5200/udp
5. Chat

Head over to Ion Web App to bring up the front end.

The web app repo also contains examples of exposing the ion biz websocket via reverse proxy with automatic SSL.

Roadmap

Projects Welcome contributing to ion!

Directories

Path Synopsis
cmd
biz command
islb command
sfu command
pkg
db
log
rtc
rtc/rtpengine/deadline
Package deadline provides deadline timer used to implement net.Conn compatible connection
Package deadline provides deadline timer used to implement net.Conn compatible connection
rtc/rtpengine/udp
Package udp provides a connection-oriented listener over a UDP PacketConn
Package udp provides a connection-oriented listener over a UDP PacketConn

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL