readme-sync

镜像概述和主要用途

readme-sync 是一个用 Node.js 编写的简单服务器，提供 API 接口，用于根据指定 GitHub 仓库的 README.md 文件内容更新 DockerHub 仓库的完整描述。

核心功能和特性

• 提供 HTTP API 接口，支持通过 GET 请求触发更新操作
• 可指定 GitHub 仓库分支（默认使用 master 分支）
• 基于 Alpine Linux 构建，体积小巧，资源占用低
• 使用 s6 服务管理，确保服务稳定运行

使用场景和适用范围

适用于需要保持 DockerHub 仓库描述与 GitHub 项目 README.md 同步的开发者或团队，尤其适合开源项目维护者，可避免手动更新 DockerHub 描述的重复工作。

详细使用方法和配置说明

基本部署命令

docker create --name=readmesync \
-v <主机配置文件路径>:/config \
-p 80:80 \
antilax3/readme-sync

参数说明

参数格式为 <主机端>:<容器端>，表示主机与容器之间的映射关系：

用户/组标识符

为避免主机与容器间的文件权限问题，可通过 PUID 和 PGID 指定运行用户：

1. 在主机执行 id <用户名> 获取用户 ID 和组 ID，例如：

   $ id dockeruser
   uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
   

2. 在启动命令中添加 -e PUID=1001 -e PGID=1001

卷结构

容器仅使用一个卷 /config，用于存储配置文件：

config/
└── readmesync.json  # 应用配置文件

配置文件说明

首次运行时，容器会自动在 /config 卷生成 readmesync.json 文件，包含以下必填参数：

{
  "dockerhub_username": "你的DockerHub用户名",  // 必填，DockerHub账号用户名
  "dockerhub_password": "你的DockerHub密码"   // 必填，DockerHub账号密码
}

API 使用方法

通过发送 GET 请求调用更新接口：

基本用法（使用 master 分支）

http://<服务器IP>:<端口>/description/update?github_repo=<GitHub仓库路径>&dockerhub_repo=<DockerHub仓库名>

指定分支用法

http://<服务器IP>:<端口>/description/update?github_repo=<GitHub仓库路径>&github_branch=<分支名>&dockerhub_repo=<DockerHub仓库名>

版本历史

• 2025年7月4日：更新为 Alpine 3.22 镜像和 s6 v3 服务结构
• 2018年2月22日：更新为 Alpine 3.7 镜像并通过 Jenkins 构建
• 2018年2月18日：初始版本发布