Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dqzboy/Docker-Proxy
🔥 🔥 🔥 自建Docker镜像加速服务，基于官方Docker Registry 一键部署Docker、K8s、Quay、Ghcr、Mcr、Nvcr等镜像加速\管理服务。支持免服务器部署到Render\Koyeb
https://github.com/dqzboy/Docker-Proxy
docker-proxy docker-registry gcr-registry
Last synced: 16 days ago
JSON representation
🔥 🔥 🔥 自建Docker镜像加速服务，基于官方Docker Registry 一键部署Docker、K8s、Quay、Ghcr、Mcr、Nvcr等镜像加速\管理服务。支持免服务器部署到Render\Koyeb
- Host: GitHub
- URL: https://github.com/dqzboy/Docker-Proxy
- Owner: dqzboy
- License: apache-2.0
- Created: 2024-06-08T14:06:48.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T09:42:35.000Z (17 days ago)
- Last Synced: 2024-10-27T10:53:16.655Z (17 days ago)
- Topics: docker-proxy, docker-registry, gcr-registry
- Language: HTML
- Homepage: https://dqzboy.github.io/docs/
- Size: 319 KB
- Stars: 1,904
- Watchers: 14
- Forks: 299
- Open Issues: 1
-
Metadata Files:
- Readme: README.en.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
中文 | English
Self-built Docker image acceleration service, based on the official registry, one-click deployment of Docker, K8s, Quay, Ghcr, Mcr, elastic, nvcr and other image acceleration management services.
[](https://github.com/dqzboy)
[](https://github.com/dqzboy/Docker-Proxy/graphs/contributors)
[](https://github.com/dqzboy/Docker-Proxy/issues)
[](https://github.com/dqzboy/Docker-Proxy)
[](https://github.com/dqzboy/Docker-Proxy)
[](https://github.com/dqzboy/Docker-Proxy/blob/main/LICENSE)
---
## 📝 Preparation
⚠️ **Important:** Choose a server located abroad and not blocked in your region. For the domain name, there is no need to register it with domestic authorities. You can also apply for a free domain through various platforms. During the one-click deployment process, if you choose to install Caddy, it will automatically configure HTTPS. If you opt to deploy Nginx, you'll need to apply for a free SSL certificate yourself or use other methods to implement SSL encryption.
> High-Cost-Effective Overseas VPS Recommendation: [Click to View](Ad/README.md)
Free domain certificate application
**Method one:** [Acme.sh Automatically Generate and Renew Lets Encrypt Free SSL Certificate](https://www.dqzboy.com/16437.html)
**Method two:** Domain hosted to[Cloudflare enabling free SSL certificate](https://www.cloudflare.com/zh-cn/application-services/products/ssl/)
**Method Three:** You can apply for a free domain certificate (typically a DV certificate) through a third-party platform, suitable for personal websites, blogs, and small projects.
If you don't have the environment mentioned above, you can try the following several schemes
**Scheme one:** 🚀 🚀 If you don't have the things mentioned above, you can also deploy to **[Render](Render/README.md)**
**Scheme two:** If you only have one server and don't want to deal with domain names or configure TLS, then you can configure Docker's configuration file `daemon.json`, and specify `insecure-registries` to configure your image acceleration address
**Scheme three:** If you're deploying on a server within China, you can configure proxies while executing one-click deployment, which will also help solve the problem of Docker not being able to install domestically
> **During the deployment process, if you encounter any issues or questions, please scroll down to find the [problem](Issue/issue.en.md), see if your situation has been listed! Try to resolve it yourself first.**
---
## 📦 Deploy
### Deploy through project script
```shell
# CentOS && RHEL && Rocky
yum -y install curl
# ubuntu && debian
apt -y install curl
# overseas environment
bash -c "$(curl -fsSL https://raw.githubusercontent.com/dqzboy/Docker-Proxy/main/install/DockerProxy_Install.sh)"
# domestic environment
bash -c "$(curl -fsSL https://cdn.jsdelivr.net/gh/dqzboy/Docker-Proxy/install/DockerProxy_Install.sh)"
```
### Deployment to Third-Party Platforms
Deploy to Render
> Render offers a free quota, and you can further increase the quota after adding a card.
Deploy quickly with Render: [View Tutorial](Render/README.md)
Deploy to Koyeb
> The domain name assigned by Koyeb is not very stable when accessed in the domestic area, not highly recommended!
Deploy quickly with Koyeb: [View Tutorial](Koyeb/README.md)
### Docker Compose Deployment
Manual Container Deployment
**⚠️ Note:** Download the configuration for whichever mirror repository you need to accelerate. The `docker-compose.yaml` file by default deploys the acceleration service for all foreign mirror repositories, again you configure whichever one you deploy, and delete the rest!
**1.** Download the corresponding `yml` file from the [config](https://github.com/dqzboy/Docker-Proxy/tree/main/config) directory to your local machine.
**2.** Download the [docker-compose.yaml](https://github.com/dqzboy/Docker-Proxy/blob/main/docker-compose.yaml) file to your local machine and place it in the same directory level as the configuration file.
**3.** Execute the `docker compose` command to start the container service.
```shell
docker compose up -d
# View container logs
docker logs -f [Container ID or Name]
```
**4.** If you are not familiar with Nginx or Caddy, you can use a service you are familiar with for proxying. You can also access directly via IP and port number.
## 🔨 Features
- [x] One-click deployment of Docker image proxy services, supporting proxy based on the official Docker Registry.
- [x] Supports proxy for multiple image repositories, including Docker Hub, GitHub Container Registry (ghcr.io), Quay Container Registry (quay.io), Kubernetes Container Registry (k8s.gcr.io), Microsoft Container (mcr.microsoft.com), Elastic Stack (docker.elastic.co).
- [x] Automatically checks for and installs required dependency software such as Docker, Nginx/Caddy, etc., and ensures the system environment meets the operational requirements.
- [x] Automatically renders the corresponding Nginx or Caddy service configuration based on the service you choose to deploy.
- [x] Automatically cleans up files in the registry upload directory that are no longer referenced by any image or manifest.
- [x] Support custom configuration of proxy cache time(PROXY_TTL)、Support configuring IP whitelist and blacklist to prevent malicious attacks.
- [x] Provides features for restarting services, updating services, updating configurations, and uninstalling services, making it convenient for users to perform daily management and maintenance.
- [x] Supports user selection of whether to provide authentication during deployment.
- [x] Supports configuration of proxy (HTTP_PROXY), only supports HTTP.
- [x] Solves the problem of being unable to install Docker services in the domestic environment.
- [x] Supports mainstream Linux distribution operating systems, such as CentOS, Ubuntu, Rocky, Debian, RHEL, etc.
- [x] Supports deployment on mainstream ARCH architectures, including linux/amd64, linux/arm64.
## ✨ Tutorial
#### Configure Nginx Reverse Proxy
> **Note**： If you choose to deploy with Nginx, after the proxy program is deployed, you need to configure Nginx yourself.
**1.Download the [registry-proxy.conf](https://raw.githubusercontent.com/dqzboy/Docker-Proxy/main/nginx/registry-proxy.conf) configuration file from the repository to your Nginx service and modify the domain name and certificate sections in the configuration**
**2.Resolve the corresponding access domain name to the IP of the machine where the Docker proxy service is deployed at your DNS service provider**
**3.Modify the Docker daemon.json configuration to configure your self-built Registry address. Restart Docker after modification**
```shell
~]# vim /etc/docker/daemon.json
{
"registry-mirrors": [ "https://hub.your_domain_name" ],
"log-opts": {
"max-size": "100m",
"max-file": "5"
}
}
```
> **Explanation：** After configuring the daemon.json, you no longer need to specify your acceleration address when pulling images; simply execute docker pull to retrieve the images you need. The following steps are for when you have not configured the daemon.json, and you need to include your acceleration address to pull images normally.
---
**1. Replace the official Registry address with your own Registry address to pull the image.**
```shell
# Docker Hub Registry
## Original: nginx:latest
## Replace with:
docker pull hub.your_domain_name/library/nginx:latest
# Google Registry
## Original: gcr.io/google-containers/pause:3.1
## Replace with:
docker pull gcr.your_domain_name/google-containers/pause:3.1
```
**2. Prefix replacement reference for the Registry.**
| Source | Replace with | Platform |
|-------|---------------|----------|
| docker.io | hub.your_domain_name | docker hub
| gcr.io | gcr.your_domain_name | Google Container Registry
| ghcr.io | ghcr.your_domain_name | GitHub Container Registry
| k8s.gcr.io | k8s-gcr.your_domain_name | Kubernetes Container Registry
| registry.k8s.io | k8s.your_domain_name | Kubernetes's container image registry
| quay.io | quay.your_domain_name | Quay Container Registry
| mcr.microsoft.com | mcr.your_domain_name | Microsoft Container Registry
| docker.elastic.co | elastic.your_domain_name | Elastic Stack
| nvcr.io | nvcr.your_domain_name | NVIDIA Container Registry
---
> **Detailed Tutorial:**
> [Self-built Docker Image Acceleration Service: Accelerating and Optimizing Image Management](https://www.dqzboy.com/8709.html)
> [Build your own Docker image acceleration, and host the domain name to CF to accelerate image pulling.](https://www.dqzboy.com/17665.html)
## 📚 Display
System Environment Check
Service Deployment and Installation
## 💻 UI
Docker Registry UI
Docker-Proxy CmdUI
---
## 🫶 Sponsorship
If you find this project helpful, please give it a Star. And if possible, you can also give me a little support. Thank you very much for your support.😊
Alipay
WeChat Pay
---
## 👨🏻💻 Issue
Problem Summary
> Summary of common issues related to deployment and usage, welcome to add more！
Problem Summary: [Click to view](Issue/issue.en.md)
---
## 😺 Other
Open Source is not easy, if you reference this project or make modifications based on it, could you please credit this project in your documentation? Thank you!
## ❤ Acknowledgements
Thanks to the open source contributions of the following projects:
[CNCF Distribution](https://distribution.github.io/distribution/)
[docker-registry-browser](https://github.com/klausmeyer/docker-registry-browser)
## 🤝 Contributing
Thanks to everyone who has contributed!
## License
Docker-Proxy is available under the [Apache 2 license](./LICENSE)
---
[](https://star-history.com/#dqzboy/Docker-Proxy&Date)