Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amirdaaee authored Jan 9, 2024
1 parent 625ab95 commit 631992a
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
# docker-warp-proxy

Docker image to run **cloudflare-warp** in proxy mode
# Cloudflare WARP Docker

## Usage
This repository contains a Dockerized version of [Cloudflare WARP](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/), allowing users to run Cloudflare's WARP service within a Docker container as socks and http proxy.

```
docker run -d --name warp -p 127.0.0.1:8080:8080 -p 127.0.0.1:1080:1080 --restart unless-stopped amirdaaee/cloudflare-warp:latest
```
or you can use [docker-compose](https://github.com/amirdaaee/cloudflare-warp-docker/blob/master/docker-compose.yml)
## Usage

To use this Docker image, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/amirdaaee/cloudflare-warp-docker.git
```
2. Build the Docker image:
```bash
docker build -t cloudflare-warp .
```
3.Run the Docker container:
```bash
docker run -d --name warp -p 127.0.0.1:8080:8080 -p 127.0.0.1:1080:1080 cloudflare-warp:latest
```
now 127.0.0.1:1080 can be used as socks proxy and 127.0.0.1:8080 can be used as http proxy

> For your convenience, you can choose to use the pre-built Docker image available on [Docker Hub](https://hub.docker.com/r/amirdaaee/cloudflare-warp) or you can use [docker-compose](https://github.com/amirdaaee/cloudflare-warp-docker/blob/master/docker-compose.yml)

## Configuration
The following environment variables can be used to configure the WARP client:
- LICENSE_KEY[*optional*]: Your WARP client license key

## Disclaimer

It's important to note that this repository is not affiliated with Cloudflare, and the use of Cloudflare's WARP service is subject to Cloudflare's terms of service. For more information about Cloudflare WARP, please refer to the official Cloudflare documentation.

0 comments on commit 631992a

Please sign in to comment.