feat: add WebSocket support to the existing outline-ss-server
#225
Conversation
| - type: websocket | ||
| address: "[::]:8000" | ||
| options: | ||
| # TCP over WebSocket | ||
| - path: "/tcp" | ||
| connection_type: "stream" | ||
| # UDP over WebSocket | ||
| - path: "/udp" | ||
| connection_type: "packet" |
There was a problem hiding this comment.
I think something like this would be cleaner:
| - type: websocket | |
| address: "[::]:8000" | |
| options: | |
| # TCP over WebSocket | |
| - path: "/tcp" | |
| connection_type: "stream" | |
| # UDP over WebSocket | |
| - path: "/udp" | |
| connection_type: "packet" | |
| - type: websocket-stream | |
| web_server: main_web_server | |
| path: "/tcp" | |
| - type: websocket-packet | |
| web_server: main_web_server | |
| path: "/udp" | |
| ... | |
| web_servers: | |
| - id: main_web_server | |
| listen: | |
| - "[::]:8000" |
Also, this gives us a way to configure the web server as needed.
BTW, we can also add a way to configure the metrics to be exposed on one of the configured web_servers.
There was a problem hiding this comment.
I was playing around with this after we brainstormed about this offline. I was going to add another layer here though, so that we leave room to add configuration that applies to all web servers.
web:
servers:
- id: my_web_server
listen: ...
| @@ -339,6 +408,30 @@ func RunOutlineServer(filename string, natTimeout time.Duration, serverMetrics * | |||
| return server, nil | |||
| } | |||
|
|
|||
| // wrappedConn overrides [websocket.Conn]'s remote address handling. | |||
| type wrappedConn struct { | |||
There was a problem hiding this comment.
I think it will be beneficial to get rid of this kind of wrapping and create some sort of ClientConnection struct with ClientAddr and Conn. The handler could take that instead. The way we do wrapping is a pain and potentially remove ReadFrom/WriteTo optimizations.
There was a problem hiding this comment.
Ack. If it's ok with you I'd like to do that in a follow-up PR to keep the changes smaller. I've added add a TODO here.
This PR enables Shadowsocks-over-WebSockets functionality in the existing v1 server, allowing clients to connect to Shadowsocks via WebSockets.
This is the counterpart to the Caddy-backed v2 version introduced in #216.