Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aleskxyz/warp-svc
Cloudflare warp client as a socks5 server in docker
https://github.com/aleskxyz/warp-svc
cloudflare docker docker-compose dockerfile dockerimage families-mode license linux proxy socks socks5 warp
Last synced: about 1 month ago
JSON representation
Cloudflare warp client as a socks5 server in docker
- Host: GitHub
- URL: https://github.com/aleskxyz/warp-svc
- Owner: aleskxyz
- License: apache-2.0
- Created: 2023-04-22T00:16:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-01T22:30:38.000Z (9 months ago)
- Last Synced: 2024-04-02T15:02:50.159Z (9 months ago)
- Topics: cloudflare, docker, docker-compose, dockerfile, dockerimage, families-mode, license, linux, proxy, socks, socks5, warp
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 65
- Watchers: 2
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# warp-svc
Cloudflare WARP client as a socks5 server in docker
This dockerfile will create a docker image with official Cloudflare WARP client for linux and provides a socks5 proxy to use in other compaliant applications either in your local machine or by other docker containers in a docker compose or Kubernetes.
The official Cloudflare WARP client for Linux only listens on localhost for the socks proxy so you cannot use it in a docker container which need to bind on 0.0.0.0
## Features
* Register a new Cloudflare WARP account
* Configurable "families mode"
* Subscribe to Cloudflare WARP+
## How to use
The socks proxy in exposed on port `1080`
You can use these environment variables:
* `FAMILIES_MODE`: Use one of `off`, `malware` and `full` values. (Default: `off`)
* `WARP_LICENSE`: Put your WARP+ licesne. (You can get a free WARP+ license from this telegram bot: https://t.me/generatewarpplusbot)
You should mount `/var/lib/cloudflare-warp` directory of the container to your host to make you WARP account persistant. Notice that each WARP+ license is working only on 4 device so persisting the configuration is important!
### Using as a local proxy with Docker
```
docker run -d --name=warp -e FAMILIES_MODE=full -e WARP_LICENSE=xxxxxxxx-xxxxxxxx-xxxxxxxx -p 127.0.0.1:1080:1080 -v ${PWD}/warp:/var/lib/cloudflare-warp ghcr.io/aleskxyz/warp-svc:latest
```
You can verify warp by visiting this url:
```
curl -x socks5h://127.0.0.1:1080 -sL https://cloudflare.com/cdn-cgi/trace | grep warp
warp=on
```
You can also use `warp-cli` command to control your connection:
```
docker exec warp warp-cli --accept-tos status
Status update: Connected
Success
```
### Using as a proxy for other containers with docker-compose
```
version: "3"
services:
warp:
image: ghcr.io/aleskxyz/warp-svc:latest
expose:
- 1080
restart: always
environment:
WARP_LICENSE: xxxxxxxx-xxxxxxxx-xxxxxxxx
FAMILIES_MODE: off
volumes:
- ./warp:/var/lib/cloudflare-warp
app:
image:
depends_on:
- warp
environment:
proxy: warp:1080
```