Skip to content

Commit c3f7538

Browse files
committed
readme updates
1 parent 955f551 commit c3f7538

File tree

1 file changed

+51
-49
lines changed

1 file changed

+51
-49
lines changed

README.md

Lines changed: 51 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Additionally a replay utility allows to import the dumped traffic (request/respo
5050
Download the ready to run [binary](https://github.com/projectdiscovery/proxify/releases/) or install/build using GO
5151

5252
```sh
53-
GO111MODULE=on go get -v github.com/projectdiscovery/proxify/cmd/proxify
53+
go install -v github.com/projectdiscovery/proxify/cmd/proxify@latest
5454
```
5555

5656
# Usage
@@ -61,55 +61,57 @@ proxify -h
6161

6262
This will display help for the tool. Here are all the switches it supports.
6363

64-
<details>
65-
<summary> 👉 proxify help menu 👈</summary>
66-
67-
```
68-
-addr string
69-
Listen Ip and port (ip:port) (default "127.0.0.1:8888")
70-
-allow value
71-
Whitelist ip/cidr
72-
-cert-cache-size int
73-
Number of certificates to cache (default 256)
74-
-config string
75-
Directory for storing program information (default "$HOME/.config/proxify")
76-
-deny value
77-
Blacklist ip/cidr
78-
-dns-addr string
79-
Listen DNS Ip and port (ip:port)
80-
-dns-mapping string
81-
DNS A mapping (eg domain:ip,domain:ip,..)
82-
-dns-resolver string
83-
Listen DNS Ip and port (ip:port)
84-
-dump-req
85-
Dump requests in separate files
86-
-dump-resp
87-
Dump responses in separate files
88-
-http-proxy string
89-
Upstream HTTP Proxy (eg http://proxyip:proxyport
90-
-no-color
91-
No Color (default true)
92-
-output string
93-
Output Folder (default "logs")
94-
-request-dsl string
95-
Request Filter DSL
96-
-request-match-replace-dsl string
97-
Request Match-Replace DSL
98-
-response-dsl string
99-
Response Filter DSL
100-
-response-match-replace-dsl string
101-
Request Match-Replace DSL
102-
-silent
103-
Silent
104-
-socks5-proxy string
105-
Upstream SOCKS5 Proxy (eg socks5://proxyip:proxyport)
106-
-v Verbose
107-
-version
108-
Version
64+
```console
65+
Usage:
66+
./proxify [flags]
67+
68+
Flags:
69+
OUTPUT:
70+
-o, -output string Output Directory to store HTTP proxy logs (default "logs")
71+
-dump-req Dump only HTTP requests to output file
72+
-dump-resp Dump only HTTP responses to output file
73+
74+
FILTER:
75+
-req-fd, -request-dsl string Request Filter DSL
76+
-resp-fd, -response-dsl string Response Filter DSL
77+
-req-mrd, -request-match-replace-dsl string Request Match-Replace DSL
78+
-resp-mrd, -response-match-replace-dsl string Response Match-Replace DSL
79+
80+
NETWORK:
81+
-ha, -http-addr string Listening HTTP IP and Port address (ip:port) (default "127.0.0.1:8888")
82+
-sa, -socks-addr string Listening SOCKS IP and Port address (ip:port) (default "127.0.0.1:10080")
83+
-da, -dns-addr string Listening DNS IP and Port address (ip:port)
84+
-dm, -dns-mapping string Domain to IP DNS mapping (eg domain:ip,domain:ip,..)
85+
-r, -resolver string Custom DNS resolvers to use (ip:port)
86+
87+
PROXY:
88+
-hp, -http-proxy string Upstream HTTP Proxies (eg http://proxy-ip:proxy-port
89+
-sp, -socks5-proxy string Upstream SOCKS5 Proxies (eg socks5://proxy-ip:proxy-port)
90+
-c int Number of requests before switching to the next upstream proxy (default 1)
91+
92+
EXPORT:
93+
-elastic-address string elasticsearch address (ip:port)
94+
-elastic-ssl enable elasticsearch ssl
95+
-elastic-ssl-verification enable elasticsearch ssl verification
96+
-elastic-username string elasticsearch username
97+
-elastic-password string elasticsearch password
98+
-elastic-index string elasticsearch index name (default "proxify")
99+
-kafka-address string address of kafka broker (ip:port)
100+
-kafka-topic string kafka topic to publish messages on (default "proxify")
101+
102+
CONFIGURATION:
103+
-config string Directory for storing program information (default "/Users/geekboy/.config/proxify")
104+
-cert-cache-size int Number of certificates to cache (default 256)
105+
-allow string Allowed list of IP/CIDR's to be proxied
106+
-deny string Denied list of IP/CIDR's to be proxied
107+
108+
DEBUG:
109+
-silent Silent
110+
-nc, -no-color No Color (default true)
111+
-version Version
112+
-v, -verbose Verbose
109113
```
110114

111-
</details>
112-
113115
### Running Proxify
114116

115117
Runs a HTTP proxy on port **8888**
@@ -119,7 +121,7 @@ proxify
119121

120122
Runs a HTTP proxy on custom port **1111**
121123
```sh
122-
proxify -addr ":1111"
124+
proxify -http-addr ":1111"
123125
```
124126

125127
### Proxify with upstream proxy

0 commit comments

Comments
 (0)