# ion

**Repository Path**: swzw/ion

## Basic Information

- **Project Name**: ion
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-06-16
- **Last Updated**: 2021-12-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


<div align=left><a href="https://github.com/pion/ion/wiki">
    <img src="https://github.com/pion/ion/raw/master/docs/imgs/ion.png" width = 15% align = "left">
</a>

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

![MIT](https://img.shields.io/badge/License-MIT-yellow.svg)[![Build Status](https://travis-ci.com/pion/ion.svg?branch=master)](https://travis-ci.com/pion/ion)[![Go Report Card](https://goreportcard.com/badge/github.com/pion/ion)![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/pion/ion)![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/pion/ion?include_prereleases)](https://goreportcard.com/report/github.com/pion/ion)![Docker Pulls](https://img.shields.io/docker/pulls/pionwebrtc/ion-biz?style=plastic)[![Financial Contributors on Open Collective](https://opencollective.com/pion-ion/all/badge.svg?label=financial+contributors)](https://opencollective.com/pion-ion) ![GitHub contributors](https://img.shields.io/github/contributors-anon/pion/ion)![Twitter Follow](https://img.shields.io/twitter/follow/_PION?style=social)[![slack](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://pion.ly/slack)

<br />

## ❤️Sponsor to help this awsome project go faster！🚀
(https://opencollective.com/pion-ion)

You can vote for feature if you are a sponsor.

Features: https://github.com/pion/ion/projects/1

## Quick-Start (*LOCALHOST ONLY*)

*NOTE:* Do not attempt to run this example on a VPS. Make sure you [read the docs](docs/production); WebRTC requires some specific network configuration for the SFU service (depending on your host), and the JavaScript `GetUserMedia()` API can only request camera access on pages with SSL (or `localhost`). If you are not running on `localhost`, you MUST configure networking for SFU and enable HTTPS for `ion-app-web`.


#### 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](https://github.com/pion/ion-app-web) 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](https://github.com/pion/ion/tree/master/docs)



## Documentation
+ [Development](docs/dev/)
    + [Quick Start](docs/dev/quick_start.md)
    + [Docker Compose](docs/dev/docker.md)
    + [Debugging](docs/dev/debugging.md)
+ [Production](docs/production/)
    + [Docker Compose](docs/production/README.md)
    + [Kubernetes](kube/README.md)
    + [Stress Test](docs/production/stress_test.md)
+ [Server](docs/server_features.md)
+ [Clients](docs/client_features.md)
+ Ion SDKs
    + [SDK - Javascript](https://github.com/pion/ion-sdk-js)
    + [SDK - Flutter](https://github.com/pion/ion-sdk-flutter)
+ Open-Source ION Clients
    + [Ion Web App](https://github.com/pion/ion-app-web)
    + [Ion Flutter App](https://github.com/pion/ion-app-flutter)
+ Other Ion Projects
    + [Ion Load Tool](https://github.com/pion/ion-load-tool)


+ [Glossary / Definitions](docs/glossary.md)
+ [Frequently Asked Questions](docs/faq.md)

## Architecture
![arch](https://github.com/pion/ion/raw/master/docs/imgs/arch.png)

## Roadmap

[Projects](https://github.com/pion/ion/projects/1)

## Maintainers

<a href="https://github.com/adwpc"><img width="60" height="60" src="https://github.com/adwpc.png?size=500"/></a><a href="https://github.com/cloudwebrtc"><img width="60" height="60" src="https://github.com/cloudwebrtc.png?size=500"/></a><a href="https://github.com/kangshaojun"><img width="60" height="60" src="https://github.com/kangshaojun.png?size=500"/></a><a href="https://github.com/tarrencev"><img width="60" height="60" src="https://github.com/tarrencev.png?size=500"/></a><a href="https://github.com/jbrady42"><img width="60" height="60" src="https://github.com/jbrady42.png?size=500"/></a><a href="https://github.com/leewardbound"><img width="60" height="60" src="https://github.com/leewardbound.png?size=500"/></a>

## Contributors

<a href="https://github.com/pion/ion/graphs/contributors"><img src="https://opencollective.com/pion-ion/contributors.svg?width=890&button=false" /></a>

*Original Author: [adwpc](https://github.com/adwpc) [cloudwebrtc](https://github.com/cloudwebrtc)*

*Community Hero: [Sean-Der](https://github.com/Sean-Der)*