Hysen Labsgethomepage/homepage：README に基づく導入ガイド
README、メタデータ、ライセンスに基づく gethomepage/homepage の導入と確認ガイドです。
プロジェクトの範囲
gethomepage/homepage の README はプロジェクトを「A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。A modern, fully static, fast , secure fully proxied , highly customizable application dashboard with integrations for over 100 services and translations into multiple languages.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Features」にある内容から、用途が合うかを先に判断できます。Secure - All API requests to backend services are proxied, keeping your API keys hidden. Constantly reviewed for security by the community.。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。Fast - The site is statically generated at build time for instant load times.。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Docker Integration」など複数の箇所に分かれています。確認できる情報は次の通りです。Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the Docker Service Discovery page for more information.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 services: homepage: image: ghcr.io/gethomepage/homepage:latest container_name: homepage environment: HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts PUID: 1000 # optional, your user id PGID: 1000 # optional, your group id ports: - 3000:3000 volumes: - /path/to/config:/app/config # Make sure your local config directory exists - /var/run/docker.sock:/var/run/docker. 実行可能なコマンドがない場合は手順を作らず、「Docker Integration」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「Service Widgets」にはHomepage also has support for hundreds of 3rd-party services, including all popular \arr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission,とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはFor Everyone - Images built for AMD64, ARM64.ともあります。