chko/docker-pushrm

Docker Push Readme 镜像文档

镜像概述

本镜像为 https://github.com/christian-korneck/docker-pushrm 工具的容器化版本，该工具可从本地Markdown文件更新Dockerhub、Quay或Harbor上容器仓库的README文档。

!https://raw.githubusercontent.com/christian-korneck/docker-pushrm/master/assets/container_registries.png

核心功能和特性

• 支持多平台：可更新Dockerhub、Quay及Harbor v2容器仓库的README
• 灵活配置：支持通过命令行参数或环境变量进行配置
• 凭据管理：支持通过环境变量或Docker配置文件提供登录凭据
• 调试模式：提供详细日志输出，便于问题排查
• 版本固定：推荐使用主版本标签（如:1）确保稳定性

使用场景和适用范围

• 容器仓库维护者需要更新README文档时
• CI/CD流程中自动化更新容器仓库文档
• 跨多个容器 registry 平台（Dockerhub、Quay、Harbor）管理文档

使用方法和配置说明

示例

推送README到Dockerhub

bash
$ ls
README.md

$ docker run --rm -t \
-v $(pwd):/myvol \
-e DOCKER_USER='my-user' -e DOCKER_PASS='my-pass' \
chko/docker-pushrm:1 --file /myvol/README.md \ 
--short "我的简短描述" --debug my-user/my-repo

...
DEBU 内容验证成功，README已成功推送到仓库服务器

参数解析：

• 使用镜像的主版本标签（chko/docker-pushrm:1），推荐用于大多数场景
• 将当前工作目录挂载为容器内的/myvol卷，以便访问本地README.md
• 通过--file指定README文件路径
• 目标Dockerhub仓库为my-user/my-repo
• 通过环境变量DOCKER_USER和DOCKER_PASS提供凭据
• --debug启用详细日志输出（可选）
• --short设置仓库简短描述（可选）

所有参数也可通过环境变量设置：

bash
$ docker run --rm -t \
-v $(pwd):/myvol \
-e DOCKER_USER='my-user' -e DOCKER_PASS='my-pass' \
-e PUSHRM_PROVIDER=dockerhub -e PUSHRM_FILE=/myvol/README.md \
-e PUSHRM_SHORT='我的简短描述' \
-e PUSHRM_TARGET=docker.io/my-user/my-repo -e PUSHRM_DEBUG=1 \
chko/docker-pushrm:1

推送README到Harbor v2 registry服务器

使用--provider harbor2标志：

bash
$ ls
README.md

$ docker run --rm -t \
-v $(pwd):/myvol \
-e DOCKER_USER='my-user' -e DOCKER_PASS='my-pass' \
chko/docker-pushrm:1 --file /myvol/README.md \ 
--provider harbor2 --debug demo.goharbor.io/my-project/my-repo

推送README到Quay.io或Quay registry服务器

• 使用--provider quay标志
• 通过环境变量APIKEY__<SERVER>_<DOMAIN>或DOCKER_APIKEY提供API密钥凭据

bash
$ ls
README.md

$ docker run --rm -t \
-v $(pwd):/myvol \
-e APIKEY__QUAY_IO='my-apikey' \
chko/docker-pushrm:1 --file /myvol/README.md \ 
--provider quay --debug quay.io/my-user/my-repo

环境变量

参数优先级：

• 命令行参数优先级高于环境变量
• 登录环境变量优先级高于Docker配置文件中的凭据