sheogorath/readme-to-dockerhub

README to Docker Hub

![Matrix channel #sheogorath:shivering-isles.com]([] ![ at microblog.shivering-isles.com]([] ![ @SISheogorath]([***]

这是一个快速工具，用于将README.md文件推送到Docker Hub。

镜像概述

本镜像提供一个小型NodeJS应用，支持通过CI（持续集成）流程自动更新Docker Hub仓库的完整描述，减少手动维护仓库文档的工作量。

核心功能

1. 自动推送指定README.md文件到Docker Hub仓库作为完整描述
2. 通过环境变量灵活配置认证信息、仓库参数及文件路径
3. 支持挂载本地README文件或目录，适配不同场景需求

使用场景

• CI/CD流程中自动同步Docker Hub仓库描述与代码仓库README
• 批量维护多个Docker Hub仓库的描述文档
• 确保仓库描述实时更新，提升用户体验

配置说明

环境变量

镜像通过环境变量配置，可用变量如下：

挂载README.md

默认推送/data/README.md文件，可通过以下方式挂载：

• 挂载目录：-v /path/to/repository:/data/（适用于根目录含README.md的仓库）
• 直接挂载文件：-v /path/to/description.md:/data/README.md（适用于非标准命名文件）

注意：文件名区分大小写，若文件为readme.md需直接挂载文件。

部署示例

构建镜像

console
docker build -t readme-to-hub .

运行容器

console
docker run --rm \
    -v /path/to/readme.md:/data/README.md \
    -e DOCKERHUB_USERNAME=myhubuser \
    -e DOCKERHUB_PASSWORD=myhubpassword \
    -e DOCKERHUB_REPO_PREFIX=myorga \
    -e DOCKERHUB_REPO_NAME=myrepo \
     readme-to-hub

附加信息

推送用户需为Docker Hub仓库管理员。

实现参考

本镜像已被以下项目使用：

• https://github.com/Adam-/inspircd-docker/blob/master/.travis.yml
• https://github.com/Adam-/anope-docker/blob/master/.travis.yml
• https://github.com/SISheogorath/minecraft-docker/blob/master/.travis.yml
• https://github.com/SISheogorath/isso-docker/blob/master/.travis.yml

更新说明

拉取最新镜像即可更新：

console
docker pull sheogorath/readme-to-dockerhub

废弃特性

• DOCKERHUB_REPO：已重命名为DOCKERHUB_REPO_NAME，避免与前缀混淆。

许可协议

镜像内软件许可见docker-hub-api；本仓库内容以GPL-3协议发布。

用户反馈

问题反馈

通过https://github.com/SISheogorath/readme-to-dockerhub/issues%E6%8F%90%E4%BA%A4%E9%97%AE%E9%A2%98%E3%80%82

贡献指南

欢迎提交Pull Request，开发指南见：[***]