Skip to content

Commit 8b568ec

Browse files
author
ricardop
committed
more README fixes
1 parent e82c0dd commit 8b568ec

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### TL,DR
44

5-
A caching proxy for Docker; allows centralized management of registries and their authentication; caches images from *any* registry.
5+
A caching proxy for Docker; allows centralised management of registries and their authentication; caches images from *any* registry.
66

77
### What?
88

@@ -24,13 +24,13 @@ for this to work it requires inserting a root CA certificate into system trusted
2424
- Env `AUTH_REGISTRIES`: space separated list of `registry:username:password` authentication info. Registry hosts here should be listed in the above ENV as well.
2525

2626
```bash
27-
docker run --rm --name docker_caching_proxy -it \
27+
docker run --rm --name docker_registry_proxy -it \
2828
-p 0.0.0.0:3128:3128 \
2929
-v $(pwd)/docker_mirror_cache:/docker_mirror_cache \
3030
-v $(pwd)/docker_mirror_certs:/ca \
3131
-e REGISTRIES="k8s.gcr.io gcr.io quay.io your.own.registry another.private.registry" \
3232
-e AUTH_REGISTRIES="your.own.registry:username:password another.private.registry:user:pass" \
33-
rpardini/docker-caching-proxy:latest
33+
rpardini/docker-registry-proxy:latest
3434
```
3535

3636
Let's say you did this on host `192.168.66.72`, you can then `curl http://192.168.66.72:3128/ca.crt` and get the proxy CA certificate.
@@ -39,11 +39,11 @@ Let's say you did this on host `192.168.66.72`, you can then `curl http://192.16
3939

4040
On each Docker host that is to use the cache:
4141

42-
- [Configure Docker proxy](https://docs.docker.com/network/proxy/) pointing to the caching server
42+
- [Configure Docker proxy](https://docs.docker.com/config/daemon/systemd/#httphttps-proxy) pointing to the caching server
4343
- Add the caching server CA certificate to the list of system trusted roots.
4444
- Restart `dockerd`
4545

46-
Do it all at once, tested on Ubuntu Xenial:
46+
Do it all at once, tested on Ubuntu Xenial, which is systemd based:
4747

4848
```bash
4949
# Add environment vars pointing Docker to use the proxy
@@ -54,8 +54,8 @@ Environment="HTTPS_PROXY=http://192.168.66.72:3128/"
5454
EOD
5555

5656
# Get the CA certificate from the proxy and make it a trusted root.
57-
curl http://192.168.66.72:3128/ca.crt > /usr/share/ca-certificates/docker_caching_proxy.crt
58-
echo "docker_caching_proxy.crt" >> /etc/ca-certificates.conf
57+
curl http://192.168.66.72:3128/ca.crt > /usr/share/ca-certificates/docker_registry_proxy.crt
58+
echo "docker-registry-proxy.crt" >> /etc/ca-certificates.conf
5959
update-ca-certificates --fresh
6060

6161
# Reload systemd
@@ -81,6 +81,8 @@ Test your own registry caching and authentication the same way; you don't need `
8181

8282
- If you authenticate to a private registry and pull through the proxy, those images will be served to any client that can reach the proxy, even without authentication. *beware*
8383
- Repeat, this will make your private images very public if you're not careful.
84+
- **Currently you cannot push images while using the proxy** which is a shame. PRs welcome.
85+
- Setting this on Linux is relatively easy. On Mac and Windows the CA-certificate part will be very different but should work in principle.
8486

8587
#### Why not use Docker's own registry, which has a mirror feature?
8688

0 commit comments

Comments
 (0)