Skip to content

Commit 4031d8f

Browse files
committed
Update readme
1 parent a0b91b2 commit 4031d8f

File tree

1 file changed

+26
-48
lines changed

1 file changed

+26
-48
lines changed

README.md

Lines changed: 26 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2340,19 +2340,19 @@ To run standalone benchmark for `proxy.py`, use the following command from repo
23402340

23412341
```console
23422342
proxy -h
2343-
usage: -m [-h] [--threadless] [--threaded] [--num-workers NUM_WORKERS]
2344-
[--enable-events] [--local-executor LOCAL_EXECUTOR]
2345-
[--backlog BACKLOG] [--hostname HOSTNAME]
2346-
[--hostnames HOSTNAMES [HOSTNAMES ...]] [--port PORT]
2347-
[--ports PORTS [PORTS ...]] [--port-file PORT_FILE]
2348-
[--unix-socket-path UNIX_SOCKET_PATH]
2349-
[--num-acceptors NUM_ACCEPTORS] [--tunnel-hostname TUNNEL_HOSTNAME]
2350-
[--tunnel-port TUNNEL_PORT] [--tunnel-username TUNNEL_USERNAME]
2343+
usage: -m [-h] [--tunnel-hostname TUNNEL_HOSTNAME] [--tunnel-port TUNNEL_PORT]
2344+
[--tunnel-username TUNNEL_USERNAME]
23512345
[--tunnel-ssh-key TUNNEL_SSH_KEY]
23522346
[--tunnel-ssh-key-passphrase TUNNEL_SSH_KEY_PASSPHRASE]
2353-
[--tunnel-remote-port TUNNEL_REMOTE_PORT] [--version]
2354-
[--log-level LOG_LEVEL] [--log-file LOG_FILE]
2355-
[--log-format LOG_FORMAT] [--open-file-limit OPEN_FILE_LIMIT]
2347+
[--tunnel-remote-port TUNNEL_REMOTE_PORT] [--threadless]
2348+
[--threaded] [--num-workers NUM_WORKERS] [--enable-events]
2349+
[--local-executor LOCAL_EXECUTOR] [--backlog BACKLOG]
2350+
[--hostname HOSTNAME] [--hostnames HOSTNAMES [HOSTNAMES ...]]
2351+
[--port PORT] [--ports PORTS [PORTS ...]] [--port-file PORT_FILE]
2352+
[--unix-socket-path UNIX_SOCKET_PATH]
2353+
[--num-acceptors NUM_ACCEPTORS] [--version] [--log-level LOG_LEVEL]
2354+
[--log-file LOG_FILE] [--log-format LOG_FORMAT]
2355+
[--open-file-limit OPEN_FILE_LIMIT]
23562356
[--plugins PLUGINS [PLUGINS ...]] [--enable-dashboard]
23572357
[--basic-auth BASIC_AUTH] [--enable-ssh-tunnel]
23582358
[--work-klass WORK_KLASS] [--pid-file PID_FILE] [--openssl OPENSSL]
@@ -2382,6 +2382,21 @@ proxy.py v2.4.4rc6.dev172+ge1879403.d20240425
23822382

23832383
options:
23842384
-h, --help show this help message and exit
2385+
--tunnel-hostname TUNNEL_HOSTNAME
2386+
Default: None. Remote hostname or IP address to which
2387+
SSH tunnel will be established.
2388+
--tunnel-port TUNNEL_PORT
2389+
Default: 22. SSH port of the remote host.
2390+
--tunnel-username TUNNEL_USERNAME
2391+
Default: None. Username to use for establishing SSH
2392+
tunnel.
2393+
--tunnel-ssh-key TUNNEL_SSH_KEY
2394+
Default: None. Private key path in pem format
2395+
--tunnel-ssh-key-passphrase TUNNEL_SSH_KEY_PASSPHRASE
2396+
Default: None. Private key passphrase
2397+
--tunnel-remote-port TUNNEL_REMOTE_PORT
2398+
Default: 8899. Remote port which will be forwarded
2399+
locally for proxy.
23852400
--threadless Default: True. Enabled by default on Python 3.8+ (mac,
23862401
linux). When disabled a new thread is spawned to
23872402
handle each client connection.
@@ -2418,21 +2433,6 @@ options:
24182433
--host and --port flags are ignored
24192434
--num-acceptors NUM_ACCEPTORS
24202435
Defaults to number of CPU cores.
2421-
--tunnel-hostname TUNNEL_HOSTNAME
2422-
Default: None. Remote hostname or IP address to which
2423-
SSH tunnel will be established.
2424-
--tunnel-port TUNNEL_PORT
2425-
Default: 22. SSH port of the remote host.
2426-
--tunnel-username TUNNEL_USERNAME
2427-
Default: None. Username to use for establishing SSH
2428-
tunnel.
2429-
--tunnel-ssh-key TUNNEL_SSH_KEY
2430-
Default: None. Private key path in pem format
2431-
--tunnel-ssh-key-passphrase TUNNEL_SSH_KEY_PASSPHRASE
2432-
Default: None. Private key passphrase
2433-
--tunnel-remote-port TUNNEL_REMOTE_PORT
2434-
Default: 8899. Remote port which will be forwarded
2435-
locally for proxy.
24362436
--version, -v Prints proxy.py version.
24372437
--log-level LOG_LEVEL
24382438
Valid options: DEBUG, INFO (default), WARNING, ERROR,
@@ -2571,25 +2571,3 @@ options:
25712571
Proxy.py not working? Report at:
25722572
https://github.com/abhinavsingh/proxy.py/issues/new
25732573
```
2574-
C file.
2575-
--cloudflare-dns-mode CLOUDFLARE_DNS_MODE
2576-
Default: security. Either "security" (for malware
2577-
protection) or "family" (for malware and adult content
2578-
protection)
2579-
--filtered-upstream-hosts FILTERED_UPSTREAM_HOSTS
2580-
Default: Blocks Facebook. Comma separated list of IPv4
2581-
and IPv6 addresses.
2582-
--filtered-client-ips-mode FILTERED_CLIENT_IPS_MODE
2583-
Default: blacklist. Can be either "whitelist"
2584-
(restrict access to specific IPs)or "blacklist" (allow
2585-
everything except specific IPs).
2586-
--filtered-client-ips FILTERED_CLIENT_IPS
2587-
Default: 127.0.0.1,::1. Comma separated list of IPv4
2588-
and IPv6 addresses.
2589-
--filtered-url-regex-config FILTERED_URL_REGEX_CONFIG
2590-
Default: No config. Comma separated list of IPv4 and
2591-
IPv6 addresses.
2592-
2593-
Proxy.py not working? Report at:
2594-
https://github.com/abhinavsingh/proxy.py/issues/new
2595-
```

0 commit comments

Comments
 (0)