bh213/homepage-links

homepage-links

镜像概述

homepage-links是一个简单的网页应用，用于展示可配置的链接集合。它特别适用于家庭实验室环境或Docker Compose部署场景，当存在多个Web服务器/端口同时运行时，可通过该应用集中管理和快速访问各个服务链接。

核心功能与特性

• 可配置链接组：通过配置文件定义多个链接组，每组包含多个服务链接
• 自定义颜色方案：支持定义多套颜色方案，为不同链接组应用不同配色
• Font Awesome图标：为每个链接配置Font Awesome图标，增强视觉识别
• 短URL重定向：支持为链接设置简短、有意义的URL路径，实现便捷访问

使用场景

• 家庭实验室环境中集中管理路由器、NAS、网络设备等服务链接
• Docker Compose部署中整合多个容器服务的访问入口
• 需要快速访问多个Web服务的个人或小型团队使用场景

配置说明

配置文件位置

应用配置存储在容器内的 config/config.yml 文件中，建议通过外部挂载方式提供自定义配置。

配置参数详解

全局配置

• title：网页标题，显示在页面顶部
• colors：定义颜色方案集合，每个颜色方案包含多个十六进制颜色值（无需#前缀）

链接组配置（groups）

每个链接组包含以下参数：

• name：链接组名称，显示在组标题栏
• palette：指定使用的颜色方案（对应colors中定义的方案名称）
• items：链接项列表，每个链接项包含：
  • name：链接名称（显示文本）
  • link：实际重定向目标URL（必填）
  • url：可选，短链接路径（如配置此项，可通过应用访问路径直接重定向）
  • description：链接描述文本（可选）
  • icon：Font Awesome图标名称（如fa-cloud，需使用Font Awesome图标库中的有效名称）

配置示例

yaml
title: 我的服务主页
colors:
  pack:
     - 'DD1E2F'
     - 'EBB035'
     - '06A2CB'
     - '218559'
     - 'D0C6B1'
     - '192823'
  pink:
     - 'C5AAF5'
     - 'A3CBF1'
     - '79BFA1'
     - 'F5A352'
     - 'FB7374'
     - '423C40'

groups:
  - name: 常用链接
    palette: pack
    items:
      - name: 天气
        url: /weather
        link: http://weather.com
        description: 本地天气查询
        icon: fa-cloud

  - name: 家庭实验室
    palette: pink
    items:
      - name: PFsense
        url: /pfsense
        link: http://192.168.0.1
        description: 路由器与防火墙
        icon: fa-ban

使用说明

关键功能说明

• 链接重定向：link字段指定用户点击链接后实际重定向的目标URL
• 短URL功能：通过url字段配置简短路径，例如应用运行在http://home.lan时，访问http://home.lan/pfsense会自动重定向到http://192.168.0.1
• 图标使用：icon字段需填写Font Awesome图标名称，可从Font Awesome图标库查询有效图标名称

Docker部署示例

基本运行命令

bash
docker run -d \
  -p 80:80 \
  -v /path/to/your/config.yml:/config/config.yml \
  --name homepage-links \
  bh213/homepage-links

参数说明

• -p 80:80：将容器的80端口映射到主机的80端口（可根据需要修改主机端口）
• -v /path/to/your/config.yml:/config/config.yml：挂载本地配置文件到容器内的配置路径
• --name homepage-links：指定容器名称

界面预览

!https://raw.githubusercontent.com/bh213/homepage-links/master/docs/screenshot.png "homepage-links界面截图"

截图展示了应用的基本界面，包含多个链接组及对应服务链接，每个链接配有图标和描述信息。