Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brevent/wss-plugin
SIP003 plugin for shadowsocks, based on WebSocket.
https://github.com/brevent/wss-plugin
shadowsocks sip003
Last synced: about 2 months ago
JSON representation
SIP003 plugin for shadowsocks, based on WebSocket.
- Host: GitHub
- URL: https://github.com/brevent/wss-plugin
- Owner: brevent
- License: mit
- Created: 2024-02-25T02:03:05.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-09T07:01:28.000Z (10 months ago)
- Last Synced: 2024-03-09T18:58:50.770Z (10 months ago)
- Topics: shadowsocks, sip003
- Language: C
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SIP003 plugin for shadowsocks, based on WebSocket.
## Build
### install `libwebsockets` 3.2.0+, recommend latest stable
Refer [libwebsockets](https://github.com/warmcat/libwebsockets).
### build
```bash
cmake -B build
cmake --build build
```
## Usage
### Client
`ss-local -c xxx.json`
```json
{
"server": "xxx",
"server_port": 443,
"method": "none",
"local_address": "0.0.0.0",
"local_port": 1080,
"plugin": "/path/to/wss-plugin-client",
"plugin_opts": "tls;host=xxx;path=/xxx;mux=0"
}
```
### Server
There is unnecessary to specify `tls`, `host`, `path`:
- `tls`, use behind nginx, plugin server doesn't support tls.
- `host`, use behind nginx, plugin server support any host.
- `path`, use behind nginx, plugin server support any path.
```json
{
"server":"127.0.0.1",
"server_port":3448,
"timeout":60,
"method":"none",
"plugin": "/path/to/wss-plugin-server",
"plugin_opts": "mux=0"
}
```
### Compatible
Should compatible with `mux=0` with [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin/).