An open API service indexing awesome lists of open source software.

https://github.com/animmouse/wgcf-connector

WARP Connector WireGuard configuration extractor
https://github.com/animmouse/wgcf-connector

cloudflare cloudflare-warp

Last synced: 2 months ago
JSON representation

WARP Connector WireGuard configuration extractor

Awesome Lists containing this project

README

        

# wgcf-connector
Extract Cloudflare [WARP Connector](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/private-net/warp-connector/) WireGuard configuration.

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

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

## Usage
1. Create a tunnel in Cloudflare Zero Trust dashboard with WARP Connector as tunnel type.
2. Copy the generated WARP Connector token starting with `eyJhIjoi` and paste it as argument `` in Docker.
3. It will output wgcf-connector-.conf file in your current working directory, which you can use in WireGuard.

> [!TIP]
> If you got an endpoint IPv4 address starting with `162.159.192`, use `162.159.193` instead to have lower latency.

### Pull image remotely
> [!TIP]
> You can use GitHub Codespaces for this.
```
docker run --rm -v $(pwd):/app/output ghcr.io/animmouse/wgcf-connector
```

### Build image locally
```
docker build -t wgcf-connector .
docker run --rm -v $(pwd):/app/output wgcf-connector
```