louislam/uptime-kuma:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく louislam/uptime-kuma の導入と確認ガイドです。
プロジェクトの範囲
louislam/uptime-kuma の README はプロジェクトを「A fancy self-hosted monitoring tool」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Uptime Kuma」には次の説明があります。Uptime Kuma is an easy-to-use self-hosted monitoring tool.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「⭐ Features」にある内容から、用途が合うかを先に判断できます。Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 90+ notification services, click here for the full list。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Websocket / Ping / DNS Record / Push / Steam Game Server / Docker Containers。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「💪🏻 Non-Docker」など複数の箇所に分かれています。確認できる情報は次の通りです。Uptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 mkdir uptime-kuma cd uptime-kuma curl -o compose.yaml https://raw.githubusercontent.com/louislam/uptime-kuma/master/compose.yaml docker compose up -d 実行可能なコマンドがない場合は手順を作らず、「🥔 Live Demo」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「🐳 Docker Compose」には> [!WARNING] > File Systems like NFS (Network File System) are NOT supported. Please map to a local directory or volume.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料には✅ Major Linux distros such as Debian, Ubuntu, Fedora and ArchLinux etc.ともあります。