socks5 - GitLite

KO | EN

gitlite — search

#javascript #python #ai #llm #golang #android #macos #nodejs #awesome #kubernetes #vue #awesome-list #ios #open-source

socks5

(★ 75)

socks5 proxy,support tcp,udp

File Explorer

Download Latest Version (.zip)

- - docker.yml
  - release.yml
- launch.json
- - main.go
- config.md
- config_zh.md
- docker.md
- README_zh.md
- rfc1928.txt
- rfc1929.txt
- SOCKS4.protocol.txt
- socks4A.protocol.txt
- log.go
- - buf.go
  - buf_test.go
.gitignore
.goreleaser.yml
addr.go
build.bat
build.sh
client_socks4.go
client_socks5.go
client_test.go
config.go
conn.go
conn_socks4.go
conn_socks5.go
Dockerfile
go.mod
go.sum
LICENSE
pipe.go
protocol_socks4.go
protocol_socks5.go
README.md
release.bat
server.go
server_test.go
udp.go

# Installation Guide

1. Get the code

git clone https://github.com/0990/socks5

Downloads the entire project code from GitHub to your computer.

cd socks5

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t socks5 .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 socks5

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# socks5
[中文文档](doc/README_zh.md)<br>
A lightweight SOCKS proxy server that supports socks4, socks4a, and socks5 protocols. The code is simple and easy to read, just like the original SOCKS protocol.

## Feature
* support [socks4](doc/SOCKS4.protocol.txt),[socks4a](doc/socks4A.protocol.txt),[socks5(TCP&UDP)](doc/rfc1928.txt)
* Supports [socks5 username/password authentication](doc/rfc1929.txt)

## Usage
Download the latest program for your operating system and architecture from the [Release](https://github.com/0990/socks5/releases) page.
Extracting,then execute the binary file directly (Linux platform requires execution permission)<br>
```bash
./ss5
```
or
```bash
./ss5 -c ./ss5.json
```
[Docker installation](doc/docker.md)

### Configuration
The ss5.json file in the extracted directory is the configuration file<br>
Simple configuration instructions:  
 ```
  ListenPort The listening port for TCP and UDP proxies, default is 1080
  UserName,Password Fill in if username/password authentication is required, default is empty
  LogLevel Log level (debug, info, warn, error)
``` 
[Advanced configuration](doc/config.md)
## Package Usage
```
go get github.com/0990/socks5  
```
Here is a simple example:
```
s := socks5.NewServer(socks5.ServerCfg{
	    ListenPort: 1080,
	    UserName:   "",
	    Password:   "",
	    UDPTimout:  60,
	    TCPTimeout: 60,
	    LogLevel:"error"
})
err := s.Run()
if err != nil {
	log.Fatalln(err)
}
```
## TODO
* Support BIND command

## Thanks
[txthinking/socks5](https://github.com/txthinking/socks5)