リバースプロキシ

Nginx、Nginx Proxy Manager、Caddy、Cloudflare、その他のリバースプロキシの背後で Varin を実行する場合は、このページを使ってください。

プロキシする前に

まず Varin が直接動くことを確認します。
同じネットワークから http://<server-ip>:3000 またはカスタムポートを開きます。
直接接続が動いてから、リバースプロキシを追加します。

プロキシが対応すべきもの

WebSocket:
- /api/dictation/ws
- /api/terminal/ws
- /api/varin/realtime-proxy/ws
バッファリングなしの SSE:
- /api/notifications/stream
- /api/varin/events
- /api/threads/observe
- /api/varin/realtime-proxy/sse
添付ファイルとファイル操作向けの大きなリクエストボディ
ライブストリームとターミナルセッション向けの長い read timeout

重要なルール

WebSocket プロキシを有効にします。
SSE ルートではバッファリングを無効にします。
Varin がすでにレスポンスを圧縮している場合、プロキシ側の gzip を無効にします。
圧縮を有効にする層は 1 つだけにします。
Host、X-Forwarded-For、X-Forwarded-Proto など通常のプロキシヘッダーを転送します。
ユーザーがファイルをアップロードする場合は body size limit を増やします。

クイックチェックリスト

Varin に LAN から直接到達できる
プロキシで WebSocket が有効
SSE ルートのバッファリングがオフ
プロキシホストで gzip off、または別の方法でプロキシ圧縮が無効
client_max_body_size が添付ファイルに十分な大きさ
proxy_read_timeout がストリームに十分長い

例: Nginx

設定例を表示

client_max_body_size 50M;
client_body_buffer_size 50M;
proxy_request_buffering off;

proxy_http_version 1.1;
proxy_set_header Connection "";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Host $host;

gzip off;

location ~ ^/api/(varin/realtime-proxy|terminal|dictation)/ws$ {
    proxy_pass http://127.0.0.1:3000;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_buffering off;
    proxy_cache off;
    proxy_read_timeout 3600s;
    proxy_send_timeout 3600s;
}

location ~ ^/api/(threads/observe|notifications/stream|varin/(events|realtime-proxy/sse))$ {
    proxy_pass http://127.0.0.1:3000;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Accept "text/event-stream";
    proxy_set_header Cache-Control "no-cache";
    proxy_buffering off;
    proxy_cache off;
    gzip off;
    add_header X-Accel-Buffering "no" always;
    add_header Cache-Control "no-cache, no-transform" always;
    proxy_read_timeout 3600s;
    proxy_send_timeout 3600s;
}

location /api {
    proxy_pass http://127.0.0.1:3000;
    proxy_read_timeout 3600s;
    proxy_send_timeout 3600s;
}

location / {
    proxy_pass http://127.0.0.1:3000;
}

例: Nginx Proxy Manager

Nginx Proxy Manager で Websockets Support を有効にしてください。ホストの Advanced 設定には、上の Nginx 例のバッファリング、リクエストサイズ、タイムアウト設定を使用し、同じ現行の WebSocket と SSE パスを維持してください。

よくある失敗の兆候

ページは読み込まれるが、メッセージ送信に失敗する

POST /api/threads/* の認証と転送を確認してください。
GET /api/threads/observe の SSE はバッファーやキャッシュを使わず配信してください。

通知またはライブ状態が更新されない

SSE ルートのどれかがバッファリングまたはキャッシュされています
X-Accel-Buffering "no" がありません

ファイルアップロードに失敗する

client_max_body_size が小さすぎます

ローカルではすべて動くが、プロキシ背後でだけ壊れる

プロキシがライブ通信を圧縮またはバッファリングしています
プロキシに WebSocket 対応がありません

例: Caddy