ngrokとは？使い方やインストール方法、公開までの流れを解説

ngrokとは？使い方やインストール方法、公開までの流れを解説 OPPOの使い方
2024.12.17

ngrokとは

ngrok（エングロック）は、ローカル環境で動作しているサービスを安全にインターネットに公開できるトンネリングツールです。開発時の外部サービステストやデモ環境の構築に非常に便利なツールとして、多くの開発者に利用されています。

ngrokの動作の仕組み

ngrokの動作の仕組みは、主に3つのステップで構成されています。まず、ローカル環境で動作しているサーバーとngrokサーバー間でセキュアなトンネルを確立します。次に、ngrokサーバーが一意のURLを生成し、そのURLを通じて外部からのアクセスが可能になります。最後に、インターネットからのアクセスをngrokサーバー経由でローカル環境に転送することで、ローカルサーバーへの安全なアクセスを実現します。

開発現場でngrokを活用するメリット

ngrokを開発現場で活用することで、開発効率を大きく向上させることができます。最も大きなメリットは、複雑なネットワーク設定なしでローカル環境を即座に公開できる点です。従来のポート開放やDNS設定などの煩雑な作業が不要となり、開発に集中できる環境を整えることができます。

また、Webhookのテストやモバイルアプリのバックエンド連携テストも容易になります。外部サービスからのコールバックをローカル環境で直接受け取れるため、開発サイクルを大幅に短縮できます。クライアントとの共有も簡単で、開発中の機能を即座に確認してもらうことができます。

セキュリティ面でも優れており、デフォルトでHTTPS対応しているため、セキュアな通信が自動的に確保されます。これにより、開発段階から本番環境に近い形でのテストが可能になります。

無料版と有料版の機能比較

ngrokには無料版と有料版があり、それぞれの用途に応じて選択することができます。無料版でも基本的な開発作業には十分な機能が揃っていますが、より本格的な開発環境や運用環境では有料版の機能が役立ちます。

無料版では、ランダムなサブドメインでの公開やHTTPSサポート、基本的なトンネリング機能が利用可能です。ただし、同時に利用できるトンネルは1つまでという制限があります。

一方、有料版では以下のような高度な機能が追加されます：

  • カスタムサブドメインの利用が可能
  • 複数トンネルの同時利用
  • IPホワイトリスト機能による接続制限
  • TLSトンネリングのサポート
  • 詳細なモニタリング機能

開発規模や要件に応じて、適切なプランを選択することで、より効率的な開発環境を構築できます。

環境別インストール手順

Windows環境でのインストール

  1. 公式サイト（https://ngrok.com/）からWindows用ZIPファイルをダウンロード
  2. ZIPファイルの展開
    - ダウンロードしたZIPファイルを任意のフォルダに展開
    - 展開されたngrok.exeを任意のフォルダに配置（例：C:\ngrok\）
  3. システム環境変数の設定
    1. システムのプロパティ → 環境変数を開く
    2. システム環境変数のPathに以下を追加
    C:\ngrok（ngrok.exeを配置したフォルダパス）

macOS環境でのインストール

  1. Homebrewを使用する場合：
    bash
    brew install ngrok/ngrok/ngrok
  2. 直接インストールする場合：
    bash
    # ダウンロードと展開
    curl -O https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-darwin-amd64.zip
    unzip ngrok-stable-darwin-amd64.zip    # 実行権限の付与
    chmod +x ngrok# パスの通ったディレクトリへの移動
    sudo mv ngrok /usr/local/bin

Linux環境でのインストール

  1. apt-getを使用する場合：
    bash
    curl -s https://ngrok-agent.s3.amazonaws.com/ngrok.asc | \
    sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null && \
    echo "deb https://ngrok-agent.s3.amazonaws.com buster main" | \
    sudo tee /etc/apt/sources.list.d/ngrok.list && \
    sudo apt update && sudo apt install ngrok
  2. 直接インストールする場合：
    bash
    wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip
    unzip ngrok-stable-linux-amd64.zip
    sudo mv ngrok /usr/local/bin

初期設定

アカウント作成とトークン設定

  1. ngrok公式サイトでアカウントを作成
  2. 認証トークンの設定：
    bash
    ngrok authtoken <your-auth-token>

設定ファイルのカスタマイズ

~/.ngrok2/ngrok.yml（Windowsの場合はC:\Users\YourName\.ngrok2\ngrok.yml）に以下の設定を追加：

yaml
authtoken: <your-auth-token>
region: jp # 日本リージョンを使用
tunnels:
web:
proto: http
addr: 8080
auth: "username:password" # Basic認証

セキュリティ強化設定

  1. Basic認証の設定
    bash
    ngrok http -auth="username:password" 3000
  2. リージョン指定による最適化
    bash
    ngrok http -region=jp 3000
  3. カスタムドメインの設定（有料プラン）
    bash
    ngrok http -hostname="your-domain.ngrok.io" 3000

使用方法と運用管理

基本的な起動コマンド

bash
# HTTPサーバーの公開
ngrok http 3000# HTTPSサーバーの公開
ngrok http https://localhost:3000# TCPポートの公開
ngrok tcp 22

トラフィック監視

  1. Web インターフェースへのアクセス
    http://localhost:4040
  2. 監視可能な情報
    • リアルタイムのリクエスト/レスポンス
    • レイテンシー統計
    • エラーログ
    • ステータスコード分布

トラブルシューティング

  1. 接続エラーの場合：
    - ローカルサーバーの起動確認
    - ポート番号の確認
    - ファイアウォール設定の確認
  2. 認証エラーの場合：
    - トークンの再設定
    - 設定ファイルのパーミッション確認

運用上の注意点

  1. セキュリティ対策
    • 必ずBasic認証を設定
    • 重要な情報の公開は避ける
    • セッション有効期限の管理
  2. パフォーマンス最適化
    • 適切なリージョンの選択
    • 不要な接続の終了
    • トラフィック監視の活用

まとめ

ngrokは開発環境での外部公開に非常に便利なツールですが、適切なセキュリティ設定と運用管理が重要です。本ガイドで紹介した設定と注意点を守ることで、安全かつ効率的な開発環境を構築できます。

参考リソース

コメント