https://github.com/revoltchat/vortex

(in development) Pluggable WebRTC Voice Server
https://github.com/revoltchat/vortex

revolt rust voice webrtc webrtc-rs

Last synced: 3 months ago
JSON representation

(in development) Pluggable WebRTC Voice Server

• Host: GitHub
• URL: https://github.com/revoltchat/vortex
• Owner: revoltchat
• License: agpl-3.0
• Created: 2021-08-06T14:38:14.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-28T13:38:01.000Z (7 months ago)
• Last Synced: 2024-06-06T23:43:36.911Z (5 months ago)
• Topics: revolt, rust, voice, webrtc, webrtc-rs
• Language: Rust
• Homepage:
• Size: 184 KB
• Stars: 113
• Watchers: 9
• Forks: 37
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - revoltchat/vortex - (in development) Pluggable WebRTC Voice Server (Rust)

README

        
# DEPRECATED, rewrite on [new branch](https://github.com/revoltchat/vortex/tree/vortex)

Please do not use Vortex in any capacity until the rewrite is complete, you will not receive any support for the current version and the new version is heavy in development.

# Revolt Vortex

## Description

The voice server for Revolt.

## Stack

- [Rust](https://www.rust-lang.org/)

- [Mediasoup](https://mediasoup.org/)

- [Warp](https://github.com/seanmonstar/warp) (HTTP)

## Resources

### Vortex

- [Vortex Issue Board](https://github.com/revoltchat/vortex/issues)

### Revolt

- [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests here)

- [Revolt Testers Server](https://app.revolt.chat/invite/Testers)

- [Contribution Guide](https://developers.revolt.chat/contributing)

## Quick Start

Get Vortex up and running locally for development.

```py

git clone https://github.com/revoltchat/vortex

cd vortex

cargo build

# Set the environment variables as described below

cargo run

```

## Environment Variables

| Variable       | Description                                                                                                                           | Example                          |

| -------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |

| `HTTP_HOST`    | The hostname to bind to.                                                                                                              | `0.0.0.0:8080` (default)         |

| `WS_URL`       | The websocket URL to advertise.                                                                                                       | `wss://vortex.revolt.chat`       |

| `MANAGE_TOKEN` | The token used for communication between Vortex and Delta.                                                                            | ``                        |

| `RTC_MIN_PORT` | The minimum port to use for WebRTC and RTP.                                                                                           | `10000` (default)                |

| `RTC_MAX_PORT` | The maximum port to use for WebRTC and RTP.                                                                                           | `11000` (default)                |

| `DISABLE_RTP`  | Disable RTP. The value `1` disables RTP, all other values or not set will enable RTP.                                                 | `0` (default)                    |

| `RTC_IPS`      | Semicolon separated list of IPs to use for WebRTC. Hostnames are not supported yet. Either combined or split listen and announce IPs. | `;,` |

## CLI Commands

| Command       | Description           |

| ------------- | --------------------- |

| `cargo build` | Build/compile Vortex. |

| `cargo run`   | Run Vortex.           |

## License

Vortex is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/vortex/blob/master/LICENSE).