A Lightweight docker image for connecting to CloudFlare WARP trough
Socks
,HTTP
andShadowsocks
proxy protocols
- Features
- Build locally
- Image
- Environment variables
- Ports
- Usage
- WARP+ license
- Upgrade
- Contributing
- License
- Support
Socks5
,HTTP
andShadowsocks
proxy protocols - Apply license key to use existing
Warp+
subscription - Multi-platform image
git clone https://github.com/shahradelahi/docker-cfw-proxy
cd docker-cfw-proxy
# Build image and output to docker (default)
docker buildx bake
# Build multi-platform image
docker buildx bake image-all
Registry | Image |
---|---|
Docker Hub | shahradel/cfw-proxy |
GitHub Container Registry | ghcr.io/shahradelahi/cfw-proxy |
Following platforms for this image are available:
$ docker run --rm mplatform/mquery shahradel/cfw-proxy:latest
Image: shahradel/cfw-proxy:latest
* Manifest List: Yes (Image type: application/vnd.oci.image.index.v1+json)
* Supported platforms:
- linux/amd64
- linux/arm/v6
- linux/arm/v7
- linux/arm64
- linux/386
- linux/s390x
TZ
: Timezone assigned to the container (defaultUTC
)PROXY_USERNAME
: The username ofSocks5
andHTTP
proxy (defaultawesome-username
)PROXY_PASSWORD
: The password of all proxy protocols (defaultsuper-secret-password
)SOCKS5_PORT
: The port ofSocks5
proxy (default1080
)HTTP_PORT
: The port ofHTTP
proxy (default8080
)SHADOWSOCKS_PORT
: The port ofShadowsocks
proxy (default8338
)SHADOWSOCKS_CIPHER
: The cipher ofShadowsocks
proxy (defaultAES-256-CFB
)WGCF_ENDPOINT
: Theendpoint
of the WARP endpoint (defaultengage.cloudflareclient.com:2408
)WGCF_ENDPOINT_CIDR
: Thecidr
of the WARP endpoint (default162.159.192.0/24
)WGCF_ENDPOINT_PORT
: WARP endpoint port (default2408
)FAST_ENDPOINT
: Enables the feature for searching for endpoint with the lowest latencyWGCF_LICENSE_KEY
: The license key of CloudFlare WARP+DNS_PROFILE
: Presets of CloudFlare DNS servers (defaultdefault
)DNS
: Thedns
of the WireGuard interface (default1.1.1.1, 1.0.0.1, 2606:4700:4700::1111, 2606:4700:4700::1001
)MTU
: Themtu
of the WireGuard interface (default1280
)
💡
WGCF_LICENSE_KEY
is optional and to obtain it follow guides inWARP+ license
section.
1080
:Socks5
proxy8080
:HTTP
proxy8338
:Shadowsocks
proxy
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
You can also use the following minimal command:
$ docker run -d \
--name warp \
-p 1080:1080 -p 8080:8080 -p 8338:8338 \
-e "PROXY_USERNAME=awesome-username" \
-e "PROXY_PASSWORD=super-secret-password" \
-e "SHADOWSOCKS_CIPHER=AES-256-CFB" \
--privileged \
--cap-add NET_ADMIN \
--cap-add SYS_MODULE \
--sysctl net.ipv4.ip_forward=1 \
--sysctl net.ipv4.conf.all.src_valid_mark=1 \
--sysctl net.ipv6.conf.all.disable_ipv6=0 \
shahradel/cfw-proxy
Recreate the container whenever I push an update:
docker compose pull
docker compose up -d
If you have an existing Warp+ subscription, for an example on your phone, you can bind the account generated by this tool to your phone's account, sharing its Warp+ status. Please note that there is a current limit of maximum 5 linked devices active at a time.
⚠️ This device's private key will be changed!
First, get your Warp+ account license key. To view it on Android:
- Open the
1.1.1.1
app - Click on the hamburger menu button in the top-right corner.
- Navigate to:
Account
>Key
Finally, copy and paste the license key into the WGCF_LICENSE_KEY
environment variable and restart the container.
Want to contribute? Awesome! To show your support is to star the project, or to raise issues on GitHub.
Thanks again for your support, it is much appreciated! 🙏