RPJosh
/
docker-registry-proxy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

release 0.5.0; update README to point to ghcr.io as well as DockerHub

cache-manifests-tiers 0.5.0
Ricardo Pardini 2020-10-30 13:14:39 +01:00
parent 427dd066bd
commit 937b06e593
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -21,8 +21,14 @@ for this to work it requires inserting a root CA certificate into system trusted
## master/:latest is unstable/beta ## master/:latest is unstable/beta
- `:latest` and `:latest-debug` Docker tag is unstable, built from master, and amd64-only - `:latest` and `:latest-debug` Docker tag is unstable, built from master, and amd64-only
- Production/stable is `0.4.2`, see [0.4.2 tag on Github](https://github.com/rpardini/docker-registry-proxy/tree/0.4.2) - this image is multi-arch amd64/arm64 - Production/stable is `0.5.0`, see [0.5.0 tag on Github](https://github.com/rpardini/docker-registry-proxy/tree/0.5.0) - this image is multi-arch amd64/arm64
- The previous version is `0.3.0`, see [0.3.0 tag on Github](https://github.com/rpardini/docker-registry-proxy/tree/0.3.0) (amd64 only)
## Also hosted on GitHub Container Registry (ghcr.io)
- DockerHub image is at `rpardini/docker-registry-proxy:<version>`
- GitHub image is at `ghcr.io/rpardini/docker-registry-proxy:<version>`
- Since 0.5.x, they both carry the same images
- This can be useful if you're already hitting DockerHub's rate limits and can't pull the proxy from DockerHub
## Usage ## Usage
@ -43,7 +49,7 @@ docker run --rm --name docker_registry_proxy -it \
-p 0.0.0.0:3128:3128 \ -p 0.0.0.0:3128:3128 \
-v $(pwd)/docker_mirror_cache:/docker_mirror_cache \ -v $(pwd)/docker_mirror_cache:/docker_mirror_cache \
-v $(pwd)/docker_mirror_certs:/ca \ -v $(pwd)/docker_mirror_certs:/ca \
rpardini/docker-registry-proxy:0.4.2 rpardini/docker-registry-proxy:0.5.0
``` ```
### DockerHub auth ### DockerHub auth
@ -59,7 +65,7 @@ docker run --rm --name docker_registry_proxy -it \
-v $(pwd)/docker_mirror_certs:/ca \ -v $(pwd)/docker_mirror_certs:/ca \
-e REGISTRIES="k8s.gcr.io gcr.io quay.io your.own.registry another.public.registry" \ -e REGISTRIES="k8s.gcr.io gcr.io quay.io your.own.registry another.public.registry" \
-e AUTH_REGISTRIES="auth.docker.io:dockerhub_username:dockerhub_password your.own.registry:username:password" \ -e AUTH_REGISTRIES="auth.docker.io:dockerhub_username:dockerhub_password your.own.registry:username:password" \
rpardini/docker-registry-proxy:0.4.2 rpardini/docker-registry-proxy:0.5.0
``` ```
### Simple registries auth (HTTP Basic auth) ### Simple registries auth (HTTP Basic auth)
@ -87,7 +93,7 @@ docker run --rm --name docker_registry_proxy -it \
-v $(pwd)/docker_mirror_certs:/ca \ -v $(pwd)/docker_mirror_certs:/ca \
-e REGISTRIES="reg.example.com git.example.com" \ -e REGISTRIES="reg.example.com git.example.com" \
-e AUTH_REGISTRIES="git.example.com:USER:PASSWORD" \ -e AUTH_REGISTRIES="git.example.com:USER:PASSWORD" \
rpardini/docker-registry-proxy:0.4.2 rpardini/docker-registry-proxy:0.5.0
``` ```
### Google Container Registry (GCR) auth ### Google Container Registry (GCR) auth
@ -110,7 +116,7 @@ docker run --rm --name docker_registry_proxy -it \
-e AUTH_REGISTRIES_DELIMITER=";;;" \ -e AUTH_REGISTRIES_DELIMITER=";;;" \
-e AUTH_REGISTRY_DELIMITER=":::" \ -e AUTH_REGISTRY_DELIMITER=":::" \
-e AUTH_REGISTRIES="gcr.io:::_json_key:::$(cat servicekey.json);;;auth.docker.io:::dockerhub_username:::dockerhub_password" \ -e AUTH_REGISTRIES="gcr.io:::_json_key:::$(cat servicekey.json);;;auth.docker.io:::dockerhub_username:::dockerhub_password" \
rpardini/docker-registry-proxy:0.4.2 rpardini/docker-registry-proxy:0.5.0
``` ```
## Configuring the Docker clients / Kubernetes nodes ## Configuring the Docker clients / Kubernetes nodes
@ -169,7 +175,7 @@ docker run --rm --name docker_registry_proxy -it
-p 0.0.0.0:3128:3128 \ -p 0.0.0.0:3128:3128 \
-v $(pwd)/docker_mirror_cache:/docker_mirror_cache \ -v $(pwd)/docker_mirror_cache:/docker_mirror_cache \
-v $(pwd)/docker_mirror_certs:/ca \ -v $(pwd)/docker_mirror_certs:/ca \
rpardini/docker-registry-proxy:0.4.2-debug rpardini/docker-registry-proxy:0.5.0-debug
``` ```
- `DEBUG=true` enables the mitmweb proxy between Docker clients and the caching layer, accessible on port 8081 - `DEBUG=true` enables the mitmweb proxy between Docker clients and the caching layer, accessible on port 8081