Rack反向代理项目技术文档

1. 安装指南

1.1 使用RubyGems安装

假设你已经安装了较新版本的RubyGems，可以通过以下命令安装rack-reverse-proxy：

gem install rack-reverse-proxy

1.2 在Gemfile中使用

如果你使用的是Ruby on Rails或其他基于Bundler的项目，可以在Gemfile中添加以下内容：

gem "rack-reverse-proxy", require: "rack/reverse_proxy"

然后运行bundle install来安装依赖。

2. 项目的使用说明

2.1 基本用法

Rack::ReverseProxy应该尽可能地放在中间件栈的最前面。通常情况下，它用于将一个完全不同的网站通过你的应用程序进行代理，因此你不希望其他中间件修改请求或响应。

2.1.1 通用Rack应用示例

以下是一个通用Rack应用的示例：

require 'rack/reverse_proxy'

use Rack::ReverseProxy do
  # 全局设置:preserve_host为true（默认已经是true）
  reverse_proxy_options preserve_host: true

  # 将路径/test*转发到http://example.com/test*
  reverse_proxy '/test', 'http://example.com/'

  # 将路径/foo/*转发到http://example.com/bar/*
  reverse_proxy /^\/foo(\/	*)$/, 'http://example.com/bar$1', username: 'name', password: 'basic_auth_secret'
end

app = proc do |env|
  [ 200, ['Content-Type' => 'text/plain'], ["b"] ]
end

run app

2.1.2 Ruby on Rails应用示例

在Ruby on Rails应用中，确保Rack::ReverseProxy是中间件栈中的第一个中间件。可以通过以下方式实现：

# config/application.rb
config.middleware.insert(0, Rack::ReverseProxy) do
  reverse_proxy_options preserve_host: true
  reverse_proxy '/wiki', 'http://wiki.example.com/'
end

运行rails middleware查看中间件栈，确保Rack::ReverseProxy位于顶部。

3. 项目API使用文档

3.1 reverse_proxy方法

reverse_proxy方法用于定义转发规则。可以多次调用该方法，添加不同的规则。

参数说明

• 路径：可以是字符串或正则表达式。如果是正则表达式，可以使用子捕获组在转发URL中进行替换。
• 目标URL：转发到的目标URL。
• 选项：可选参数，如username和password用于基本认证。

3.2 reverse_proxy_options方法

reverse_proxy_options方法用于设置全局选项。

可用选项

• :preserve_host：设置为false以省略Host头。
• :username：基本认证的用户名。
• :password：基本认证的密码。
• :matching：设置为:first时，第一个匹配的URL将被请求（不会抛出模糊匹配错误）。默认值为:all。
• :timeout：请求超时时间（秒）。
• :force_ssl：如果未使用SSL，则重定向到SSL版本（需要:replace_response_host）。默认值为false。
• :verify_mode：传递给Net::HTTP的OpenSSL验证模式。默认值为OpenSSL::SSL::VERIFY_PEER。
• :x_forwarded_headers：设置适当的X-Forwarded-*头。默认值为true。
• :stripped_headers：在转发请求之前应剥离的头的数组。默认值为nil。

4. 项目安装方式

4.1 通过RubyGems安装

使用以下命令安装：

gem install rack-reverse-proxy

4.2 通过Bundler安装

在Gemfile中添加：

gem "rack-reverse-proxy", require: "rack/reverse_proxy"

然后运行bundle install。

通过以上步骤，你可以成功安装并使用rack-reverse-proxy项目，实现Rack应用的反向代理功能。