{"id":20032702,"url":"https://github.com/lucko/bytesocks","last_synced_at":"2025-05-05T05:30:46.899Z","repository":{"id":145746905,"uuid":"445960092","full_name":"lucko/bytesocks","owner":"lucko","description":"Fast \u0026 lightweight WebSocket server with channels.","archived":false,"fork":false,"pushed_at":"2024-04-25T21:39:33.000Z","size":78,"stargazers_count":19,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-01T21:21:27.857Z","etag":null,"topics":["websocket","websockets"],"latest_commit_sha":null,"homepage":"","language":"Java","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/lucko.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-01-09T00:34:01.000Z","updated_at":"2024-04-25T21:39:37.000Z","dependencies_parsed_at":"2024-02-29T00:26:26.785Z","dependency_job_id":"d360da84-b74e-4778-ab11-eb44606e26ba","html_url":"https://github.com/lucko/bytesocks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucko%2Fbytesocks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucko%2Fbytesocks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucko%2Fbytesocks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucko%2Fbytesocks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucko","download_url":"https://codeload.github.com/lucko/bytesocks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224426495,"owners_count":17309343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["websocket","websockets"],"created_at":"2024-11-13T09:38:52.380Z","updated_at":"2024-11-13T09:38:52.989Z","avatar_url":"https://github.com/lucko.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\t\u003cimg\n\t\talt=\"bytesocks\"\n\t\tsrc=\"https://i.imgur.com/hZy89YS.png\"\u003e\n\u003c/h1\u003e\n\n\u003ch3 align=\"center\"\u003e\n  bytesocks is a fast \u0026 lightweight WebSocket server.\n\u003c/h3\u003e\n\nIt allows clients to create \"**channels**\", connect using the WebSocket protocol and **exchange messages with other clients** in the same channel.\n\nIn many ways bytesocks is the \"socket\" sibling of [bytebin](https://github.com/lucko/bytebin). bytebin accepts http get and post requests which allows clients to exchange data asynchronously (client A posts, then client B reads later), whereas bytesocks uses sockets to send messages synchronously (in real time and bidirectionally, client A sends and client B receives).\n\n\n## Running bytesocks\n\nThe easiest way to spin up a bytesocks instance is using Docker. Images are automatically created and published to GitHub for each commit/release.\n\nAssuming you're in the bytesocks directory, just run:\n```bash\n$ docker compose up\n```\n\nYou should then (hopefully!) be able to access the application at `http://localhost:3000/`.\n\nIt's that easy!\n\n## API Usage\n\n### Create a channel\n\nTo create a channel, send an HTTP `GET` request to `/create`.\n\nA unique key that identifies the newly created channel will be returned. You can find it:\n* In the response `Location` header.\n* In the response body, encoded as JSON - `{\"key\": \"aabbcc\"}`.\n\n### Join a channel\n\nSend an HTTP `GET` request to `/{key}` with the headers:\n```\nConnection: Upgrade\nUpgrade: websocket\n```\n\nAt this stage it's probably easier to find an HTTP client library that supports web sockets instead of reimplementing the protocol yourself!\n\n## License\nMIT, have fun!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucko%2Fbytesocks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucko%2Fbytesocks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucko%2Fbytesocks/lists"}