fatedier/frp:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく fatedier/frp の導入と確認ガイドです。
プロジェクトの範囲
fatedier/frp の README はプロジェクトを「A fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Sponsors」には次の説明があります。frp is an open source project with its ongoing development made possible entirely by the support of our awesome sponsors. If you'd like to join them, please consider sponsoring frp's development.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Table of Contents」にある内容から、用途が合うかを先に判断できます。Accessing Internal Web Services with Custom Domains in LAN。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。Access your computer in a LAN network via SSH。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Recall.ai - API for meeting recordings」など複数の箇所に分かれています。確認できる情報は次の通りです。an API that records Zoom, Google Meet, Microsoft Teams, in-person meetings, and more.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 # frpc.toml serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "unix_domain_socket" type = "tcp" remotePort = 6000 [proxies.plugin] type = "unix_domain_socket" unixPath = "/var/run/docker.sock" 実行可能なコマンドがない場合は手順を作らず、「Sponsors」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「What is frp?」にはfrp is a fast reverse proxy that allows you to expose a local server located behind a NAT or firewall to the Internet. It currently supports TCP and UDP, as well as HTTP and HTTPS protocols, enabling requests to be forwarded to internalとあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはRequire HTTP Basic Auth (Password) for Web Servicesともあります。