ngrokのインストールと使い方
ngrokは、ローカルで動作しているWebサーバーをインターネットに簡単に公開するためのツールです。これを使うと、例えば開発中のAPIを他の開発者やテスターにすぐにシェアすることができます。今回は、ngrokのインストールから、ローカルサーバーを公開し、最後にngrokを切断するまでを詳しく説明します。
1. ngrokとは？
ngrokは、ローカルで動いているアプリケーションやサーバーを外部のネットワーク（インターネット）上に一時的に公開できるツールです。開発中のAPIやWebアプリケーションを外部からテストしたり、クライアントに見せたりする際にとても役立ちます。セキュリティも担保され、アクセスのログを簡単に確認することもできます。
2. インストール手順
Windowsの場合
- ngrok公式サイト(ngrok.com) にアクセスし、Windows用のバイナリをダウンロードします。
- ダウンロードしたZIPファイルを解凍し、
ngrok.exeファイルを適当なディレクトリに配置します。例えば、C:\ngrokなどに配置しておくと良いでしょう。 -
ngrok.exeを配置したフォルダにパスを通すと、どこからでもngrokコマンドが使えるようになります。これを行うには、以下の手順でシステム環境変数を設定します。
システム環境変数の設定
-
Windowsキー + Pauseを押して、「システムの詳細設定」を開きます。 - 「環境変数」をクリックし、
Pathにngrokを配置したフォルダのパス（例:C:\ngrok）を追加します。 - コマンドプロンプトを開き、
ngrokと打ち込んで正しく実行されるか確認しましょう。
macOS/Linuxの場合
macOSやLinuxを使用している場合も、非常に簡単にngrokをインストールできます。以下の手順に従ってください。
- ターミナルを開いて、以下のコマンドを実行します：
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
3. ngrokの初期設定
インストール後、ngrokを使うためにはアカウントを作成し、認証トークンを設定する必要があります。
ngrokアカウントの作成
- ngrok公式サイトにアクセスし、アカウントを作成します。無料プランでも十分利用可能です。
- ログイン後、ダッシュボードから「Your Authtoken」をコピーします。
トークンの設定
コピーしたトークンを使って、ngrokに認証を行います。ターミナルまたはコマンドプロンプトで次のコマンドを実行します：
ngrok authtoken <あなたの認証トークン>
これでngrokのセットアップは完了です。
4. ローカルサーバーを公開する
次に、ローカルで動作しているアプリケーションをngrokを使ってインターネットに公開します。ここでは、ローカルのlocalhost:3000で動いているNode.jsアプリケーションを例にして説明します。
ローカルサーバーの起動
まず、Node.jsアプリケーションをlocalhost:3000で起動します。
node app.js
ngrokの起動
次に、以下のコマンドでngrokを起動します：
ngrok http 3000
コマンドを実行すると、次のような出力が表示されます：
ngrok by @inconshreveable (Ctrl+C to quit)
Session Status online
Account your_account (Plan: Free)
Version 2.3.40
Region United States (us)
Web Interface http://127.0.0.1:4040
Forwarding http://xxxxxxxx.ngrok.io -> http://localhost:3000
Forwarding https://xxxxxxxx.ngrok.io -> http://localhost:3000
Connections ttl opn rt1 rt5 p50 p90
0 0 0.00 0.00 0.00 0.00
外部からのアクセス
この出力に表示されているhttps://xxxxxxxx.ngrok.ioのURLを使用して、外部のネットワークからローカルサーバーにアクセスできるようになります。例えば、以下のエンドポイントにリクエストを送信するには：
https://xxxxxxxx.ngrok.io/xxx/xxx/xxx/xxx
このURLをブラウザで開いたり、他のAPIクライアント（Postmanなど）でリクエストを送信することができます。
5. ngrokの切断
ngrokを終了したい場合は、単にCtrl + Cを押して、ngrokセッションを終了します。これで外部からのアクセスが停止します。
6. トラブルシューティング
問題: ngrokのURLが変わる
無料プランでは、ngrokのURLは毎回セッションを開始するたびに変わります。固定のURLが必要な場合は、有料プランを検討してください。
問題: 外部からアクセスできない
ファイアウォールやネットワーク設定が原因で、ngrokが正しく動作しないことがあります。サーバーのポートが正しく開いていることを確認してください。
結論
ngrokは、ローカルで開発中のアプリケーションを手軽に公開できる強力なツールです。特に、外部からのフィードバックが必要な場合や、チーム開発での共有が必要な場合に非常に便利です。今回紹介した手順に従えば、簡単にngrokをインストールして使いこなせるようになるでしょう。ぜひ試してみてください！