{"id":20911646,"url":"https://github.com/brevent/wss-plugin","last_synced_at":"2025-05-13T07:32:24.647Z","repository":{"id":224283668,"uuid":"762899751","full_name":"brevent/wss-plugin","owner":"brevent","description":"SIP003 plugin for shadowsocks, based on WebSocket.","archived":true,"fork":false,"pushed_at":"2024-03-09T07:01:28.000Z","size":33,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T22:24:18.088Z","etag":null,"topics":["shadowsocks","sip003"],"latest_commit_sha":null,"homepage":"","language":"C","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/brevent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-02-25T02:03:05.000Z","updated_at":"2024-03-12T15:00:58.000Z","dependencies_parsed_at":"2024-11-18T14:25:56.636Z","dependency_job_id":"b9de7f96-5ad7-44ef-9ec7-5a30bb0d41dd","html_url":"https://github.com/brevent/wss-plugin","commit_stats":null,"previous_names":["brevent/wss-plugin"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brevent","download_url":"https://codeload.github.com/brevent/wss-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253894916,"owners_count":21980420,"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":["shadowsocks","sip003"],"created_at":"2024-11-18T14:23:08.683Z","updated_at":"2025-05-13T07:32:24.432Z","avatar_url":"https://github.com/brevent.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"SIP003 plugin for shadowsocks, based on WebSocket.\n\n## Build\n\n### install `libwebsockets` 3.2.0+, recommend latest stable\n\nRefer [libwebsockets](https://github.com/warmcat/libwebsockets).\n\n### build\n\n```bash\ncmake -B build\ncmake --build build\n```\n\n## Usage\n\n### Client\n\n`ss-local -c xxx.json`\n\n```json\n{\n  \"server\": \"xxx\",\n  \"server_port\": 443,\n  \"method\": \"none\",\n  \"local_address\": \"0.0.0.0\",\n  \"local_port\": 1080,\n  \"plugin\": \"/path/to/wss-plugin-client\",\n  \"plugin_opts\": \"tls;host=xxx;path=/xxx;mux=0\"\n}\n```\n\n### Server\n\nThere is unnecessary to specify `tls`, `host`, `path`:\n- `tls`, use behind nginx, plugin server doesn't support tls.\n- `host`, use behind nginx, plugin server support any host.\n- `path`, use behind nginx, plugin server support any path.\n\n```json\n{\n    \"server\":\"127.0.0.1\",\n    \"server_port\":3448,\n    \"timeout\":60,\n    \"method\":\"none\",\n    \"plugin\": \"/path/to/wss-plugin-server\",\n    \"plugin_opts\": \"mux=0\"\n}\n```\n\n### Compatible\n\nShould compatible with `mux=0` with [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrevent%2Fwss-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrevent%2Fwss-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrevent%2Fwss-plugin/lists"}