Reproxyは、さまざまなプロバイダー(docker、static、file、consul catalog)をサポートするシンプルなエッジHTTP(s)サーバー/リバースプロキシです。1つ以上のプロバイダーが、要求されたサーバー、要求されたURL、宛先URL、ヘルスチェックURLに関する情報を提供します。単一のバイナリまたはdockerコンテナとして配布されます。
サーバー(ホスト)はFQDN、すなわちs.example.com、*(キャッチオール)、または正規表現として設定できます。完全一致が優先されるため、サーバーがexample.comとexample\.(com|org)の2つのルールがある場合、example.com/some/urlへのリクエストは前者に一致します。要求されたURLは正規表現にでき、例えば^/api/(.*)とし、宛先URLには正規表現で一致したグループを含めることができます。すなわちhttp://d.example.com:8080/$1です。上記の例では、http://s.example.com/api/something?foo=barはhttp://d.example.com:8080/something?foo=barにプロキシされます。
完全一致および*.example.comのサーバー名は、ホストを大文字小文字を区別せずに照合し、末尾のドットを1つ無視するため、Admin.Example.comとadmin.example.com.はadmin.example.comのルールに一致します。正規表現サーバーは記述どおりに照合されるため、大文字小文字を区別しない場合は(?i)を追加してください。ルートの正規表現はエスケープされたリクエストパスに一致し、スペースは%20、üは%C3%BCとなりますが、静的アセットのプレフィックスはプレーンテキストで記述できます。ルートの正規表現は大文字小文字を区別します。保護されたルートがパスを大文字小文字を区別せずに扱うアップストリームの前にある場合は、そのルートに(?i)を追加してください。
便宜上、末尾に/があり正規表現グループがないリクエストは/(.*)に展開され、その場合の宛先は/$1に展開されます。すなわち、/api/ -> http://127.0.0.1/serviceは^/api/(.*) -> http://127.0.0.1/service/$1に変換されます。
ルートマッチングの前に、reproxyはデコードされたパスに.または..セグメント、連続するスラッシュ(//)、;、またはバックスラッシュを含むリクエストを400で拒否します。末尾のスラッシュ1つは許可されます。
宛先URLではホストの置換がサポートされています。例えば、/files/${host}は一致したホスト名に置き換えられます。$host(波括弧なし)も使用できます。
regex サーバーのグループは、宛先 URL 内で ${host.1}、${host.2} などとして使用できます(波括弧が必要です)。例えば、サーバー ^([^.]+)\.example\.com$、ルート ^/(.*)$、宛先 https://${host.1}.foo.com/$1 の場合、http://aaaa.example.com/some を https://aaaa.foo.com/some にプロキシします。$1、$2 は引き続きルートのグループを参照します。存在しないグループは空文字列に置き換えられ、exact、*、*.example.com のサーバーに対する ${host.N} も同様に空文字列になります(これらのサーバーにはグループがないため)。ホスト値は URL エスケープなしでそのまま挿入されるため、サーバーのグループは厳密に保ってください。正規表現を ^ と $ でアンカーし、ホストラベルに含められる文字のみをキャプチャしてください。つまり (.*) ではなく ([a-z0-9-]+) を使用します。(.*) は ...example.com のようなホストの .. にもマッチしてしまいます。ルートマッチングの前に、reproxy は HTTP ホストヘッダー検証で許可されない文字を含む Host ヘッダー、または % を含む Host ヘッダーを拒否し、400 を返します。ホストトークンがルートグループの直後に続く場合は、グループを波括弧付きで記述してください。つまり ${1}${host.1} とします。$1aaaa は 1aaaa という名前のグループとして解釈されてしまうためです。
HTTP と HTTPS の両方をサポートします。HTTPS では、静的証明書と自動 ACME(Let's Encrypt)証明書の両方を使用できます。オプションのアセットサーバーを使用して静的ファイルを配信できます。reproxy を起動するには、少なくとも 1 つのプロバイダーを定義する必要があります。その他のパラメーターはすべて厳密にオプションであり、適切なデフォルト値があります。
例:
reproxy --static.enabled --static.rule="*,example.com/api/(.*),https://api.example.com/$1"reproxy --docker.enabled --docker.autodocker up -p 80:8080 umputun/reproxy --docker.enabled --docker.autodocker up -p 80:8080 -p 443:8443 umputun/reproxy --docker.enabled --docker.auto --ssl.type=auto --ssl.fqdn=example.comReproxy は小さな自己完結型バイナリとして、また docker イメージとして配布されています。バイナリとイメージの両方が複数のアーキテクチャと複数のオペレーティングシステムをサポートしており、linux_x86_64、linux_arm64、linux_arm、macos_x86_64、macos_arm64、windows_x86_64、windows_arm を含みます。また、arm64 と x86 の両方の deb および rpm パッケージも提供しています。
brew install umputun/apps/reproxydocker pull umputun/reproxy または docker pull ghcr.io/umputun/reproxy です。最新の安定版には :vX.Y.Z docker タグ(:latest エイリアス付き)が付いており、現在の master には :master タグが付いています。
プロキシルールはさまざまなプロバイダーから提供されます。現在含まれているのは file、docker、static、consul-catalog です。各プロバイダーは、プロキシされるリクエストと静的(アセット)の両方に対して複数のルーティングルールを定義できます。ユーザーは複数のプロバイダーを同時に設定できます。
さまざまなプロバイダーの例については examples を参照してください
これは、すべてのマッピングルールをコマンドライン(または環境変数)で直接定義する最もシンプルなプロバイダーです。複数のルールをサポートします。各ルールは 3 ~ 7 個のカンマ区切り要素 server,sourceurl,destination[,ping-url[,forward-health-checks[,timeout[,throttle]]]] です。例:
*,^/api/(.*),https://api.example.com/$1 - /api プレフィックスを持つ任意のホスト/サーバーへのすべてのリクエストを https://api.example.com にプロキシしますexample.com,/foo/bar,https://api.example.com/zzz,https://api.example.com/ping - example.com へのすべてのリクエストと /foo/bar URL へのリクエストを https://api.example.com/zzz にプロキシし、ヘルスチェックには https://api.example.com/ping を使用します。example.com,/foo/bar,https://api.example.com/zzz,https://api.example.com/ping,true - 上記と同じですが、/ping および /health リクエストもバックエンドに転送します。example.com,^/upload/(.*),https://api.example.com/$1,,,5m - ルートごとのリクエストタイムアウトを5分に設定します(4番目と5番目のフィールドは空にして ping-url と forward-health-checks をスキップします)。example.com,^/login,https://api.example.com/login,,,,2 - ルートごとのスロットルをユーザーあたり2リクエスト/秒に設定します(それ以前の位置フィールドは空にします)。4番目の要素はヘルスレポートに使用されるオプションの ping URL を定義します。5番目の要素はヘルスチェックリクエストのバックエンドへの転送をオプションで有効にします(true、yes、1)。詳細はヘルスチェックセクションを参照してください。6番目の要素はオプションのルートごとのリクエストタイムアウトです(Go の duration、例: 5m、30s)。0 または空の場合はグローバル設定 --timeout.write を継承します。7番目の要素はオプションのルートごとのユーザーあたりの req/sec 制限です。0 または空の場合は --throttle.user を継承します。空の位置フィールドも許可されます(例: 未使用の中間フィールドに ,,)。
このプロバイダーはルーティングルールを含む yaml ファイルを使用します。
reproxy --file.enabled --file.name=config.yml
config.yml の例:
default: # the same as * (catch-all) server
- { route: "^/api/svc1/(.*)", dest: "http://127.0.0.1:8080/blah1/$1" }
- {
route: "/api/svc3/xyz",
dest: "http://127.0.0.3:8080/blah3/xyz",
ping: "http://127.0.0.3:8080/ping",
remote: "192.168.1.0/24, 127.0.0.1", # optional, restrict access to the route
forward-health-checks: true # optional, forward /ping and /health to backend
}
- {
route: "^/admin/(.*)",
dest: "http://127.0.0.4:8080/$1",
auth: "admin:$2y$05$..." # optional, per-route basic auth (htpasswd bcrypt format)
}
- {
route: "^/upload/(.*)",
dest: "http://127.0.0.5:8080/$1",
timeout: 5m # optional, per-route request timeout (Go duration). 0 or omitted inherits --timeout.write
}
- {
route: "^/login",
dest: "http://127.0.0.6:8080/login",
throttle: 2 # optional, per-route req/sec per user. 0 or omitted inherits --throttle.user
}
srv.example.com:
- { route: "^/api/svc2/(.*)", dest: "http://127.0.0.2:8080/blah2/$1/abc" }
- { route: "/web/", dest: "/var/www", "assets": true }
"*.files.example.com":
- { route: "^/files/(.*)", dest: "http://123.123.200.200:8080/$host/$1" }
これは動的プロバイダーであり、ファイルの変更は自動的に適用されます。
異なるドメイン上の複数の静的サイトは、サーバー名をキーとして assets: true を使用することで配信できます: