initial commit

.gitignore

@@ -0,0 +1 @@
+data/

Dockerfile

@@ -0,0 +1,30 @@
+FROM ubuntu:22.04
+
+# install dependencies
+RUN apt-get update && \
+    apt-get upgrade -y && \
+    apt-get install -y curl gnupg lsb-release && \
+    curl https://pkg.cloudflareclient.com/pubkey.gpg | gpg --yes --dearmor --output /usr/share/keyrings/cloudflare-warp-archive-keyring.gpg && \
+    echo "deb [arch=amd64 signed-by=/usr/share/keyrings/cloudflare-warp-archive-keyring.gpg] https://pkg.cloudflareclient.com/ $(lsb_release -cs) main" | tee /etc/apt/sources.list.d/cloudflare-client.list && \
+    apt-get update && \
+    apt-get install -y cloudflare-warp && \
+    apt-get clean && \
+    apt-get autoremove -y && \
+    curl -LO https://github.com/ginuerzh/gost/releases/download/v2.11.2/gost-linux-amd64-2.11.2.gz && \
+    gunzip gost-linux-amd64-2.11.2.gz && \
+    mv gost-linux-amd64-2.11.2 /usr/bin/gost && \
+    chmod +x /usr/bin/gost
+
+# Accept Cloudflare WARP TOS
+RUN mkdir -p /root/.local/share/warp && \
+    echo -n 'yes' > /root/.local/share/warp/accepted-tos.txt
+
+COPY entrypoint.sh /entrypoint.sh
+
+ENV GOST_ARGS="-L :1080"
+ENV WARP_SLEEP=2
+
+HEALTHCHECK --interval=15s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -fsS "https://cloudflare.com/cdn-cgi/trace" | grep -qE "warp=(plus|on)" || exit 1
+
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -0,0 +1,70 @@
+# warp-docker
+
+Run official [Cloudflare WARP](https://1.1.1.1/) client in Docker.
+
+## Usage
+
+### Start the container
+
+To run the WARP client in Docker, just write the following content to `docker-compose.yml` and run `docker-compose up -d`.
+
+```yaml
+version: '3'
+
+services:
+  warp:
+    image: caomingjun/warp
+    container_name: warp
+    restart: always
+    ports:
+      - '1080:1080'
+    environment:
+      - WARP_SLEEP=2
+      # - WARP_LICENSE_KEY= # optional
+    cap_add:
+      - NET_ADMIN
+    sysctls:
+      - net.ipv6.conf.all.disable_ipv6=0
+      - net.ipv4.conf.all.src_valid_mark=1
+    volumes:
+      - ./data:/var/lib/cloudflare-warp
+```
+
+Try it out to see if it works:
+
+```bash
+curl --socks5 127.0.0.1:1080 https://cloudflare.com/cdn-cgi/trace
+```
+
+If the output contains `warp=on` or `warp=plus`, the container is working properly. If the output contains `warp=off`, it means that the container failed to connect to the WARP service.
+
+### Configuration
+
+You can configure the container through the following environment variables:
+
+- `WARP_SLEEP`: The time to wait for the WARP daemon to start, in seconds. The default is 2 seconds. If the time is too short, it may cause the WARP daemon to not start before using the proxy, resulting in the proxy not working properly. If the time is too long, it may cause the container to take too long to start. If your server has poor performance, you can increase this value appropriately.
+
+- `WARP_LICENSE_KEY`: The license key of the WARP client, which is optional. If you have subscribed to WARP+ service, you can fill in the key in this environment variable. If you have not subscribed to WARP+ service, you can ignore this environment variable.
+
+Data persistence: Use the host volume `./data` to persist the data of the WARP client. You can change the location of this directory or use other types of volumes. If you modify the `WARP_LICENSE_KEY`, please delete the `./data` directory so that the client can detect and register again.
+
+### Change proxy type
+
+The container uses [GOST](https://github.com/ginuerzh/gost) to provide proxy, where the environment variable `GOST_ARGS` is used to pass parameters to GOST. The default is `-L :1080`, that is, to listen on port 1080 in the container at the same time through HTTP and SOCKS5 protocols. If you want to have UDP support or use advanced features provided by other protocols, you can modify this parameter. For more information, refer to [GOST documentation](https://v2.gost.run/en/).
+
+If you modify the port number, you may also need to modify the port mapping in the `docker-compose.yml`.
+
+### Health check
+
+The health check of the container will verify if the WARP client inside the container is working properly. If the check fails, the container will automatically restart. Specifically, 15 seconds after starting, a check will be performed every 15 seconds. If the inspection fails for 3 consecutive times, the container will be marked as unhealthy and trigger an automatic restart.
+
+```Dockerfile
+HEALTHCHECK --interval=15s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -fsS "https://cloudflare.com/cdn-cgi/trace" | grep -qE "warp=(plus|on)" || exit 1
+```
+
+If you don't want the container to restart automatically, you can remove `restart: always` from the `docker-compose.yml`. You can also modify the parameters of the health check through the `docker-compose.yml`.
+
+## Further reading
+
+Read in my [blog post](https://blog.caomingjun.com/run-cloudflare-warp-in-docker/en/#How-it-works).

docker-compose.yml

@@ -0,0 +1,19 @@
+version: '3'
+
+services:
+  warp:
+    image: caomingjun/warp
+    container_name: warp
+    restart: always
+    ports:
+      - '1080:1080'
+    environment:
+      - WARP_SLEEP=2
+      # - WARP_LICENSE_KEY= # optional
+    cap_add:
+      - NET_ADMIN
+    sysctls:
+      - net.ipv6.conf.all.disable_ipv6=0
+      - net.ipv4.conf.all.src_valid_mark=1
+    volumes:
+      - ./data:/var/lib/cloudflare-warp

entrypoint.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# exit when any command fails
+set -e
+
+# create a tun device
+mkdir -p /dev/net
+mknod /dev/net/tun c 10 200
+chmod 600 /dev/net/tun
+
+# start the daemon
+warp-svc &
+
+# sleep to wait for the daemon to start, default 2 seconds
+sleep "$WARP_SLEEP"
+
+# if /var/lib/cloudflare-warp/reg.json not exists, register the warp client
+if [ ! -f /var/lib/cloudflare-warp/reg.json ]; then
+    warp-cli register && echo "Warp client registered!"
+    # if a license key is provided, register the license
+    if [ -n "$WARP_LICENSE_KEY" ]; then
+        echo "License key found, registering license..."
+        warp-cli set-license "$WARP_LICENSE_KEY" && echo "Warp license registered!"
+    fi
+    # connect to the warp server
+    warp-cli connect
+else
+    echo "Warp client already registered, skip registration"
+fi
+
+# start the proxy
+gost $GOST_ARGS