Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shahradelahi/docker-cfw-proxy
⛅️ CloudFlare WARP Proxy
https://github.com/shahradelahi/docker-cfw-proxy
cloudflare http proxy shahdowsocks socks5 warp
Last synced: 3 days ago
JSON representation
⛅️ CloudFlare WARP Proxy
- Host: GitHub
- URL: https://github.com/shahradelahi/docker-cfw-proxy
- Owner: shahradelahi
- License: gpl-3.0
- Created: 2024-05-16T02:36:53.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-20T02:46:40.000Z (12 days ago)
- Last Synced: 2024-12-21T01:36:19.515Z (11 days ago)
- Topics: cloudflare, http, proxy, shahdowsocks, socks5, warp
- Language: Shell
- Homepage: https://hub.docker.com/r/shahradel/cfw-proxy
- Size: 76.2 KB
- Stars: 178
- Watchers: 2
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-cfw-proxy
[](https://github.com/shahradelahi/docker-cfw-proxy/actions/workflows/ci.yml)
[](https://opensource.org/licenses/GPL-3.0)
[](https://github.com/shahradelahi/docker-cfw-proxy)
[](https://github.com/shahradelahi/docker-cfw-proxy/issues)
[](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Fshahradelahi%2Fdocker-cfw-proxy)
> A Lightweight docker image for connecting to CloudFlare WARP trough `Socks`, `HTTP` and `Shadowsocks` proxy protocols
---
- [Features](#features)
- [Build locally](#build-locally)
- [Image](#image)
- [Environment variables](#environment-variables)
- [Ports](#ports)
- [Usage](#usage)
- [Docker Compose](#docker-compose)
- [Command line](#command-line)
- [WARP+ license](#warp-license)
- [Upgrade](#upgrade)
- [Contributing](#contributing)
- [License](#license)
## Features
- Support `Socks5`, `HTTP` and `Shadowsocks` proxy protocols
- Apply license key to use existing `Warp+` subscription
- Multi-platform image
## Build locally
```shell
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
```
## Image
| Registry | Image |
| ------------------------------------------------------------------------------------------------------- | -------------------------------- |
| [Docker Hub](https://hub.docker.com/r/shahradel/cfw-proxy/) | `shahradel/cfw-proxy` |
| [GitHub Container Registry](https://github.com/users/shahradelahi/packages/container/package/cfw-proxy) | `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
```
## Environment variables
- `TZ`: Timezone assigned to the container (default `UTC`)
- `PROXY_USERNAME`: The username of `Socks5` and `HTTP` proxy (default `awesome-username`)
- `PROXY_PASSWORD`: The password of all proxy protocols (default `super-secret-password`)
- `SOCKS5_PORT`: The port of `Socks5` proxy (default `1080`)
- `HTTP_PORT`: The port of `HTTP` proxy (default `8080`)
- `SHADOWSOCKS_PORT`: The port of `Shadowsocks` proxy (default `8338`)
- `SHADOWSOCKS_CIPHER`: The cipher of `Shadowsocks` proxy (default `AES-256-CFB`)
- `WGCF_ENDPOINT`: The `endpoint` of the WARP endpoint (default `engage.cloudflareclient.com:2408`)
- `WGCF_ENDPOINT_CIDR`: The `cidr` of the WARP endpoint (default `162.159.192.0/24`)
- `WGCF_ENDPOINT_PORT`: WARP endpoint port (default `2408`)
- `FAST_ENDPOINT`: Enables the feature for searching for endpoint with the lowest latency
- `WGCF_LICENSE_KEY`: The license key of CloudFlare WARP+
- `DNS_PROFILE`: Presets of CloudFlare DNS servers (default `default`)
- `DNS`: The `dns` of the WireGuard interface (default `1.1.1.1, 1.0.0.1, 2606:4700:4700::1111, 2606:4700:4700::1001`)
- `MTU`: The `mtu` of the WireGuard interface (default `1280`)
> 💡 `WGCF_LICENSE_KEY` is optional and to obtain it follow guides in [`WARP+ license`](#warp-license) section.
## Ports
- `1080`: `Socks5` proxy
- `8080`: `HTTP` proxy
- `8338`: `Shadowsocks` proxy
## Usage
### Docker Compose
Docker compose is the recommended way to run this image. You can use the following
[docker compose template](docker-compose.yml), then run the container:
```bash
docker compose up -d
docker compose logs -f
```
### Command line
You can also use the following minimal command:
```bash
$ 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
```
## Upgrade
Recreate the container whenever I push an update:
```bash
docker compose pull
docker compose up -d
```
## WARP+ license
[//]: # "Parcially Yanked from https://github.com/ViRb3/wgcf"
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:
1. Open the `1.1.1.1` app
2. Click on the hamburger menu button in the top-right corner.
3. Navigate to: `Account` > `Key`
Finally, copy and paste the license key into the `WGCF_LICENSE_KEY` environment variable and restart the container.
## Contributing
Want to contribute? Awesome! To show your support is to star the project, or to raise issues
on [GitHub](https://github.com/shahradelahi/docker-cfw-proxy).
Thanks again for your support, it is much appreciated! 🙏
## License
[GPL-3.0](/LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi)