obeoneorg/multi-registry-cache repository overview

flowchart TB
    subgraph Clients
        D[Docker / containerd]
        K[Kubernetes nodes]
    end

    subgraph Cache Stack
        T[Traefik Proxy<br>TLS + routing]
        R1[Registry: docker.io]
        R2[Registry: ghcr.io]
        R3[Registry: quay.io]
        RN[Registry: ...]
        RE[Redis<br>blob cache]
    end

    subgraph Upstream
        U1[(Docker Hub)]
        U2[(GHCR)]
        U3[(Quay)]
        UN[(...)]
    end

    D & K -->|pull| T
    T --> R1 & R2 & R3 & RN
    R1 & R2 & R3 & RN --> RE
    R1 -.->|cache miss| U1
    R2 -.->|cache miss| U2
    R3 -.->|cache miss| U3
    RN -.->|cache miss| UN

# Docker — interactive setup
docker run --rm -ti -v "./config.yaml:/app/config.yaml" obeoneorg/multi-registry-cache setup

# Docker — generate compose/ from an existing config.yaml
docker run --rm -v "./config.yaml:/app/config.yaml" -v "./compose:/app/compose" obeoneorg/multi-registry-cache generate

flowchart LR
    A["1️⃣ setup"] --> B["2️⃣ edit config"] --> C["3️⃣ generate"] --> D["4️⃣ docker compose up"]

# 1. Create config interactively
multi-registry-cache setup

# 2. Fine-tune config.yaml (TLS, storage, hostnames…)
# See docs/configuration.md

# 3. Generate the stack
multi-registry-cache generate

# 4. Start
cd compose && docker compose up -d

# /etc/containerd/config.toml
[plugins."io.containerd.grpc.v1.cri".registry.mirrors]
  [plugins."io.containerd.grpc.v1.cri".registry.mirrors."docker.io"]
    endpoint = ["https://dockerhub.registry-cache.example.net"]
  [plugins."io.containerd.grpc.v1.cri".registry.mirrors."ghcr.io"]
    endpoint = ["https://ghcr.registry-cache.example.net"]

sudo systemctl restart containerd

{ "registry-mirrors": ["https://dockerhub.registry-cache.example.net"] }

sudo systemctl daemon-reload && sudo systemctl restart docker

# /etc/rancher/k3s/registries.yaml
mirrors:
  docker.io:
    endpoint: ["https://dockerhub.registry-cache.example.net"]
  ghcr.io:
    endpoint: ["https://ghcr.registry-cache.example.net"]