{"id":15199894,"url":"https://github.com/touchdeck/websocket-proxy","last_synced_at":"2026-02-03T17:35:35.888Z","repository":{"id":54625173,"uuid":"322715528","full_name":"TouchDeck/websocket-proxy","owner":"TouchDeck","description":"A websocket proxy with local discovery for piping data between two clients.","archived":false,"fork":false,"pushed_at":"2021-02-07T15:14:26.000Z","size":98,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-23T08:49:08.742Z","etag":null,"topics":["docker-image","proxy","server","websocket","websocket-proxy"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/lucascorpion/websocket-proxy","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TouchDeck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-18T22:10:35.000Z","updated_at":"2023-11-23T10:35:05.000Z","dependencies_parsed_at":"2022-08-13T22:00:14.782Z","dependency_job_id":null,"html_url":"https://github.com/TouchDeck/websocket-proxy","commit_stats":null,"previous_names":["touchdeck/websocket-tcp-proxy","touchdeck/tcp-proxy"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/TouchDeck/websocket-proxy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TouchDeck%2Fwebsocket-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TouchDeck%2Fwebsocket-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TouchDeck%2Fwebsocket-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TouchDeck%2Fwebsocket-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TouchDeck","download_url":"https://codeload.github.com/TouchDeck/websocket-proxy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TouchDeck%2Fwebsocket-proxy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29050932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T15:43:47.601Z","status":"ssl_error","status_checked_at":"2026-02-03T15:43:46.709Z","response_time":96,"last_error":"SSL_read: 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":["docker-image","proxy","server","websocket","websocket-proxy"],"created_at":"2024-09-28T02:20:33.357Z","updated_at":"2026-02-03T17:35:35.866Z","avatar_url":"https://github.com/TouchDeck.png","language":"Go","readme":"# Websocket Proxy\n\n[![Docker Image Version](https://img.shields.io/docker/v/lucascorpion/websocket-proxy?sort=semver)](https://hub.docker.com/r/lucascorpion/websocket-proxy)\n[![Docker Image Size](https://img.shields.io/docker/image-size/lucascorpion/websocket-proxy?sort=semver)](https://hub.docker.com/r/lucascorpion/websocket-proxy)\n[![Docker Pulls](https://img.shields.io/docker/pulls/lucascorpion/websocket-proxy)](https://hub.docker.com/r/lucascorpion/websocket-proxy)\n\nA websocket proxy with local discovery for piping data between two clients.\n\nThe proxy differentiates between two kinds of clients: agents and remotes. Agents are clients that listen for messages, and optionally reply to them. Remotes are clients that want to connect to an agent.\n\n## API\n\n### `/agents`\n\nA discovery endpoint which lists all agents in the local network (based on the request's public IP address).\n\n### `/ws/agent` and `/ws/remote`\n\nThe websocket endpoints for the agent and remote clients, respectively.\n\n## Websocket Protocol\n\n### Agent\n\nAfter connecting, the agent should send a message with a JSON object. This object can contain a `meta` field with freeform metadata about the agent. For example:\n\n```json\n{\n  \"meta\": {\n    \"version\": \"1.0.0\",\n    \"platform\": \"linux\"\n  }\n}\n```\n\nThe proxy will then assign a unique id to this agent, which remotes can use to identify it. It will send the full agent object back to the agent:\n\n```json\n{\n  \"id\": \"4cab7bec-dfc2-48a9-a8c9-406118b4242f\",\n  \"meta\": {\n    \"version\": \"1.0.0\",\n    \"platform\": \"linux\"\n  }\n}\n```\n\n### Remote\n\nAfter connecting, the agent should send a message with a JSON object. This object should contain an `id` field with the id of the agent to connect to. For example:\n\n```json\n{\n  \"id\": \"4cab7bec-dfc2-48a9-a8c9-406118b4242f\"\n}\n```\n\n### Diagram\n\n![Sequence diagram](docs/sequence.jpg)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftouchdeck%2Fwebsocket-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftouchdeck%2Fwebsocket-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftouchdeck%2Fwebsocket-proxy/lists"}