ghcr.io/gethomepage/homepage:latest

功能特性

Homepage 具备快速搜索、书签、天气支持、丰富的集成与小部件、优雅现代的设计以及性能优化等特性，是您理想的每日启动页和全天候实用助手。

• 快速 - 网站在构建时静态生成，实现即时加载。
• 安全 - 所有对后端服务的 API 请求均经过代理，确保您的 API 密钥安全隐藏。社区持续对其进行安全审查。
• 全平台支持 - 为 AMD64、ARM64 架构构建镜像。
• 全 i18n 支持 - 支持超过 40 种语言。
• 服务与网页书签 - 可在主页添加自定义链接。
• Docker 集成 - 容器状态与统计信息。通过标签实现服务自动发现。
• 服务集成 - 超过 100 种服务集成，包括流行的 Starr 系列和自托管应用。
• 信息与实用小部件 - 天气、时间、日期、搜索等功能。
• 以及更多...

Docker 集成

Homepage 内置 Docker 支持，可基于标签自动发现并添加服务到主页。更多信息请参见 Docker 服务发现 页面。

服务小部件

Homepage 还支持数百种第三方服务，包括所有流行的 *arr 类应用以及大多数主流自托管应用。部分示例包括：Radarr、Sonarr、Lidarr、Bazarr、Ombi、Tautulli、Plex、Jellyfin、Emby、Transmission、qBittorrent、Deluge、Jackett、NZBGet、SABnzbd 等。除服务集成外，Homepage 还提供多种信息提供程序，通过各类外部第三方 API 获取信息。更多信息请参见 服务 页面。

信息小部件

Homepage 内置多种信息提供程序支持，包括天气、时间、日期、搜索、Glances 等。系统和状态信息显示在页面顶部。更多信息请参见 信息提供程序 页面。

自定义

Homepage 高度可定制，支持自定义主题、自定义 CSS 和 JS、自定义布局、格式设置、本地化等。更多信息请参见 设置 页面。

快速开始

有关配置选项、示例等更多信息，请 查阅 Homepage 文档。

安全注意事项 🔒

[!IMPORTANT] 请注意，使用小部件等功能时，Homepage 可能会访问个人信息（例如来自家庭自动化系统的信息）。为保护您的信息隐私，如果 Homepage 可从任何不受信任的网络访问，必须：

1. 必须 部署在反向代理（和/或 ***）之后，该代理需强制实施身份验证、TLS 并严格验证 Host 头。
2. 可选的内置 OIDC 登录流程或简单密码登录（需手动启用）提供简单的“已认证/未认证”保护机制。

使用 Docker

使用 docker compose：

services:
  homepage:
    image: ghcr.io/gethomepage/homepage:latest
    container_name: homepage
    environment:
      HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # 必需，可能需要端口。详见 gethomepage.dev/installation/#homepage_allowed_hosts
      PUID: 1000 # 可选，您的用户 ID
      PGID: 1000 # 可选，您的组 ID
    ports:
      - 3000:3000
    volumes:
      - /path/to/config:/app/config # 确保本地配置目录已存在
      - /var/run/docker.sock:/var/run/docker.sock:ro # 可选，用于 Docker 集成
    restart: unless-stopped

或使用 docker run：

docker run --name homepage \
  -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev \
  -e PUID=1000 \
  -e PGID=1000 \
  -p 3000:3000 \
  -v /path/to/config:/app/config \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  --restart unless-stopped \
  ghcr.io/gethomepage/homepage:latest

从源码构建

首先，克隆仓库：

git clone https://github.com/gethomepage/homepage.git

然后安装依赖并构建生产版本：

pnpm install
pnpm build

如果是首次启动，请将 src/skeleton 目录复制到 config/ 以生成初始示例配置文件。

最后，以生产模式运行服务器：

HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev:1234 pnpm start

配置

有关配置的更多信息，请参考 Homepage 文档网站。所有关于配置 Homepage 的必要信息均已包含在内。在寻求帮助前，请仔细阅读文档，因为大多数问题在文档中已有解答，或属于简单的 YAML 配置问题。

开发

安装 NPM 包，本项目使用 https://pnpm.io/（推荐您也使用）：

pnpm install

启动开发服务器：

pnpm dev

打开 http://localhost:3000 开始开发。

这是一个 https://nextjs.org/ 应用，更多信息请参见其官方文档。

文档

Homepage 文档可在 [***] 查看。

Homepage 使用 Zensical 构建文档。要在本地运行文档，首先安装依赖：

uv sync

然后启动开发服务器：

uv run zensical serve # 或使用 build 命令构建静态网站

支持与建议

如果您有任何问题、建议或一般性问题，请在 https://github.com/gethomepage/homepage/discussions 页面发起讨论。

故障排除

除文档外，故障排除指南 可帮助解决许多基本配置或网络问题。如果遇到问题，这是一个很好的起点。

贡献与贡献者

欢迎贡献！更多信息请参见 CONTRIBUTING.md 文件。

感谢超过 200 位贡献者，是他们的努力成就了今天的项目！

特别感谢 https://github.com/shamoon，他从一开始就是这个社区的核心支柱。