Homepage

一款现代化、全静态、快速、安全且完全代理的高度可定制应用仪表板，支持集成100多种服务并提供多语言翻译。可通过YAML文件或Docker标签发现轻松配置。

功能特性

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当前没有（且计划中也不会）包含任何身份验证层。如果Homepage可从任何不可信网络访问，则必须将其置于反向代理（和/或***）之后，该代理需强制执行身份验证、TLS并严格验证Host头。Homepage中的内置主机检查是一种尽力而为的防护措施，在公网暴露时不应视为安全保障。

使用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/以填充初始示例配置文件。

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

pnpm start

配置

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

开发

安装NPM包，本项目使用pnpm（您也应该使用！）：

pnpm install

启动开发服务器：

pnpm dev

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

这是一个Next.js应用，有关更多信息请参见其文档。

文档

Homepage文档可在[***]

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

uv sync

然后运行开发服务器：

uv run zensical serve # 或使用 build 构建静态站点

支持与建议

如果您有任何问题、建议或一般问题，请在https://github.com/gethomepage/homepage/discussions%E5%8F%91%E8%B5%B7%E8%AE%A8%E8%AE%BA%E3%80%82

故障排除

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

贡献与贡献者

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

感谢200多位贡献者，是他们帮助使这个项目成为今天的样子！

特别感谢https://github.com/shamoon%EF%BC%8C%E4%BB%96%E4%BB%8E%E4%B8%80%E5%BC%80%E5%A7%8B%E5%B0%B1%E6%98%AF%E8%BF%99%E4%B8%AA%E7%A4%BE%E5%8C%BA%E7%9A%84%E6%94%AF%E6%9F%B1%E3%80%82