热门搜索:
lsiodev/readme-sync
lsiodev
用于将指定GitHub仓库的README.md文件同步到Docker Hub仓库的实用工具，支持指定分支，基于Alpine构建，同步完成后自动退出。
1 次收藏下载次数: 0状态：社区镜像维护者：lsiodev仓库类型：镜像最近更新：2 年前
lsiodev/readme-sync
概述
lsiodev/readme-sync是由LinuxServer.io团队提供的Docker镜像，主要功能是将指定GitHub仓库中的README.md文件同步到Docker Hub仓库。该镜像基于Alpine构建，设计为一次性执行工具，同步完成后自动退出，不作为长期运行的服务。
核心功能与特性
- README同步：自动将GitHub仓库的README.md复制到Docker Hub仓库
- 分支支持：可指定GitHub仓库的特定分支（默认使用master分支）
- 轻量级：基于Alpine Linux，镜像体积小，资源占用低
- 简单配置：通过环境变量即可完成所有配置
- 一次性执行：同步完成后自动退出，无需持续运行
使用场景
适用于Docker镜像维护者，需要保持GitHub仓库文档与Docker Hub仓库描述一致的场景。通过该工具可以自动化同步README文档，减少手动操作，确保文档的一致性和及时性。
使用方法
Docker Run命令示例
bashdocker run --rm=true \ -e DOCKERHUB_USERNAME=<你的Docker Hub用户名> \ -e DOCKERHUB_PASSWORD=<你的Docker Hub密码> \ -e GIT_REPOSITORY=<GitHub仓库，例如：linuxserver/docker-readme-sync> \ -e DOCKER_REPOSITORY=<Docker Hub仓库，例如：lsiodev/docker-readme-sync> \ -e GIT_BRANCH=<GitHub分支，可选，默认：master> \ lsiodev/readme-sync bash -c 'node sync'
参数说明
| 参数 | 功能 |
|---|---|
-e DOCKERHUB_USERNAME | Docker Hub用户名 |
-e DOCKERHUB_PASSWORD | Docker Hub密码 |
-e GIT_REPOSITORY | GitHub仓库路径，格式为：用户名/仓库名（例如：linuxserver/docker-readme-sync） |
-e DOCKER_REPOSITORY | Docker Hub仓库路径，格式为：用户名/仓库名（例如：lsiodev/docker-readme-sync） |
-e GIT_BRANCH | GitHub仓库分支，可选参数，默认值为master |
版本历史
| 日期 | 变更内容 |
|---|---|
| 13.01.21 | 使用ghcr基础镜像，支持从external文件夹回退获取简化版README |
| 28.07.20 | 基础镜像更新为Alpine 3.12 |
| 20.08.18 | 基础镜像更新为Alpine 3.8 |
| 28.02.18 | 仓库迁移为Node.js实现 |
| 17.11.17 | 添加GitHub分支支持 |
| 16.10.16 | 合并Ruby应用 |
| 11.10.16 | 初始开发版本发布 |
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 readme-sync 镜像标签
docker pull docker.xuanyuan.run/lsiodev/readme-sync:<标签>
DockerHub 原生拉取命令
docker pull lsiodev/readme-sync:<标签>
更多 readme-sync 镜像推荐
linuxserver/readme-sync
linuxserver
已弃用的工具镜像，用于将指定GitHub仓库的README.md复制到DockerHub仓库，基于Alpine，执行同步后即退出，不提供支持且不再更新。
2 次收藏2.5千+ 次下载
2 年前更新
syncfusion/word-processor-server
syncfusion
Syncfusion Word Processor（文档编辑器）是具备类似Microsoft Word编辑功能的组件，用于创建、编辑、查看和打印Word文档，提供文本编辑、内容格式化、图片及表格调整等常见文字处理能力。
2 次收藏50万+ 次下载
4 天前更新
linuxserver/resilio-sync
linuxserver
LinuxServer.io提供的Resilio Sync容器，用于高效的P2P文件同步。
251 次收藏5000万+ 次下载
6 天前更新
syncfusion/pdfviewer-server
syncfusion
Syncfusion PDF Viewer后端Docker镜像，提供Web应用中PDF文件的查看、打印、表单填写和注释功能，支持JavaScript、Angular、React等多种前端框架，商业产品需有效许可证用于生产环境，可快速部署到基础设施。
4 次收藏10万+ 次下载
4 天前更新
ubuntu/git-sync
Ubuntu 官方镜像
克隆Git仓库并保持与上游仓库同步
3 次收藏1万+ 次下载
12 天前更新
linuxserver/syncthing
linuxserver
LinuxServer.io提供的Syncthing容器，用于跨设备文件同步。
613 次收藏1亿+ 次下载
2 天前更新
轩辕镜像配置手册
探索更多轩辕镜像的使用方法，找到最适合您系统的配置方式
Docker 配置
登录仓库拉取
通过 Docker 登录认证访问私有仓库
专属域名拉取
无需登录使用专属域名
K8s Containerd
Kubernetes 集群配置 Containerd
K3s
K3s 轻量级 Kubernetes 镜像加速
Dev Containers
VS Code Dev Containers 配置
Podman
Podman 容器引擎配置
Singularity/Apptainer
HPC 科学计算容器配置
其他仓库配置
ghcr、Quay、nvcr 等镜像仓库
Harbor 镜像源配置
Harbor Proxy Repository 对接专属域名
Portainer 镜像源配置
Portainer Registries 加速拉取
Nexus 镜像源配置
Nexus3 Docker Proxy 内网缓存
系统配置
需要其他帮助？请查看我们的 常见问题Docker 镜像访问常见问题解答 或 提交工单
镜像拉取常见问题
使用与功能问题
配置了专属域名后，docker search 为什么会报错？
docker search 限制
Docker Hub 上有的镜像，为什么在轩辕镜像网站搜不到？
站内搜不到镜像
机器不能直连外网时，怎么用 docker save / load 迁镜像？
离线 save/load
docker pull 拉插件报错（plugin v1+json）怎么办？
插件要用 plugin install
WSL 里 Docker 拉镜像特别慢，怎么排查和优化？
WSL 拉取慢
轩辕镜像安全吗？如何用 digest 校验镜像没被篡改？
安全与 digest
第一次用轩辕镜像拉 Docker 镜像，要怎么登录和配置？
新手拉取配置
轩辕镜像合规吗？轩辕镜像的合规是怎么做的？
镜像合规机制
错误码与失败问题
docker pull 提示 manifest unknown 怎么办？
manifest unknown
docker pull 提示 no matching manifest 怎么办？
no matching manifest（架构）
镜像已拉取完成，却提示 invalid tar header 或 failed to register layer 怎么办？
invalid tar header（解压）
Docker pull 时 HTTPS / TLS 证书验证失败怎么办？
TLS 证书失败
Docker pull 时 DNS 解析超时或连不上仓库怎么办？
DNS 超时
docker 无法连接轩辕镜像域名怎么办？
域名连通性排查
Docker 拉取出现 410 Gone 怎么办？
410 Gone 排查
出现 402 或「流量用尽」提示怎么办？
402 与流量用尽
Docker 拉取提示 UNAUTHORIZED（401）怎么办？
401 认证失败
遇到 429 Too Many Requests（请求太频繁）怎么办？
429 限流
docker login 提示 Cannot autolaunch D-Bus，还算登录成功吗？
D-Bus 凭证提示
为什么会出现「单层超过 20GB」或 413，无法加速拉取？
413 与超大单层
账号 / 计费 / 权限
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"