xiac520/derper repository overview

Description:

xiac520/derper:latest is a Docker image compiled from the Tailscale library for the DERP (Distributed Edge Relay Protocol) component. DERP is a protocol used by Tailscale to establish secure communication channels between nodes. This image automates the process of obtaining Let's Encrypt certificates using Cloudflare DNS, simplifying the deployment of DERP services.

Key Features:

• Automatic Certificate Management: Automatically obtains and renews Let's Encrypt certificates using Cloudflare DNS validation.
• Environment Variable Configuration: Flexibly configures the DERP service through environment variables, including domain name, Cloudflare credentials, and Let's Encrypt email.
• Simplified Deployment: Provides a pre-configured Docker image to reduce manual configuration complexity.
• IPv6 Support: The image supports IPv6 networks, ensuring it runs smoothly in IPv6 environments.
• Bridge Mode Support: Also supports running in bridge mode with default SSL port 444 and STUN port 3478.

Usage:

1. Pull the Image:

   docker pull xiac520/derper:latest
   

   Copy

2. Run the Container (in host network mode):

   docker run -d --network host \
     -e DERP_DOMAIN=your-derp-domain.com \
     -e [email protected] \
     -e CLOUDFLARE_API_KEY=your-cloudflare-api-key \
     -e [email protected] \
     xiac520/derper:latest
   

   Copy

3. Run the Container (in bridge network mode):

   docker run -d -p 444:444 -p 3478:3478 \
     -e DERP_DOMAIN=your-derp-domain.com \
     -e [email protected] \
     -e CLOUDFLARE_API_KEY=your-cloudflare-api-key \
     -e [email protected] \
     xiac520/derper:latest
   

   Copy

Environment Variables:

• DERP_DOMAIN: The domain name for the DERP service (e.g., your-derp-domain.com).
• CLOUDFLARE_EMAIL: The email address associated with your Cloudflare account (e.g., [email protected]).
• CLOUDFLARE_API_KEY: The Cloudflare API key (e.g., your-cloudflare-api-key).
• LETSENCRYPT_EMAIL: The email address for your Let's Encrypt account, used to receive certificate-related notifications (e.g., [email protected]).

Notes:

• Ensure that the Cloudflare API key has sufficient permissions to manage DNS records.
• Ensure that the domain is correctly configured in Cloudflare
• In host network mode, the container binds directly to the host's network interfaces.

Support and Feedback:

If you encounter any issues or have any suggestions during use, please submit an issue through the GitHub repository or contact the maintainer.

---