timoreymann/yal

yal - 轻量级链接中心镜像

镜像概述

yal（Yet Another Landingpage）是一个轻量级Docker镜像，旨在提供简单、可自定义的链接中心解决方案。它允许用户快速构建包含多个分类链接的页面，并集成搜索功能，支持自定义品牌元素（如logo、背景图），且可通过静态生成或HTTP服务两种方式部署，资源占用低且配置灵活。

核心功能与特性

• 静态生成网站：支持生成纯静态HTML文件，可通过任意静态服务器托管
• 单二进制文件：基于Go语言构建，无依赖，部署简单
• 非root运行：默认以非root用户权限运行，提升安全性
• 集成搜索功能：内置搜索框，支持按标题、描述筛选链接
• 品牌自定义：可配置logo、吉祥物、背景图等品牌元素
• 外部图片内联：启动时自动内联外部图片，减少外部依赖
• 无障碍支持：兼容屏幕阅读器，确保无障碍访问

使用场景

• 个人导航页：聚合个人常用链接（社交媒体、博客、项目等）
• 团队资源中心：集中展示团队文档、工具、内部系统链接
• 项目入口页：作为开源项目或产品的导航页面，链接到文档、GitHub、演示等
• CI/CD集成：通过CI自动生成并部署静态链接页面，实现配置即代码

使用方法

1. 通过Docker容器运行

基本运行命令

bash
docker run -d \
  --name yal \
  -p 2024:2024 \
  -v ./config:/app/config \
  -v ./images:/app/images \
  -e YAL_PAGE_TITLE="我的链接中心" \
  -e YAL_MASCOT="mascot" \
  -e YAL_LOGO="logo" \
  timoreymann/yal:latest

Docker Compose配置

yaml
version: "3.5"
services:
  yal:
    image: timoreymann/yal:latest  # 建议指定具体版本号以确保稳定性
    restart: always
    ports:
      - "8080:2024"  # 将主机8080端口映射到容器2024端口
    volumes:
      - ./config:/app/config  # 存放配置文件（items.json和searchEngines.json）
      - ./icons:/app/icons    # 可选，存放本地图标
      - ./images:/app/images  # 存放图片资源（favicon、背景图等）
    environment:
      YAL_PORT: 2024                  # 容器内HTTP服务端口
      YAL_PAGE_TITLE: "团队资源链接中心"  # 页面标题
      YAL_CONFIG_FOLDER: /app/config  # 配置文件目录
      YAL_IMAGES_FOLDER: /app/images  # 图片资源目录
      YAL_MASCOT: mascot              # 左侧吉祥物图片（无需扩展名）
      YAL_LOGO: logo                  # 右侧logo图片（无需扩展名）
      YAL_BACKGROUND: background      # 背景图片（无需扩展名）
      YAL_FAVICON: favicon            # 网站图标（无需扩展名）

2. 生成静态HTML文件

若需生成静态HTML文件而非运行HTTP服务，可通过以下步骤：

1. 下载对应平台的https://github.com/timo-reymann/yal/releases/latest
2. 执行命令生成HTML：

   bash
   ./yal --render --output linkhub.html
   

3. 通过Nginx、Apache等静态服务器托管生成的linkhub.html

3. 与CI/CD工具集成

使用CI专用镜像timoreymann/yal:ci（或版本化标签timoreymann/yal:{version}-ci）自动生成静态页面。

CircleCI配置示例

yaml
version: 2.1
jobs:
  build-page:
    docker:
      - image: timoreymann/yal:ci
    steps:
      - checkout  # 拉取包含配置和资源的代码库
      - run:
          name: 生成yal链接页面
          command: yal
      - store_artifacts:
          path: templated.html  # 存储生成的静态文件
workflows:
  build_link_hub:
    jobs:
      - build-page

Gitlab CI配置示例

yaml
stages:
  - build

build-page:
  stage: build
  image:
    name: timoreymann/yal:ci
    entrypoint: [""]  # 覆盖默认入口点
  script:
    - yal  # 生成静态页面
  artifacts:
    paths:
      - templated.html  # 保存生成的静态文件作为制品

配置说明

环境变量与命令行参数

配置文件

searchEngines.json

配置搜索框使用的搜索引擎，格式如下：

json
[
  {
    "title": "Google",
    "urlPrefix": "https://google.com/search?q="  // 搜索词将附加到该URL后
  },
  {
    "title": "GitHub",
    "urlPrefix": "https://github.com/search?q="
  }
]

items.json

配置页面显示的链接分类和条目，格式如下：

json
[
  {
    "title": "开发资源",  // 分类标题
    "entries": [
      {
        "text": "GitHub",  // 链接显示文本
        "link": "https://github.com",  // 目标链接
        "description": "代码托管平台",  // 搜索和悬停提示描述
        "icon": "https://github.githubassets.com/favicon.ico"  // 图标URL或本地路径
      },
      {
        "text": "Stack Overflow",
        "link": "https://stackoverflow.com",
        "description": "技术问答社区",
        "icon": "icons/stackoverflow.png"  // 本地图标路径（相对于icons目录）
      }
    ]
  }
]

替代方案对比

yal专注于轻量、简洁和易用性，与其他链接页面工具相比：

• Heimdall：功能丰富但资源占用较高，适合需要 widgets 的场景
• jump：设计简洁但隐藏功能较多，适合极简需求
• homepage：空间利用率高，适合需要复杂布局和 widgets 的团队
• homer：UI 相对臃肿，适合喜欢丰富视觉效果的用户

yal的优势在于静态生成能力、低资源占用和极简配置，适合追求简单高效的链接中心需求。