Skip to content

lhns/docker-registry-cache

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docker-registry-cache

Docker Workflow Release Notes Apache License 2.0 Scala Steward badge

A multi-registry docker image cache.

It uses Docker's official registry internally and spawns one instance for each configured registry while it proxies requests to the corresponding registry.

Usage

Instead of my/image:latest you just specify 127.0.0.1:5000/my/image:latest.

This also works for 127.0.0.1:5000/ghcr.io/my/image:latest and 127.0.0.1:5000/debian.

Installation

  • Deploy the stack config as shown below
  • Add the following to your /etc/docker/daemon.json:
{
  "insecure-registries" : ["127.0.0.1:5000"]
}
  • Restart the docker daemon (or reload)
  • Change all image references that you want to cache from my/image:latest to 127.0.0.1:5000/my/image:latest

Stack Config

Filesystem Storage Backend

version: '3.8'

services:
  proxy:
    image: ghcr.io/lhns/docker-registry-cache:0.3.0
    environment:
      CONFIG: |
        [
          {"registry": "registry-1.docker.io", "variables": {"REGISTRY_PROXY_USERNAME": "my_dockerhub_id", "REGISTRY_PROXY_PASSWORD": "my_dockerhub_token"}},
          "ghcr.io",
          "gcr.io"
        ]
      #REGISTRY_STORAGE_DELETE_ENABLED: 'true' bug https://forums.docker.com/t/private-registry-not-working-after-deleting-an-image/105227
    volumes:
      - /docker-registry-cache:/var/lib/registry
    ports:
      - "5000:5000"
  zzz_proxy:
    # This dummy service prevents the image from getting pruned
    image: ghcr.io/lhns/docker-registry-cache:0.3.0
    entrypoint: tail -f /dev/null
    deploy:
      mode: global

MinIO Storage Backend

version: '3.8'

services:
  proxy:
    image: ghcr.io/lhns/docker-registry-cache:0.3.0
    environment:
      CONFIG: |
        [
          {"registry": "registry-1.docker.io", "variables": {"REGISTRY_PROXY_USERNAME": "my_dockerhub_id", "REGISTRY_PROXY_PASSWORD": "my_dockerhub_token"}},
          "ghcr.io",
          "gcr.io"
        ]
      REGISTRY_STORAGE: 's3'
      REGISTRY_STORAGE_S3_BUCKET: 'registry'
      REGISTRY_STORAGE_S3_REGION: 'minio'
      REGISTRY_STORAGE_S3_REGIONENDPOINT: 'http://s3:9000'
      REGISTRY_STORAGE_S3_ACCESSKEY: 'minioadmin'
      REGISTRY_STORAGE_S3_SECRETKEY: 'minioadmin'
      #REGISTRY_STORAGE_DELETE_ENABLED: 'true' bug https://forums.docker.com/t/private-registry-not-working-after-deleting-an-image/105227
    networks:
      - s3
    ports:
      - "5000:5000"
    deploy:
      update_config:
        order: start-first
  s3:
    image: minio/minio
    entrypoint: /bin/sh -c 'mkdir /data/registry & exec /usr/bin/docker-entrypoint.sh "$$@"' --
    command: server --address 0.0.0.0:9000 /data
    environment:
      MINIO_ACCESS_KEY: 'minioadmin'
      MINIO_SECRET_KEY: 'minioadmin'
    volumes:
      - /docker-registry-cache:/data
    networks:
      - s3
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
      interval: 15s
  zzz_proxy:
    # This dummy service prevents the image from getting pruned
    image: ghcr.io/lhns/docker-registry-cache:0.3.0
    entrypoint: tail -f /dev/null
    deploy:
      mode: global
  zzz_s3:
    # This dummy service prevents the image from getting pruned
    image: minio/minio
    entrypoint: tail -f /dev/null
    deploy:
      mode: global

networks:
  s3:
    driver: overlay

Example Service

version: '3.8'

services:
  traefik:
    image: 127.0.0.1:5000/traefik

Corporate Proxy

    environment:
      http_proxy: 'https://my-proxy:8080'
      https_proxy: 'https://my-proxy:8080'
      no_proxy: '127.0.0.0/8,localhost,s3'

Environment Variables

CONFIG must contain a JSON list of either registry host strings or objects with the following structure {"registry": "ghcr.io", "variables": {"TEST": "foo"}}

The internally spawned registry processes will also inherit all environment variables so you can configure all internal registries as described in the official documentation. You can also configure the internal registries individually using the variables section in the aforementioned JSON structure.

Docker builds

https://github.com/users/lhns/packages/container/package/docker-registry-cache

https://hub.docker.com/r/lolhens/docker-registry-cache

License

This project uses the Apache 2.0 License. See the file called LICENSE.