opensocks

README

OpenSocks

OpenSocks is a socks5 server over websocket,it helps you break the wall and see the world.

Features

• Support for the CONNECT command
• Support for the ASSOCIATE command
• Support nginx/caddy/cloudflare cdn for reverse proxy
• Websocket for the transport layer

Flow chart

Apps--->opensocks-client--->reverse proxy--->opensocks-server--->real server

Usage

Cmd

Usage of ./opensocks:
  -S	server mode
  -l string
    	local address (default "0.0.0.0:1080")
  -p string
    	password (default "pass@123456")
  -s string
    	server address (default "0.0.0.0:8081")
  -u string
    	username (default "admin")
  -wss
    	wss/ws scheme (default true)
  -bypass
    	bypass private ip (default true)

Docker

Run client

docker run -d --restart=always  --network=host \
--name opensocks-client netbyte/opensocks -s=YOUR_DOMIAN:443

Run server

docker run  -d --restart=always --net=host \
--name opensocks-server netbyte/opensocks -S

Run caddy for reverse proxy

docker run -d --restart=always --network=host \
-v /data/caddy/Caddyfile:/etc/Caddyfile \
-v /data/caddy/.caddy:/root/.caddy \
-e ACME_AGREE=true --name caddy abiosoft/caddy

Config Caddyfile

your.domain {
    gzip
    proxy / 0.0.0.0:8081 {
        websocket
        header_upstream -Origin
        header_upstream Host {host}
        header_upstream X-Real-IP {remote}
        header_upstream X-Forwarded-For {remote}
        header_upstream X-Forwarded-Port {server_port}
        header_upstream X-Forwarded-Proto {scheme}
    }
}

License

The MIT License (MIT)