/docker-cloudflared

🐳 Cloudflared proxy-dns Docker image based on Alpine Linux

Primary LanguageDockerfileMIT LicenseMIT

Latest Version Build Status Docker Stars Docker Pulls Code Quality
Become a sponsor Donate Paypal

About

🐳 Cloudflared proxy-dns Docker image based on Alpine Linux.
If you are interested, check out my other 🐳 Docker images!

💡 Want to be notified of new releases? Check out 🔔 Diun (Docker Image Update Notifier) project!

Docker

Multi-platform image

Following platforms for this image are available:

$ docker run --rm mplatform/mquery crazymax/cloudflared:latest
Image: crazymax/cloudflared:latest
 * Manifest List: Yes
 * Supported platforms:
   - linux/amd64
   - linux/arm/v6
   - linux/arm/v7
   - linux/arm64
   - linux/386
   - linux/ppc64le
   - linux/s390x

Environment variables

  • TZ : The timezone assigned to the container (default UTC)
  • TUNNEL_DNS_UPSTREAM : Upstream endpoint URL, you can specify multiple endpoints for redundancy. (default https://1.1.1.1/dns-query,https://1.0.0.1/dns-query)

Ports

  • 5053/udp : Listen port for the DNS over HTTPS proxy server
  • 49312/tcp : Listen port for metrics reporting

Usage

Docker Compose

Docker compose is the recommended way to run this image. You can use the following docker compose template, then run the container:

docker-compose up -d
docker-compose logs -f

Command line

You can also use the following minimal command :

docker run -d --name cloudflared \
  -p 5053:5053/udp \
  -p 49312:49312 \
  crazymax/cloudflared:latest

Notes

Use with Pi-hole

Pi-hole currently provides documentation to manually set up DNS-Over-HTTPS with Cloudflared.

With Docker and this image, it's quite easy to use it with Pi-hole. Take a look at this simple docker compose template and you're ready to go.

Upgrade

To upgrade, pull the newer image and launch the container :

docker-compose pull
docker-compose up -d

How can I help ?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬 You can also support this project by becoming a sponsor on GitHub 👏 or by making a Paypal donation to ensure this journey continues indefinitely! 🚀

Thanks again for your support, it is much appreciated! 🙏

License

MIT. See LICENSE for more details.