https://github.com/abiriadev/relay-ws
:arrows_counterclockwise: Simple and minimalistic WebRTC signalling server based on WebSocket.
https://github.com/abiriadev/relay-ws
signalling-server webrtc webrtc-signaling
Last synced: 4 months ago
JSON representation
:arrows_counterclockwise: Simple and minimalistic WebRTC signalling server based on WebSocket.
- Host: GitHub
- URL: https://github.com/abiriadev/relay-ws
- Owner: abiriadev
- Created: 2023-05-15T08:07:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T23:05:01.000Z (over 1 year ago)
- Last Synced: 2025-12-13T03:46:37.028Z (6 months ago)
- Topics: signalling-server, webrtc, webrtc-signaling
- Language: TypeScript
- Homepage:
- Size: 106 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Relay-WS
> [!WARNING]\
> This project is neither stable nor actively developed.
Simple and minimalistic WebRTC signalling server based on
WebSocket.
## How to use
### Docker
```sh
$ docker buildx build -t -o type=docker .
$ docker run -dp 34098:34098
```
### Docker Compose
```sh
$ docker compose up -d
```
### Build manually
```sh
$ corepack enable
$ pnpm install
$ pnpm build
$ pnpm run start
```
## How relay server works
```mermaid
sequenceDiagram
autonumber
actor pc1 as Peer 1
participant sig as Relay Server
actor pc2 as Peer 2
pc1->>sig: Peer 1 Join
Note over sig: Assign Unique ID for Peer 1:
pc1->>+sig: type: ls
sig--)-pc1: peers: []
pc2->>sig: Peer 2 Join
Note over sig: Assign Unique ID for Peer 2:
pc2->>+sig: type: ls
sig--)-pc2: peers: []
pc2->>+sig: type: offer, to:
sig--)-pc1: type: offer, from:
pc1->>+sig: type: answer, to:
sig--)-pc2: type: answer, from:
loop ICE Candidate Exchange
par Candidate from Peer 1
pc1->>+sig: type: ice, to:
sig--)-pc2: type: ice, from:
and Candidate from Peer 2
pc2->>+sig: type: ice, to:
sig--)-pc1: type: ice, from:
end
end
pc1-->>+sig: type: leave
Note over pc1: Peer 1 exits
par Broadcase
sig--)-pc2: type: leave, from:
end
pc2-->>sig: type: leave
Note over pc2: Peer 2 exits
```
## Message table
### List
#### Request
| Name | Type |
| ---- | ------ |
| type | `"ls"` |
#### Response
| Name | Type |
| ----- | ------ |
| type | `"ls"` |
| peers | `ID[]` |
### Leave
#### Request
| Name | Type |
| ---- | --------- |
| type | `"leave"` |
#### Response
| Name | Type |
| ---- | --------- |
| type | `"leave"` |
| from | `ID` |
### Offer
#### Request
| Name | Type |
| ---- | --------- |
| type | `"offer"` |
| to | `ID` |
| sdp | `string` |
#### Response
| Name | Type |
| ---- | --------- |
| type | `"offer"` |
| from | `ID` |
| to | `ID` |
| sdp | `string` |
### Answer
#### Request
| Name | Type |
| ---- | --------- |
| type | `"answer"` |
| to | `ID` |
| sdp | `string` |
#### Response
| Name | Type |
| ---- | --------- |
| type | `"answer"` |
| from | `ID` |
| to | `ID` |
| sdp | `string` |
### ICE candidate
#### Request
| Name | Type |
| ---- | --------- |
| type | `"ice"` |
| to | `ID` |
| sdp | `string` |
#### Response
| Name | Type |
| ---- | --------- |
| type | `"ice"` |
| from | `ID` |
| to | `ID` |
| sdp | `string` |