Homepage

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

Homepage 构建由 DigitalOcean 友情支持。

功能特性

凭借快速搜索、书签、天气支持、广泛的集成和小部件、优雅现代的设计以及对性能的专注，Homepage 是您理想的每日开端和全天便捷伴侣。

• 快速 - 网站在构建时静态生成，实现即时加载。
• 安全 - 所有对后端服务的 API 请求均经过代理，确保您的 API 密钥隐藏。社区持续对其进行安全审查。
• 面向所有人 - 为 AMD64、ARM64 架构构建镜像。
• 完整国际化 - 支持超过 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 文档。

安全注意事项 🔒

请注意，使用小部件等功能时，Homepage 可能会访问个人信息（例如来自家庭自动化系统的信息），而 Homepage 目前没有（也不计划）包含任何身份验证层。因此，我们建议将 Homepage 部署在包含身份验证、SSL 等的反向代理之后，和/或 *** 之后。

使用 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 使用 Material for MkDocs 构建文档。要在本地运行文档，首先安装依赖：

pip install -r requirements.txt

然后运行开发服务器：

mkdocs serve # 或使用 build 构建静态网站

支持与建议

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

故障排除

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

贡献与贡献者

欢迎贡献！有关更多信息，请参阅 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