如何安装和使用 `hub-mirror` 开源项目

如何安装和使用 hub-mirror 开源项目

hub-mirror🚀 gcr.io、registry.k8s.io、k8s.gcr.io、quay.io、ghcr.io 等国外镜像加速下载服务项目地址:https://gitcode.com/gh_mirrors/hu/hub-mirror

本文将引导您逐步了解并使用 hub-mirror 项目，这是一个用于创建 Docker Hub 镜像的工具。

1. 项目目录结构及介绍

在解压或克隆 hub-mirror 项目后，您通常会看到以下基本目录结构：

hub-mirror/
├── config.yml        # 主配置文件
├── scripts/          # 包含辅助脚本的目录
│   ├── run.sh         # 启动脚本
│   └── ...            # 其他相关脚本
└── logs/              # 存储日志的目录

• config.yml: 项目的主要配置文件，用于设定镜像同步规则等。
• scripts/: 包含用于运行和管理 hub-mirror 的脚本。
  • run.sh: 启动脚本，执行镜像同步操作。
• logs/: 日志文件存放位置，记录运行过程中的详细信息。

2. 项目启动文件介绍

run.sh

run.sh 是主要的启动脚本，执行时会读取配置文件并开始镜像的同步工作。您可以按照下面的方式运行它：

cd hub-mirror
./scripts/run.sh

确保您的 shell 能够执行此脚本（例如通过 chmod +x scripts/run.sh 来给予执行权限）。

3. 项目配置文件介绍

config.yml

config.yml 文件是 hub-mirror 的核心配置文件，包含如下关键部分：

示例配置文件:

mirrors:
  - name: example-mirror
    registry: http://localhost:5000  # 镜像仓库地址
    repos:
      - library/nginx:latest           # 同步 nginx 最新版
      - myuser/myimage:tag1             # 同步指定用户和标签的镜像
      - ...
    credentials:                      # 用户名和密码，用于访问私有仓库
      username: your_username
      password: your_password
    schedule: "0 * * * *"            # CRON 表达式，定义同步频率

logging:                             # 日志配置
  level: info                        # 日志级别 (debug, info, warn, error)
  path: ./logs/mirror.log            # 日志文件路径

• mirrors: 定义一个或多个镜像仓库。每个仓库包含其名称 (name)、镜像仓库地址 (registry)、要同步的仓库列表 (repos)以及认证信息（credentials）。
  • repos: 用法如上例，可以指定库名、用户名/组织名和标签。library 是 Docker 官方库的别名，表示同步官方镜像。
• schedule: 使用 CRON 表达式设置镜像同步的定时任务。
• logging: 设置日志级别和保存路径。

根据实际需求修改 config.yml 文件，并确保所有字段符合要求。

现在您应该对 hub-mirror 有了初步理解，开始配置并运行这个项目，以实现 Docker Hub 镜像的本地同步和管理。如果有任何疑问或需要进一步的帮助，请查阅项目的官方文档或在 GitHub 上提交问题。

hub-mirror🚀 gcr.io、registry.k8s.io、k8s.gcr.io、quay.io、ghcr.io 等国外镜像加速下载服务项目地址:https://gitcode.com/gh_mirrors/hu/hub-mirror