# simple.proxy

**Repository Path**: simple-set/simple.proxy

## Basic Information

- **Project Name**: simple.proxy
- **Description**: 使用go语言开发的轻量级代理服务器, 简洁，高性能，支持常见协议: http、https、websocket、tcp、udp、内网穿透、DNS防污染等。
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-09-27
- **Last Updated**: 2025-01-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# simple.proxy

### 介绍

`simple.proxy`轻量级代理服务器, 简洁，高性能，支持常见协议: `http`、`https`、`websocket`、`tcp`、
`udp`、内网穿透、DNS防污染等。
使用go语言开发，支持主流操作系统：`Windows`、`Linux`、`MacOs`、`BSD`等。

使用MIT开源许可，免费授予：使用、复制、修改、发行、出售等权利。

### 安装教程

1. 直接下载发布的`release`二进制文件, 提供主流操作系统版本，访问地址如下：

```bash
https://gitee.com/simple-set/simple.proxy/releases
```

2. 下载源码自行编译（或使用`goreleaser`编译）

```bash
$ git clone git@gitee.com:simple-set/simple.proxy.git
$ cd simple.proxy/src && go build -o proxy 
$ ./proxy http
```

### 使用说明

根据命令参数帮助信息即可，简单示例如下：

* 查看帮助信息

```bash
$ proxy --help          # 查看全局帮助信息
$ proxy http --help     # 查看http代理模式的帮助信息 
```

* 启动http代理模式, 常见如下示例

```bash
$ ./proxy http                                          # 启动http代理服务器, 默认监听地址 0.0.0.0:8080
$ ./proxy -l localhost -p 8000 http                     # 启动http代理服务器, 指定监听地址 127.0.0.1:8000
$ ./proxy --dns 223.5.5.5 -l localhost -p 8000 http     # 启动http代理服务器, 指定独立DNS, 指定监听地址 127.0.0.1:8000
```

* 完整帮助信息

```bash
$ $ ./proxy --help
NAME:
   proxy - Simple proxy service

USAGE:
   proxy [global options] command [command options]

VERSION:
   2.0.0

COMMANDS:
   http     http(s) proxy mode
   tcp      tcp proxy mode
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --listen value, -l value  listening address (default: "0.0.0.0")
   --port value, -p value    listening port (default: 8080)
   --dns value, -d value     DNS server address
   --daemon                  daemon mode (default: false)
   --help, -h                show help
   --version, -v             print the version
```

### 支持模式

#### 全局参数

适用于所有模式

* `--listen value, -l value` 在本地监听的地址，默认0.0.0.0
* `--port value, -p value` 默认本地监听端口，默认8080
* `--dns value, -d value` 指定独立DNS服务器解析域名, 默认使用操作系统DNS
* `--daemon` 守护进程模式，在后台运行

#### http

适用于`http`代理模式

* `--user value, -u value        Proxy server auth account`  http代理账号,只能设置一个账号
* `--password value, -p value    Proxy server auth password`  http代理密码,
* `--users_file value, -f value  proxy server auth User ListFile` http代理账号的文件,可设置多个账号, 每行一个, 账号和密码使用冒号分割(:)

示例
```bash
$ ./proxy http                                          # 启动http代理服务器, 默认监听地址 0.0.0.0:8080
$ ./proxy --daemon http                                 # 启动http代理服务器, 后台模式运行, 默认监听地址 0.0.0.0:8080
$ ./proxy -l localhost -p 8000 http                     # 启动http代理服务器, 指定监听地址 127.0.0.1:8000
$ ./proxy --dns 223.5.5.5 -l localhost -p 8000 http     # 启动http代理服务器, 指定独立DNS, 指定监听地址 127.0.0.1:8000
```

#### tcp
适用于`tcp`代理模式
* `--target value` 目标服务器地址

示例
```bash
$ ./proxy tcp --target 112.13.214.81:8080 
$ ./proxy --dns 223.5.5.5 -l localhost tcp --target www.example.com:8080
```

#### udp

### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request