要点
このガイドは、GitHub からの実際のテストリクエストをローカルコードへ接続します。管理された sandbox test、最新の公式情報確認、保守担当者の設定が完了した後にのみ公開します。
手順
- Provider sandbox またはテストアカウント、event type、secret、最小のローカル handler を準備します。
- ローカル handler を起動し、決定的な health route を確認します。
- Oxaa をインストール/ログインし、
oxaa http <port>を実行して edge-ready を待ちます。 - 正確な HTTPS URL と path を現在の Provider 設定へ登録します。
- 実際のテストイベントを発生させます。
- Provider delivery、Oxaa metadata、ローカル handler response を確認します。
- raw body/signature、timestamp、retry、trusted proxy を検証します。
- 必要な場合だけ制限付きローカル capture を有効にし、機密情報をマスキング・削除します。
- 新しい timestamp/token が必要な場合は Oxaa replay ではなく Provider redelivery を使用します。
- callback を削除し、test secret を更新し、capture を削除して、本番はデプロイ済み endpoint または event platform へ移行します。
GitHub 固有の検証
現在の GitHub Webhook/callback 設定に、Oxaa の正確な URL と path を登録します。実際のテストイベントを発生させ、provider の delivery record、Oxaa request metadata、ローカルアプリの response を確認します。公開ガイドでは delivery log、secret、X-Hub-Signature-256 を検証します。
トラフィックと Inspector データの扱い
Oxaa の公開エッジでは、正確なホスト名を解決し、現在認証されているルートを特定してリクエストを転送するために公開 TLS を終端します。登録済みデバイスと Oxaa の間のセッションは暗号化され、そのセッションを通じて選択したローカルサービスだけにリクエストが届きます。
サービスの運用と保護に必要な範囲で、アカウント、ルート、使用量、セキュリティ、請求、サポート、診断のメタデータを保持します。Inspector の body キャプチャは通常の転送とは別の、明示的なデバッグ操作です。ローカル Inspector に表示される制限付きの request/response body コピーは開発者端末に残り、マスキング、即時削除、自動失効が可能です。公開トラフィックはエッジで処理されるため、「Oxaa はトラフィックを見られない」ではなく「Inspector のコピーはローカルに残る」と説明します。
トラブルシューティング
最初にローカルプロセス、ポート、scheme を確認します。次に認証と時刻、DNS、UDP/443、TCP/443 fallback、社内 proxy または TLS interception、ルート所有状態、edge-ready を確認します。oxaa routes list、oxaa diagnose --network、安定した error ID を使用し、共有前に secret、body、プライベートパスを除去します。
クリーンアップと本番環境への移行
外部 callback、preview URL、DNS 設定を削除し、テスト用認証情報をローテーションし、ローカルキャプチャを削除してルートを停止します。必要に応じてデバイスまたはセッションを失効させ、本番トラフィックはデプロイ済みアプリ、production ingress、またはイベント配信基盤へ移行します。
Oxaa が行うこと・行わないこと
Oxaa は、登録済みデバイスと認証済みルートが有効な間、選択したローカル HTTP/HTTPS サービスを外部から利用できるようにする開発用接続です。アプリのホスティング、一般的な VPN、forward proxy、恒久的な本番配備、raw TCP/UDP トンネル、任意の TLS passthrough、CDN/WAF、または本番 Webhook 配信基盤ではありません。