{"id":15056622,"url":"https://github.com/brevent/wss-proxy","last_synced_at":"2025-04-10T04:33:32.161Z","repository":{"id":229648982,"uuid":"777301435","full_name":"brevent/wss-proxy","owner":"brevent","description":"WebSocket SIP003 plugin for shadowsocks, based on libevent","archived":false,"fork":false,"pushed_at":"2024-09-29T07:21:19.000Z","size":201,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T05:44:09.777Z","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":null,"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":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":"2024-03-25T15:38:25.000Z","updated_at":"2024-11-09T11:20:38.000Z","dependencies_parsed_at":"2024-04-13T09:22:36.251Z","dependency_job_id":"a4c62941-65ff-454f-8b0f-62bc73dc0461","html_url":"https://github.com/brevent/wss-proxy","commit_stats":null,"previous_names":["brevent/wss-proxy"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brevent%2Fwss-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brevent","download_url":"https://codeload.github.com/brevent/wss-proxy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248157780,"owners_count":21057064,"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-09-24T21:54:15.045Z","updated_at":"2025-04-10T04:33:32.114Z","avatar_url":"https://github.com/brevent.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"SIP003 plugin for shadowsocks, based on WebSocket.\n\n## Requirements\n\n- [libevent](https://github.com/libevent/libevent) 2.1.8-stable+\n- [OpenSSL](https://github.com/openssl/openssl) 1.1.1+ for TLS 1.3 support\n\n## Build\n\n- [CMake](https://cmake.org/) 3.16+\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-proxy-client\",\n  \"plugin_opts\": \"tls;host=xxx;path=/xxx;mux=0\"\n}\n```\n\n#### Options compatible with [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin/)\n- `tls`, `tls` for https / wss, otherwise http / ws\n- `host`, host name\n- `path`, default `/`\n- `loglevel`, default `INFO`, support `DEBUG`, `INFO`, `WARN`, `ERROR`\n- `mux`, default `1` (only `0` is supported, specify for compatible with `v2ray-plugin`)\n\n#### Options for `wss-proxy-client` only\n- `ws` (since 0.2.6, [e7b7f36](https://github.com/brevent/wss-proxy/commit/e7b7f36)), default `1` to use websocket after handshake, `0` to use raw shadowsocks after handshake\n  - don't use it if you're unsure\n- `extra-listen-port` (since 0.3.0, [689f0e7](https://github.com/brevent/wss-proxy/commit/689f0e7)), extra listen port for shadowsocks client without sip003u\n- `syslog` (since 0.3.3, [47d4681](https://github.com/brevent/wss-proxy/commit/47d4681)), log to syslog if supported\n- `ipv6` (since 0.3.4, [a8b5f71](https://github.com/brevent/wss-proxy/commit/a8b5f71)), prefer ipv6 (should fallback to ipv4 if no ipv6)\n- `http2` (since 0.4.0, WebSocket over HTTP/2, [RFC 8441](https://datatracker.ietf.org/doc/html/rfc8441))\n- `http3` (since 0.4.0, WebSocket over HTTP/3, [RFC 9220](https://datatracker.ietf.org/doc/html/rfc9220))\n\n### Server\n\n`ss-server -c xxx.json`\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-proxy-server\",\n    \"plugin_opts\": \"mux=0\"\n}\n```\n\n#### Options compatible with [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin/)\n- `loglevel`, default `INFO`, support `DEBUG`, `INFO`, `WARN`, `ERROR`\n- `mux`, default `1` (only `0` is supported, specify for compatible with `v2ray-plugin`)\n\nUnsupported options:\n- `tls`, use behind nginx, plugin server doesn't use tls.\n- `host`, use behind nginx, plugin server support any host.\n- `path`, use behind nginx, plugin server support any path.\n\n#### Options for `wss-proxy-server` only\n- `udp-port`, udp port to shadowsocks server without sip003u\n  - There is no `tcp-port`, which is environment `SS_LOCAL_PORT`.\n- `syslog` (since 0.3.3, [47d4681](https://github.com/brevent/wss-proxy/commit/47d4681)), log to syslog if supported\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrevent%2Fwss-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrevent%2Fwss-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrevent%2Fwss-proxy/lists"}