{"id":16743127,"url":"https://github.com/abiriadev/relay-ws","last_synced_at":"2026-02-21T16:40:20.002Z","repository":{"id":171479832,"uuid":"640830297","full_name":"abiriadev/relay-ws","owner":"abiriadev","description":":arrows_counterclockwise: Simple and minimalistic WebRTC signalling server based on WebSocket.","archived":false,"fork":false,"pushed_at":"2024-12-09T23:05:01.000Z","size":109,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-13T03:46:37.028Z","etag":null,"topics":["signalling-server","webrtc","webrtc-signaling"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abiriadev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-15T08:07:48.000Z","updated_at":"2024-06-19T08:54:45.000Z","dependencies_parsed_at":"2025-04-12T03:45:21.862Z","dependency_job_id":null,"html_url":"https://github.com/abiriadev/relay-ws","commit_stats":null,"previous_names":["abiriadev/relay-ws"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/abiriadev/relay-ws","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abiriadev%2Frelay-ws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abiriadev%2Frelay-ws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abiriadev%2Frelay-ws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abiriadev%2Frelay-ws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abiriadev","download_url":"https://codeload.github.com/abiriadev/relay-ws/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abiriadev%2Frelay-ws/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29686798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T15:51:39.154Z","status":"ssl_error","status_checked_at":"2026-02-21T15:49:03.425Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["signalling-server","webrtc","webrtc-signaling"],"created_at":"2024-10-13T01:26:01.172Z","updated_at":"2026-02-21T16:40:19.987Z","avatar_url":"https://github.com/abiriadev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Relay-WS\n\n\u003e [!WARNING]\\\n\u003e This project is neither stable nor actively developed.\n\nSimple and minimalistic WebRTC signalling server based on\nWebSocket.\n\n## How to use\n\n### Docker\n\n```sh\n$ docker buildx build -t \u003ctag\u003e -o type=docker .\n$ docker run -dp 34098:34098 \u003ctag\u003e\n```\n\n### Docker Compose\n\n```sh\n$ docker compose up -d\n```\n\n### Build manually\n\n```sh\n$ corepack enable\n$ pnpm install\n$ pnpm build\n$ pnpm run start\n```\n\n## How relay server works\n\n```mermaid\nsequenceDiagram\n    autonumber\n    actor pc1 as Peer 1\n    participant sig as Relay Server\n    actor pc2 as Peer 2\n    pc1-\u003e\u003esig: Peer 1 Join\n    Note over sig: Assign Unique ID for Peer 1:\u003cbr\u003e\u003cpeer1\u003e\n    pc1-\u003e\u003e+sig: type: ls\n    sig--)-pc1: peers: []\n    pc2-\u003e\u003esig: Peer 2 Join\n    Note over sig: Assign Unique ID for Peer 2:\u003cbr\u003e\u003cpeer2\u003e\n    pc2-\u003e\u003e+sig: type: ls\n    sig--)-pc2: peers: [\u003cpeer1\u003e]\n    pc2-\u003e\u003e+sig: type: offer, to: \u003cpeer1\u003e\n    sig--)-pc1: type: offer, from: \u003cpeer2\u003e\n    pc1-\u003e\u003e+sig: type: answer, to: \u003cpeer2\u003e\n    sig--)-pc2: type: answer, from: \u003cpeer1\u003e\n    loop ICE Candidate Exchange\n        par Candidate from Peer 1\n            pc1-\u003e\u003e+sig: type: ice, to: \u003cpeer2\u003e\n            sig--)-pc2: type: ice, from: \u003cpeer1\u003e\n        and Candidate from Peer 2\n            pc2-\u003e\u003e+sig: type: ice, to: \u003cpeer1\u003e\n            sig--)-pc1: type: ice, from: \u003cpeer2\u003e\n        end\n    end\n    pc1--\u003e\u003e+sig: type: leave\n    Note over pc1: Peer 1 exits\n    par Broadcase\n        sig--)-pc2: type: leave, from: \u003cpeer1\u003e\n    end\n    pc2--\u003e\u003esig: type: leave\n    Note over pc2: Peer 2 exits\n```\n\n## Message table\n\n### List\n\n#### Request\n\n| Name | Type   |\n| ---- | ------ |\n| type | `\"ls\"` |\n\n#### Response\n\n| Name  | Type   |\n| ----- | ------ |\n| type  | `\"ls\"` |\n| peers | `ID[]` |\n\n### Leave\n\n#### Request\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"leave\"` |\n\n#### Response\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"leave\"` |\n| from | `ID`      |\n\n### Offer\n\n#### Request\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"offer\"` |\n| to   | `ID`      |\n| sdp  | `string`  |\n\n#### Response\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"offer\"` |\n| from | `ID`      |\n| to   | `ID`      |\n| sdp  | `string`  |\n\n### Answer\n\n#### Request\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"answer\"` |\n| to   | `ID`      |\n| sdp  | `string`  |\n\n#### Response\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"answer\"` |\n| from | `ID`      |\n| to   | `ID`      |\n| sdp  | `string`  |\n\n### ICE candidate\n\n#### Request\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"ice\"` |\n| to   | `ID`      |\n| sdp  | `string`  |\n\n#### Response\n\n| Name | Type      |\n| ---- | --------- |\n| type | `\"ice\"` |\n| from | `ID`      |\n| to   | `ID`      |\n| sdp  | `string`  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabiriadev%2Frelay-ws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabiriadev%2Frelay-ws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabiriadev%2Frelay-ws/lists"}