wgcf-connector

wgcf-connector

Extract Cloudflare Mesh (formerly WARP Connector) WireGuard configuration.

Cloudflare Mesh is an overlay network like ZeroTier and Tailscale but instead of peer-to-peer, you connect to the nearest Cloudflare PoP using WireGuard just like NordVPN Meshnet.
Finally, a free site-to-site VPN from Cloudflare.

This program uses the warp-cli Linux client, installs it inside the Docker container, register Cloudflare Mesh with the token, and then extract the configuration file.

Usage

1. Make sure you have a device profile set to WireGuard for the Cloudflare Mesh node.
2. Create a Mesh node in Cloudflare dashboard.
3. Copy the generated Cloudflare Mesh token that starts with eyJhIjoi and ends with In0=, and paste it as argument <token> in Docker.
4. It will output wgcf-connector-<registration_id>.conf file in your current working directory, which you can use in WireGuard.

Pull image remotely

docker run --rm -v $(pwd):/app/output ghcr.io/animmouse/wgcf-connector <token>

Image tags

Tag	Use
latest	Newest release. Recommended for most users.
1	Newest 1.x.x release, without breaking changes.
1.0.0	This exact release, never changes.
edge	Latest commit on main, may be broken.

New Cloudflare WARP versions are released automatically as patch versions. Old WARP versions may eventually be rejected by Cloudflare, so avoid pinning an exact version for long.
Images are available for linux/amd64 and linux/arm64.
See releases for the changes in each version.

Build image locally

docker build -t wgcf-connector .
docker run --rm -v $(pwd):/app/output wgcf-connector <token>