README
¶
中文简体 | English
forward-cli
一个命令行工具，反向代理任何网站。例如 Github/Google/Facebook 和其他等. 更多信息
使用
forward - A command line tool to quickly setup a reverse proxy server.
USAGE:
forward [OPTIONS] [host]
OPTIONS:
--help print help information
--version show version information
--address="<string>" specify the address that the proxy server listens on. defaults: 0.0.0.0
--port="<int>" specify the port that the proxy server listens on. defaults: 80
--proxy-external whether to proxy external host. defaults: false
--proxy-external-ignore=<host> specify the external host without using a proxy. defaults: ""
--req-header="key=value" specify the request header attached to the request. Allow multiple flags. defaults: ""
--res-header="key=value" specify the response headers. Allow multiple flags. defaults: ""
--cors whether enable cors. defaults: false
--overwrite=<folder> enable overwrite with a folder. defaults: ""
--no-cache disabled cache for response. defaults: true
--tls-cert-file=<filepath> the cert file path for enabled tls. defaults: ""
--tls-key-file=<filepath> the key file path for enabled tls. defaults: ""
EXAMPLES:
forward http://example.com
forward --port=80 http://example.com
forward --req-header="foo=bar" http://example.com
forward --cors --req-header="foo=bar" --req-header="hello=world" http://example.com
forward --tls-cert-file=/path/to/cert/file --tls-key-file=/path/to/key/file http://example.com
安装
-
Shell (Mac/Linux)
curl -fsSL https://github.com/release-lab/install/raw/v1/install.sh | bash -s -- -r=axetroy/forward-cli -e=forward -
PowerShell (Windows):
$r="axetroy/forward-cli";$e="forward";iwr https://github.com/release-lab/install/raw/v1/install.ps1 -useb | iex -
Github release page (全平台)
下载可执行文件，然后放到
$PATH目录下 -
使用 Golang 从源码中构建并安装 (全平台)
go install github.com/axetroy/forward-cli/cmd/forward@latest
杂项
- 如何启用 HTTPS？
要启用 HTTPS，首先先生成 key 和 证书文件
# 生成 key
openssl genrsa -out server.key 2048
# 生成证书
openssl req -new -x509 -sha256 -key server.key -out server.pem -days 3650
# 启动代理服务器
forward --tls-cert-file=server.pem --tls-key-file=server.key http://example.com
- 自定义代理请求
# 代理 https://github.com
forward https://github.com
# 发起请求
curl http://0.0.0.0:80/api # 实际请求 https://github.com/api
# 发起自定义代理
curl -H "X-Proxy-Target: https://www.google.com" http://0.0.0.0/api # 实际请求 https://www.google.com/api
开源许可
The MIT License
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ProxyServer ¶
type ProxyServer struct {
*ProxyServerOptions
// contains filtered or unexported fields
}
func NewProxyServer ¶
func NewProxyServer(options *ProxyServerOptions) *ProxyServer
func (*ProxyServer) Handler ¶
func (p *ProxyServer) Handler() func(http.ResponseWriter, *http.Request)
type ProxyServerOptions ¶
type ProxyServerOptions struct {
Target *url.URL // proxy target
UseSSL bool // use SSL
ReqHeaders http.Header // set request headers
ResHeaders http.Header // set response headers
ProxyExternal bool // whether to proxy external host
ProxyExternalIgnores []string // the host name that should ignore when enable proxy external
Cors bool // whether enable cors
NoCache bool // disabled cache for response
OverwriteFolder string // overwrite request with paths
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.
