Skip to content

Commit c046d85

Browse files
authored
Merge pull request #133 from willingc/update-rm
Update README with 3.1 options
2 parents 37002d0 + 85740d5 commit c046d85

File tree

1 file changed

+41
-38
lines changed

1 file changed

+41
-38
lines changed

README.md

+41-38
Original file line numberDiff line numberDiff line change
@@ -70,44 +70,47 @@ matching route is found in the proxy table:
7070
7171
Options:
7272
73-
-h, --help output usage information
74-
-V, --version output the version number
75-
--ip <ip-address> Public-facing IP of the proxy
76-
--port <n> (defaults to 8000) Public-facing port of the proxy
77-
78-
--ssl-key <keyfile> SSL key to use, if any
79-
--ssl-cert <certfile> SSL certificate to use, if any
80-
--ssl-ca <ca-file> SSL certificate authority, if any
81-
--ssl-request-cert Request SSL certs to authenticate clients
82-
--ssl-reject-unauthorized Reject unauthorized SSL connections (only meaningful if --ssl-request-cert is given)
83-
--ssl-protocol <ssl-protocol> Set specific HTTPS protocol, e.g. TLSv1_2, TLSv1, etc.
84-
--ssl-ciphers <ciphers> `:`-separated ssl cipher list. Default excludes RC4
85-
--ssl-allow-rc4 Allow RC4 cipher for SSL (disabled by default)
86-
--ssl-dhparam <dhparam-file> SSL Diffie-Helman Parameters pem file, if any
87-
88-
--api-ip <ip> Inward-facing IP for API requests
89-
--api-port <n> Inward-facing port for API requests (defaults to --port=value+1)
90-
--api-ssl-key <keyfile> SSL key to use, if any, for API requests
91-
--api-ssl-cert <certfile> SSL certificate to use, if any, for API requests
92-
--api-ssl-ca <ca-file> SSL certificate authority, if any, for API requests
93-
--api-ssl-request-cert Request SSL certs to authenticate clients for API requests
94-
--api-ssl-reject-unauthorized Reject unauthorized SSL connections (only meaningful if --api-ssl-request-cert is given)
95-
96-
--default-target <host> Default proxy target (proto://host[:port])
97-
--error-target <host> Alternate server for handling proxy errors (proto://host[:port])
98-
--error-path <path> Alternate server for handling proxy errors (proto://host[:port])
99-
--redirect-port <redirect-port> Redirect HTTP requests on this port to the server on HTTPS
100-
--pid-file <pid-file> Write our PID to a file
101-
--no-x-forward Don't add 'X-forward-' headers to proxied requests
102-
--no-prepend-path Avoid prepending target paths to proxied requests
103-
--no-include-prefix Don't include the routing prefix in proxied requests
104-
--insecure Disable SSL cert verification
105-
--host-routing Use host routing (host as first level of path)
106-
--statsd-host <host> Host to send statsd statistics to
107-
--statsd-port <port> Port to send statsd statistics to
108-
--statsd-prefix <prefix> Prefix to use for statsd statistics
109-
--log-level <loglevel> Log level (debug, info, warn, error)
110-
--proxy-timeout <n> Timeout (in millis) when proxy receives no response from target
73+
-h, --help output usage information
74+
-V, --version output the version number
75+
--ip <ip-address> Public-facing IP of the proxy
76+
--port <n> (defaults to 8000) Public-facing port of the proxy
77+
78+
--ssl-key <keyfile> SSL key to use, if any
79+
--ssl-cert <certfile> SSL certificate to use, if any
80+
--ssl-ca <ca-file> SSL certificate authority, if any
81+
--ssl-request-cert Request SSL certs to authenticate clients
82+
--ssl-reject-unauthorized Reject unauthorized SSL connections (only meaningful if --ssl-request-cert is given)
83+
--ssl-protocol <ssl-protocol> Set specific HTTPS protocol, e.g. TLSv1_2, TLSv1, etc.
84+
--ssl-ciphers <ciphers> `:`-separated ssl cipher list. Default excludes RC4
85+
--ssl-allow-rc4 Allow RC4 cipher for SSL (disabled by default)
86+
--ssl-dhparam <dhparam-file> SSL Diffie-Helman Parameters pem file, if any
87+
88+
--api-ip <ip> Inward-facing IP for API requests
89+
--api-port <n> Inward-facing port for API requests (defaults to --port=value+1)
90+
--api-ssl-key <keyfile> SSL key to use, if any, for API requests
91+
--api-ssl-cert <certfile> SSL certificate to use, if any, for API requests
92+
--api-ssl-ca <ca-file> SSL certificate authority, if any, for API requests
93+
--api-ssl-request-cert Request SSL certs to authenticate clients for API requests
94+
--api-ssl-reject-unauthorized Reject unauthorized SSL connections (only meaningful if --api-ssl-request-cert is given)
95+
96+
--default-target <host> Default proxy target (proto://host[:port])
97+
--error-target <host> Alternate server for handling proxy errors (proto://host[:port])
98+
--error-path <path> Alternate server for handling proxy errors (proto://host[:port])
99+
--redirect-port <redirect-port> Redirect HTTP requests on this port to the server on HTTPS
100+
--pid-file <pid-file> Write our PID to a file
101+
--no-x-forward Don't add 'X-forward-' headers to proxied requests
102+
--no-prepend-path Avoid prepending target paths to proxied requests
103+
--no-include-prefix Don't include the routing prefix in proxied requests
104+
--insecure Disable SSL cert verification
105+
--host-routing Use host routing (host as first level of path)
106+
--statsd-host <host> Host to send statsd statistics to
107+
--statsd-port <port> Port to send statsd statistics to
108+
--statsd-prefix <prefix> Prefix to use for statsd statistics
109+
--log-level <loglevel> Log level (debug, info, warn, error)
110+
--proxy-timeout <n> Timeout (in millis) when proxy receives no response from target
111+
112+
--change-origin Passthrough for node-http-proxy's changeOrigin option
113+
--storage-backend <storage-class> Use for custom storage classes
111114
```
112115

113116

0 commit comments

Comments
 (0)