rantanevich/homepage

主页应用（Homepage）

镜像概述

这是一个简单的Web应用，作为可定制化主页使用，支持用户通过YAML配置文件展示各类服务的图标、描述及访问链接。应用灵感来源于https://github.com/notclickable-jordan/starbase-80%E3%80%82

核心功能

1. 通过YAML配置定义主页标题、logo、服务分类及具体条目
2. 支持自定义图标目录，优先加载用户提供的图标资源
3. 图标解析遵循自定义目录→嵌入式静态图标→默认图标（no-icon.svg）的优先级规则
4. 允许直接使用URL作为图标来源，灵活适配各类场景

使用场景

• 个人常用服务导航：整合工具、平台链接，快速访问
• 团队内部门户：集中展示监控、管理类服务入口，提升协作效率
• 家庭网络管理：整合智能家居、NAS等设备链接，统一管理

配置说明

应用依赖YAML格式的配置文件，默认读取根目录下的config.yml，可通过CONFIG_PATH环境变量指定路径。

配置示例

yaml
title: 我的主页
logo: logo.png
icons: /icons

categories:
- name: 管理工具
  services:
  - name: Kafka UI
    url: https://kafka-ui.example.com/
    icon: kafka-ui
- name: 监控系统
  services:
  - name: Grafana
    description: 数据可视化服务
    url: https://grafana.example.com/
    icon: grafana
  - name: Prometheus
    description: 监控系统
    url: https://prometheus.example.com/
    icon: prometheus

自定义图标

在配置文件的icons字段指定图标目录路径，应用会优先从该目录加载图标；若未找到，则使用嵌入式静态图标；仍未找到时，使用默认图标no-icon.svg。此外，可直接在服务的icon字段填写URL，应用将直接使用该URL的图片资源。

部署示例

Docker Run命令

bash
docker run -d \
  --name homepage \
  -p 8080:80 \
  -v ./config.yml:/app/config.yml \
  -v ./my-icons:/app/icons \
  rantanevich/homepage

Docker Compose配置

yaml
version: '3.8'
services:
  homepage:
    image: rantanevich/homepage
    container_name: homepage
    ports:
      - "8080:80"
    volumes:
      - ./config.yml:/app/config.yml
      - ./my-icons:/app/icons
    restart: unless-stopped