Skip to content

Commit 7fa6357

Browse files
committed
完善文档
1 parent 248dcd3 commit 7fa6357

File tree

9 files changed

+29
-16
lines changed

9 files changed

+29
-16
lines changed

README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# Mars
1+
# Mars - HTTP(S)代理, 用于抓包调试
2+
3+
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/ouqiang/mars/blob/master/LICENSE)
4+
[![Release](https://img.shields.io/github/release/ouqiang/mars.svg?label=Release)](https://github.com/ouqiang/mars/releases)
5+
26

3-
HTTP(S)代理, 用于抓包调试
47

58
功能特性
69
----
@@ -9,6 +12,15 @@ HTTP(S)代理, 用于抓包调试
912
* 流量持久化到`leveldb`中, 可用于后期分析
1013
* 拦截请求自定义逻辑
1114

15+
16+
截图
17+
---
18+
19+
![列表](https://raw.githubusercontent.com/ouqiang/mars/master/screenshot/list.png)
20+
![详情](https://raw.githubusercontent.com/ouqiang/mars/master/screenshot/detail.png)
21+
22+
23+
1224
## 目录
1325

1426
* [安装](#安装)
@@ -82,7 +94,7 @@ Git Commit: 2151a6d
8294
### 命令行参数
8395
```bash
8496
$ ./mars server -h
85-
run http server
97+
run proxy server
8698

8799
Usage:
88100
mars server [flags]
@@ -93,13 +105,6 @@ Flags:
93105
-h, --help help for server
94106
```
95107

96-
### make
97-
98-
* `make` 编译
99-
* `make run` 编译并运行
100-
* `make package` 生成当前平台的压缩包
101-
* `make package-all` 生成Windows、Linux、Mac的压缩包
102-
103108

104109
## 结合其他程序使用
105110

@@ -124,7 +129,7 @@ proxy_pass http://172.16.10.103:8080;
124129
proxy_set_header X-Mars-Host $host;
125130
proxy_set_header Host $targetHost;
126131
if ($http_x_mars_debug = "1") {
127-
proxy_pass http://localhost:8888;
132+
proxy_pass http://127.0.0.1:8888;
128133
break;
129134
}
130135
```
@@ -192,6 +197,14 @@ type Output interface {
192197
}
193198
```
194199

200+
### make
201+
202+
* `make` 编译
203+
* `make run` 编译并运行
204+
* `make package` 生成当前平台的压缩包
205+
* `make package-all` 生成Windows、Linux、Mac的压缩包
206+
207+
195208
## 前端
196209

197210
### 基于已有代码开发

cmd/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const (
2323

2424
var serverCmd = &cobra.Command{
2525
Use: "server",
26-
Short: "run http server",
26+
Short: "run proxy server",
2727
Run: func(cmd *cobra.Command, args []string) {
2828
log.Info(version.Format())
2929
viper.BindPFlags(cmd.Flags())

internal/statik/statik.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

screenshot/detail.png

718 KB
Loading

screenshot/list.png

756 KB
Loading

web/public/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><title>mars</title><link href=public/static/css/app.456feddc172b076dc828362d1077a2d8.css rel=stylesheet></head><body><div id=app></div><script type=text/javascript src=public/static/js/manifest.047c133009965c5daaca.js></script><script type=text/javascript src=public/static/js/vendor.99215b533571af4c9162.js></script><script type=text/javascript src=public/static/js/app.9d937801f5fd861a638b.js></script></body></html>
1+
<!DOCTYPE html><html><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><title>mars</title><link href=public/static/css/app.456feddc172b076dc828362d1077a2d8.css rel=stylesheet></head><body><div id=app></div><script type=text/javascript src=public/static/js/manifest.047c133009965c5daaca.js></script><script type=text/javascript src=public/static/js/vendor.99215b533571af4c9162.js></script><script type=text/javascript src=public/static/js/app.4ac0d8d9ce25ca25174c.js></script></body></html>

web/public/static/js/app.4ac0d8d9ce25ca25174c.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)