Repolode
dsgnr

dsgnr/portchecker.io

Litestarをベースにした、REST APIとWeb UIを備えるオープンソースのTCPポートチェッカー。Dockerでセルフホストできます。

スター
198
フォーク
10
未解決の Issue
1
最終コミット
5 日前

これは何?

portchecker.ioは、指定したホスト名またはIPアドレスでTCPポートに到達できるかを確認します。ネットワーク設定のトラブルシューティングやファイアウォールルールの検証、外部に公開されているポートの確認に役立ちます。

プロジェクトは、Nginxで配信する静的なReactフロントエンドと、Litestarで構築しuvicorn workerを使ってgunicorn上で動作するPython APIの2つで構成されています。どちらも開発用に単独で起動できるほか、GitHub Container Registryで公開されているビルド済みイメージを使って、Docker Composeでまとめて起動できます。

デフォルトでは、APIはIANAの特別用途アドレス範囲に含まれるプライベートIPアドレスのチェックを拒否します。ALLOW_PRIVATEオプションを設定すると、チェックが可能になります。また、APIは応答時間とステータスコードを確認できるPrometheusの/metricsエンドポイントを公開し、CIにはsmoke testとPlaywrightのブラウザテストが含まれています。

主な機能

  • 01任意のホスト名またはIPアドレスで、TCPポートに接続できるかを確認します。
  • 02/docsでルートのドキュメントを参照できるREST APIを提供します。
  • 03Nginxで配信するWeb UIを備えています。
  • 04ビルド済みイメージとDocker Composeファイルを使ってDockerで動作します。
  • 05APIの監視に使えるPrometheusメトリクスエンドポイントを提供します。
  • 06オプションでプライベートIP範囲へのチェックを許可できます。

ユースケース

  • ファイアウォールルールを変更した後、サービスのポートが開いているか確認する。
  • ネットワークの外部から、サーバーのポートが意図どおりに公開されているか検証する。
  • REST APIを使って、スクリプトや監視にポートチェックを組み込む。
  • 自前のインフラでポートチェッカーをセルフホストする。

クイックスタート

  1. 1

    Docker Compose で本番環境のスタックを起動します(フロントエンドはポート 8080、API はポート 8000)

    docker-compose up

使う前に知っておきたいこと

  • GPL-3.0 ライセンスで提供されています。コピーレフトライセンスのため、派生物も同じ条件でオープンソースにする必要があります。
  • 単独で開発するには Python 3.13 と Poetry、Node 26 以降が必要なため、Docker を使うのが簡単です。

収録されている特集

トピック

よくある質問

portchecker.io とは?
Litestarをベースにした、REST APIとWeb UIを備えるオープンソースのTCPポートチェッカー。Dockerでセルフホストできます。 portchecker.ioは、指定したホスト名またはIPアドレスでTCPポートに到達できるかを確認します。ネットワーク設定のトラブルシューティングやファイアウォールルールの検証、外部に公開されているポートの確認に役立ちます。
portchecker.io は無料で使えますか?ライセンスは?
portchecker.io は GPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
portchecker.io は今もメンテナンスされていますか?
活発にメンテナンス中。portchecker.io の最終コミットは 2026年11月1日 です。
portchecker.io は何に使えますか?
ファイアウォールルールを変更した後、サービスのポートが開いているか確認する。 ネットワークの外部から、サーバーのポートが意図どおりに公開されているか検証する。 REST APIを使って、スクリプトや監視にポートチェックを組み込む。 自前のインフラでポートチェッカーをセルフホストする。
portchecker.io のインストール方法は?
Docker Compose で本番環境のスタックを起動します(フロントエンドはポート 8080、API はポート 8000): docker-compose up
portchecker.io はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/dsgnr/portchecker.io

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト