【Python】ngrokで自端末のプログラムをURLからアクセスする方法

ngrok（エングロック）というサービスを使用することで、自端末のブログラムをどこからでも実行できるようになります。

ngrok は ngrok社が開発した、ローカルで動作するアプリケーションをインターネットに公開するためのサービスです。

これにより、わざわさレンタルサーバーを借りてドメインを取得して Webに公開するといった手順をふまずに、自端末のプログラムをURLから公開することができます。図にすると以下のようなイメージです。

ではさっそく、自端末のプログラムをURLからアクセスする手順をご紹介します。

１．ngrok のアカウントを作成
２．自端末で Flask アプリを作成
実行結果
おわりに

１．ngrok のアカウントを作成

ngrok を使用するには、ngrok のアカウントを作成し、トークンを取得する必要があります。

アカウント作成

次のURLから ngrok のWebサイトにアクセスします。

ngrok | API Gateway, Kubernetes Ingress, Webhook Gateway

ngrok simplifies app delivery by unifying API gateway, Kubernetes ingress, multi-cluster load balancing and more with ng...

画面右上にある Sign up をクリックします。

Googleでログインすると楽です。

この後、Multi-factor Authentication（2要素認証）の画面が表示された場合はひとまず Skip をクリックします。

トークンの取得

次に画面左の Your Authtoken をクリックし画面中央の Copy をクリックします。

コピーしたトークンは安全な場所に保管しましょう。

２．自端末で Flask アプリを作成

Flaskとは

Flask とは Python の Webフレームワークです。これにより Python で Webシステムを簡単に作成できます。

ライブラリのインストール

次のコマンドで Flask をインストールしましょう。

pip install Flask

1	pip install Flask

次のコマンドで ngrok をインストールしましょう。

pip install pyngrok

1	pip install pyngrok

ngrok のトークンを自端末に登録する

コマンドプロンプトで以下のプログラムを実行します。

ngrok authtoken "ここに先ほどのトークンを記載"

1	ngrok authtoken "ここに先ほどのトークンを記載"

実際の画面は以下のようになります。実行すると ngrok.yml というファイルが生成されこれを ngrok が自動で読み込んで使用してくれます。

ngrok authtoken を実行した様子

サンプルプログラム

以下は自端末で実行する Python プログラムを作成していきます。

from pyngrok import ngrok
from flask import Flask

public_url = ngrok.connect(5000).public_url
print(public_url)

app = Flask(__name__)

@app.route("/", methods=["GET"])
def test():
    return "test"

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=5000)

from pyngrok import ngrok

from flask import Flask

public_url = ngrok.connect(5000).public_url

print(public_url)

app = Flask(__name__)

@app.route("/", methods=["GET"])

def test():

return "test"

if __name__ == "__main__":

app.run(host="0.0.0.0", port=5000)

このプログラムは ngrok で 5000番ポートを使用する URLを生成し、アプリケーション側も 5000番ポートでGETによるアクセスを受け付けます。

詳しい解説

# 5000番ポートを使用する URLを生成
public_url = ngrok.connect(5000).public_url
print(public_url)

# 5000番ポートを使用する URLを生成

public_url = ngrok.connect(5000).public_url

print(public_url)

この部分では、 ngrok が 5000番ポートを使用するURLを生成してくれます。

# Flaskを実行
app = Flask(__name__)

# URLにアクセスされた場合に def test() を実行 @は"次の行"の関数と関連付ける
@app.route("/", methods=["GET"])
def test():
    # 画面に test を表示
    return "test"

# Flaskが実行された場合の処理
if __name__ == "__main__":
    # 自端末の5000番ポートでアプリを実行
    app.run(host="0.0.0.0", port=5000)