ngrok

ngrok は、送信方向の暗号化接続を通じてローカルまたはプライベートサービスを ngrok クラウドネットワークに接続するコマンドラインエージェントです。受信ファイアウォールの変更やオリジンマシン上のパブリック IP アドレスを必要とせずにパブリックエンドポイントを提供します。開発者は、アプリのプレビュー、webhook テスト、API 開発、および NAT またはファイアウォールの背後にあるサービスへの制御されたアクセスに使用します。

主な機能

• パブリックエンドポイントを通じてローカルの HTTP および HTTPS サービスを公開し、トラフィックを指定したアップストリームポートに転送します。
• サポートされている非 HTTP ユースケース向けに TCP または TLS エンドポイントを作成します。ただし、アカウントの権限に従います。
• アップストリームに到達する前に、リクエストの認証、トラフィックのルーティング、リクエストの書き換え、またはアクセスのレート制限を行うために Traffic Policy を適用します。
• HTTP トラフィックを検査し、キャプチャしたリクエストを再生して webhook をデバッグし、障害を再現します。
• 設定ファイルでエンドポイントとエージェントの動作を構成し、サポートされているコマンドを自動化するか、エージェントを OS サービスとして実行します。
• ngrok のネットワークからオリジンにトラフィックを戻すために、ポート 443 上の 1 つのアウトバウンド TLS 接続を使用します。

インストールと初回使用

brew install --cask ngrok をインストールします。このパッケージは ngrok 実行可能ファイルとシェル補完をインストールしますが、グラフィカルな Mac アプリケーションはインストールしません。ngrok アカウントを作成し、自身のエージェント authtoken を取得して、ngrok config add-authtoken <YOUR_AUTHTOKEN> で構成します。ローカルアプリを起動してから、ngrok http 8080 を実行し、8080 をそのリッスンポートに置き換えます。エージェントが出力するエンドポイントを使用します。このエージェントが作成するエンドポイントは、エージェントセッションの実行中に存在します。別個の Cloud Endpoint のライフサイクル動作は異なります。

要件、依存関係、競合

スタンドアロンエージェントには外部ランタイム依存関係はありません。Homebrew は追加の formula 依存関係、明示的な cask 競合、およびこのスナップショットにおける明示的な macOS バージョン最小要件を宣言していません。Apple Silicon と Intel Mac 向けに別々のネイティブダウンロードを提供します。このメタデータは、すべての過去の macOS リリースのサポートを確立するものではありません。互換性のあるビルドについては、ベンダーのダウンロードページを参照してください。

ベンダーは最小メモリ 64 MB、推奨 128 MB、ディスク約 25 MB を文書化しています。実際のリソース使用量は同時トラフィックに応じて増加します。これらは実行時のガイダンスであり、圧縮ダウンロードサイズではありません。アップストリームアプリケーションは実行中で、エージェントから到達可能である必要があります。クラウドエンドポイントにはインターネットアクセスと ngrok へのアウトバウンド TLS 接続が必要です。企業プロキシ、ファイアウォール、またはアカウント制御が接続性に影響する可能性があります。

別個の公式エージェントビルドは、macOS x86-64/arm64、Windows x86-64/x86、Linux の x86、ARM、MIPS、PowerPC、s390x ファミリ、および FreeBSD x86-64/x86/ARM をサポートします。別の OS で Mac ZIP を使用するのではなく、適切なビルドをダウンロードしてください。エージェント SDK、コンテナ、リバース SSH は別個のデプロイ選択肢です。アップストリームサービスで使用されるツールは、それぞれ独自の要件を維持します。

アカウント、コスト、ライセンス

ngrok クラウドエージェントを使用するには、アカウントとエージェント authtoken が必要です。制限付きの無料プランがあります。有料プランまたは使用量ベースのプランでは、異なる許容量と機能が提供されます。ドメイン、認証オプション、エンドポイントプロトコル、トラフィック保持、使用料金は現在のプランによって異なります。バイナリをダウンロードしても、すべての ngrok サービス機能が無料または無制限になるわけではありません。

現在のエージェントとクラウドサービスは、ngrok の利用規約に従います。現代の分散エージェントは、古いオープンソースの ngrok v1 プロジェクトではありません。公式コミュニティリポジトリはフィードバックと問題追跡に使用されますが、このエージェントの完全なソースではありません。オープンソース SDK およびその他の ngrok コンポーネントには、それぞれ独自のライセンスがあります。

参照: macOS ダウンロード、エージェントのインストールと要件、エージェントの概要、トラフィック検査、料金、利用規約。