README.md

ION is a distributed real-time communication system, the goal is to chat anydevice, anytime, anywhere!

Quick-Start (LOCALHOST ONLY)

NOTE: To run this example on a VPS, make sure you read the docs because WebRTC requires some open UDP ports, and ion-app-web uses LetsEncrypt, which assumes your server has a public IP with a subdomain pointed at it.

1. Run Ion Backend Services

After cloning the folder, create a docker network (we use this so ion-app-web can communicate securely with the backend):

docker network create ionnet

docker-compose up

3. Expose Ports

Ensure the ports 5000-5200/udp are exposed or forwarded for the SFU service;

4. UI (optional)

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.

For dev and more options see the wiki

• Development

Documentation

• Development

  • Quick Start
  • Docker Compose
  • Debugging

• Production

  • Docker Compose
  • Kubernetes
  • Stress Test

• Server

• Clients

• Ion SDKs

  • SDK - Javascript
  • SDK - Flutter

• Open-Source ION Clients

  • Ion Web App
  • Ion Flutter App

• Other Ion Projects

  • Ion Load Tool

• Glossary / Definitions

• Frequently Asked Questions

Architecture

Roadmap

Projects

Maintainers

Contributors

Original Author: adwpc cloudwebrtc

Community Hero: Sean-Der