Skip to content

Commit

Permalink
read me
Browse files Browse the repository at this point in the history
  • Loading branch information
yincongcyincong committed Mar 25, 2024
1 parent 4f784fb commit 7fb7890
Showing 1 changed file with 53 additions and 55 deletions.
108 changes: 53 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,79 @@
# proxy-web详细介绍
proxy-web是用go语言写的,基于[snail007/goproxy](https://github.com/snail007/goproxy/)完成的可视化网页应用

# proxy-web introduction
proxy-web is a webview proxy application written by Golang,base on [snail007/goproxy](https://github.com/snail007/goproxy/)
中文介绍:[proxy-web](https://github.com/yincongcyincong/proxy-web/blob/master/README-zh.md)
---
[![stable](https://img.shields.io/badge/stable-stable-green.svg)](https://github.com/snail007/goproxy/)

### 使用前须知
- [作用](#作用)
- [下载](#下载)
- [更新](#更新)
- [配置](#配置)
- [依赖包](#依赖包)
### Notice before use
- [Function](#Function)
- [Download](#Download)
- [Update](#Update)
- [Conf](#Conf)
- [Dependence](#Dependence)

### 手册目录
- [1. 使用](#1使用)
- [2. 参数介绍](#2参数介绍)
### Handbook Catalog
- [1. usage](#1usage)
- [2. param introduction](#2param introduction)

### 作用
1、 用web界面的方式使用goproxy,更加方便
2、 监控goproxy运行情况
3、 实时显示goproxy产生的日志
4、 启动proxy-web后能自启动goproxy
5、 能自开机自启动proxy-web
6、 可以设置linux,mac,windows全局http代理,需要root权限
7、 页面全新升级
### Function
1. Using goproxy through a web interface is more convenient
2. Monitor the running status of goproxy
3. Real time display of logs generated by goproxy
4. After starting proxy web, goproxy can be started automatically
5. Capable of booting up and booting proxy web on its own
6. Linux, Mac, and Windows global HTTP proxies can be set, requiring root privileges
7. New page upgrade

### 下载
[下载地址](https://github.com/yincongcyincong/proxy-web/releases)
### Download
[download websit](https://github.com/yincongcyincong/proxy-web/releases)

### 更新
v 2.0 全面更新
可以自由配置参数
开机自启动proxy-web
全局http代理设置
使用goproxy提供的sdk,不再依赖goproxy二进制程序  
### Update
v 2.0 overall update
Can freely configure parameters
Power on and self start proxy web
Global HTTP proxy settings
Use the SDK provided by goproxy and no longer rely on goproxy binary programs

### 配置
配置文件为config/config.ini  
可以配置的属性有:端口(默认48080),登录账号和密码(都为admin)  
### Configure
The configuration file is config/config.ini
The configurable properties include: port (default 48080), login account, and password (all admin)


### 依赖包
[github.com/snail007/goproxy/sdk](https://github.com/snail007/goproxy/blob/master/sdk/README.md)goproxy的sdk
[github.com/Unknwon/goconfig](https://github.com/Unknwon/goconfig)解析配置文件
[github.com/astaxie/beego/tree/master/session](https://github.com/astaxie/beego/tree/master/session) session模块
这些依赖已经在源码内解决,无需go get
### Dependence
[github.com/snail007/goproxy/sdk](https://github.com/snail007/goproxy/blob/master/sdk/README.md)
[github.com/Unknwon/goconfig](https://github.com/Unknwon/goconfig)
[github.com/astaxie/beego/tree/master/session](https://github.com/astaxie/beego/tree/master/session)

### 1.使用
使用48080端口进入页面(如:localhost:48080),首先到登录页面
### 1.Usage
Use port 48080 to enter the page (e.g. localhost:48080), first go to the login page
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/login.png?raw=true" />
账号密码都为admin,登录进入
both username and password are admin,then login
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/empty.jpg?raw=true" />
点击,添加代理,显示添加代理的弹框,可以选择代理是否开启proxy-web服务时也自动启动
Click to add the proxy and display a pop-up box for adding the proxy. You can choose whether the proxy will automatically start when the proxy web service is enabled
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/add.png?raw=true" />
修改操作
update
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/update.png?raw=true" />
启动操作
start
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/start.jpg?raw=true" />
查看日志操作
check out log
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/log.png?raw=true" />
删除操作
delete
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/delete.png?raw=true" />
设置全局http代理和是否开机自启动,这两个操作需要root权限
Setting the global HTTP proxy and whether to boot automatically requires root privileges
<img src="https://github.com/yincongcyincong/proxy-web/raw/master/docs/image/setting.png?raw=true" />

### 2.参数介绍
名称:代理的名称
参数:指[snail007/goproxy](https://github.com/snail007/goproxy/)中的各种参数
### 2.param introduction
name:proxy name
param:[snail007/goproxy](https://github.com/snail007/goproxy/) have more param detail, please refer

### 源码使用  
- 使用非windows编译,请删除resource.syso  
- git下载源码  
 
### Usage of source code
- Using non Windows compilation, please remove resource.syso
- git download source code

### TODO
- -查找bug
- -check out bug

### License
- under GPLv3 license

### Contact
- QQ群:189618940

0 comments on commit 7fb7890

Please sign in to comment.