gethomepage/homepage:README 來源編輯指南
根據 README、倉庫資料與授權整理 gethomepage/homepage 的安裝與核驗路徑。
專案定位
gethomepage/homepage 的 README 將專案描述為「A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「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.。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「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.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 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」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「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.。