├── .github └── workflows │ └── build.yml ├── Dockerfile ├── LICENSE ├── README.md ├── configs ├── logrotate.conf └── supervisord.conf ├── docker-compose.yml └── scripts ├── healthcheck.sh ├── logrotate.sh └── warp.sh /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Create and publish a Docker image 2 | 3 | # Configures this workflow to run every time a change is pushed to the branch called `release`. 4 | on: 5 | push: 6 | tags: 7 | - v* 8 | 9 | # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. 10 | env: 11 | REGISTRY: ghcr.io 12 | IMAGE_NAME: ${{ github.repository }} 13 | 14 | # There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. 15 | jobs: 16 | build-and-push-image: 17 | runs-on: ubuntu-latest 18 | # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. 19 | permissions: 20 | contents: read 21 | packages: write 22 | # 23 | steps: 24 | - name: Checkout repository 25 | uses: actions/checkout@v4 26 | - name: Set up QEMU 27 | uses: docker/setup-qemu-action@v3 28 | # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. 29 | - name: Set up Docker Buildx 30 | uses: docker/setup-buildx-action@v3 31 | - name: Log in to the Container registry 32 | uses: docker/login-action@v3 33 | with: 34 | registry: ${{ env.REGISTRY }} 35 | username: ${{ github.actor }} 36 | password: ${{ secrets.GITHUB_TOKEN }} 37 | # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. 38 | - name: Extract metadata (tags, labels) for Docker 39 | id: meta 40 | uses: docker/metadata-action@v5 41 | with: 42 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 43 | # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages. 44 | # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. 45 | # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. 46 | - name: Build and push Docker image 47 | uses: docker/build-push-action@v5 48 | with: 49 | context: . 50 | platforms: linux/amd64,linux/arm64 51 | push: true 52 | tags: ${{ steps.meta.outputs.tags }} 53 | labels: ${{ steps.meta.outputs.labels }} 54 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:22.04 2 | ENV WARP_LICENSE= 3 | ENV FAMILIES_MODE=off 4 | EXPOSE 1080/tcp 5 | RUN apt-get update && \ 6 | apt-get install curl gpg socat lsb-release supervisor logrotate -y && \ 7 | curl -fsSL https://pkg.cloudflareclient.com/pubkey.gpg | gpg --yes --dearmor --output /usr/share/keyrings/cloudflare-warp-archive-keyring.gpg && \ 8 | echo "deb [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 && \ 9 | apt-get update && \ 10 | apt-get install cloudflare-warp -y && \ 11 | rm -rf /var/lib/apt/lists/* 12 | COPY --chmod=755 scripts /scripts 13 | COPY --chmod=644 configs/logrotate.conf /etc/logrotate.conf 14 | COPY --chmod=644 configs/supervisord.conf /etc/supervisor/supervisord.conf 15 | VOLUME ["/var/lib/cloudflare-warp"] 16 | CMD ["/usr/bin/supervisord"] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # warp-svc 2 | Cloudflare WARP client as a socks5 server in docker 3 | 4 | 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. 5 | 6 | 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 7 | 8 | ## Features 9 | * Register a new Cloudflare WARP account 10 | * Configurable "families mode" 11 | * Subscribe to Cloudflare WARP+ 12 | 13 | ## How to use 14 | The socks proxy in exposed on port `1080` 15 | 16 | You can use these environment variables: 17 | * `FAMILIES_MODE`: Use one of `off`, `malware` and `full` values. (Default: `off`) 18 | * `WARP_LICENSE`: Put your WARP+ licesne. (You can get a free WARP+ license from this telegram bot: https://t.me/generatewarpplusbot) 19 | 20 | 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! 21 | 22 | ### Using as a local proxy with Docker 23 | ``` 24 | 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 25 | ``` 26 | You can verify warp by visiting this url: 27 | ``` 28 | curl -x socks5h://127.0.0.1:1080 -sL https://cloudflare.com/cdn-cgi/trace | grep warp 29 | 30 | warp=on 31 | ``` 32 | You can also use `warp-cli` command to control your connection: 33 | ``` 34 | docker exec warp warp-cli --accept-tos status 35 | 36 | Status update: Connected 37 | Success 38 | ``` 39 | ### Using as a proxy for other containers with docker-compose 40 | 41 | ``` 42 | version: "3" 43 | services: 44 | warp: 45 | image: ghcr.io/aleskxyz/warp-svc:latest 46 | expose: 47 | - 1080 48 | restart: always 49 | environment: 50 | WARP_LICENSE: xxxxxxxx-xxxxxxxx-xxxxxxxx 51 | FAMILIES_MODE: off 52 | volumes: 53 | - ./warp:/var/lib/cloudflare-warp 54 | app: 55 | image: 56 | depends_on: 57 | - warp 58 | environment: 59 | proxy: warp:1080 60 | ``` 61 | 62 | -------------------------------------------------------------------------------- /configs/logrotate.conf: -------------------------------------------------------------------------------- 1 | /var/lib/cloudflare-warp/*.txt { 2 | size 10M 3 | rotate 5 4 | compress 5 | missingok 6 | notifempty 7 | copytruncate 8 | } -------------------------------------------------------------------------------- /configs/supervisord.conf: -------------------------------------------------------------------------------- 1 | [supervisord] 2 | nodaemon=true 3 | logfile=/dev/null 4 | pidfile=/var/run/supervisord.pid 5 | logfile_maxbytes=0 6 | 7 | [unix_http_server] 8 | file=/var/run/supervisor.sock 9 | 10 | [rpcinterface:supervisor] 11 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface 12 | 13 | [supervisorctl] 14 | serverurl=unix:///var/run/supervisor.sock 15 | 16 | [program:socat] 17 | command=socat tcp-listen:1080,reuseaddr,fork tcp:localhost:40000 18 | autostart=true 19 | autorestart=true 20 | stdout_logfile=/dev/stdout 21 | stdout_logfile_maxbytes=0 22 | stderr_logfile=/dev/stderr 23 | stderr_logfile_maxbytes=0 24 | 25 | [program:warp-svc] 26 | command=/scripts/warp.sh 27 | autostart=true 28 | autorestart=true 29 | stdout_logfile=/dev/stdout 30 | stdout_logfile_maxbytes=0 31 | stderr_logfile=/dev/stderr 32 | stderr_logfile_maxbytes=0 33 | 34 | [program:healthcheck] 35 | command=/scripts/healthcheck.sh 36 | autostart=false 37 | autorestart=true 38 | stdout_logfile=/dev/stdout 39 | stdout_logfile_maxbytes=0 40 | stderr_logfile=/dev/stderr 41 | stderr_logfile_maxbytes=0 42 | 43 | [program:logrotate] 44 | command=/scripts/logrotate.sh 45 | autostart=true 46 | autorestart=true 47 | stdout_logfile=/dev/stdout 48 | stdout_logfile_maxbytes=0 49 | stderr_logfile=/dev/stderr 50 | stderr_logfile_maxbytes=0 51 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3" 2 | services: 3 | warp: 4 | image: ghcr.io/aleskxyz/warp-svc:latest 5 | ports: 6 | - 1080:1080 7 | restart: always 8 | environment: 9 | - "WARP_LICENSE=" 10 | - "FAMILIES_MODE=off" 11 | volumes: 12 | - ./warp:/var/lib/cloudflare-warp 13 | -------------------------------------------------------------------------------- /scripts/healthcheck.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Trap SIGTERM and SIGINT to handle graceful shutdown 4 | trap 'kill ${sleep_pid}; exit 0' SIGTERM SIGINT 5 | 6 | # Main loop 7 | while true; do 8 | # Check if the Cloudflare WARP service is working 9 | if ! curl --retry 3 -m 3 -sSLx socks5h://127.0.0.1:40000 https://www.cloudflare.com/cdn-cgi/trace/ | grep -q "warp=on" &> /dev/null; then 10 | # Restart the warp-svc service if WARP is not working 11 | echo "WARP service is not working. Restarted warp-svc." 12 | supervisorctl restart warp-svc 13 | fi 14 | # Sleep in a way that allows interruption 15 | sleep 60 & 16 | sleep_pid=$! 17 | wait $sleep_pid 18 | done -------------------------------------------------------------------------------- /scripts/logrotate.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Trap SIGTERM and SIGINT to handle graceful shutdown 4 | trap 'kill ${sleep_pid}; exit 0' SIGTERM SIGINT 5 | 6 | # Remove write access for group and others. 7 | chmod go-w /var/lib/cloudflare-warp 8 | 9 | # Main loop 10 | while true; do 11 | logrotate /etc/logrotate.conf 12 | # Sleep in a way that allows us to interrupt it 13 | sleep 60 & 14 | sleep_pid=$! 15 | wait $sleep_pid 16 | done 17 | -------------------------------------------------------------------------------- /scripts/warp.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -e 4 | 5 | # Kill any existing instances of warp-svc before starting a new one 6 | if pkill -x warp-svc -9; then 7 | echo "Existing warp-svc process killed." 8 | fi 9 | 10 | # Start warp-svc in the background and redirect output to exclude dbus messages 11 | warp-svc > >(grep -iv dbus) 2> >(grep -iv dbus >&2) & 12 | WARP_PID=$! 13 | 14 | # Trap SIGTERM and SIGINT, and forward those signals to the warp-svc process 15 | trap "echo 'Stopping warp-svc...'; kill -TERM $WARP_PID; exit" SIGTERM SIGINT 16 | 17 | # Maximum number of attempts to try the registration 18 | MAX_ATTEMPTS=5 19 | attempt_counter=0 20 | 21 | echo "Attempting to start warp-svc and register..." 22 | 23 | # Function to check service status and attempt registration 24 | function attempt_registration { 25 | until warp-cli --accept-tos registration new &> /dev/null; do 26 | echo "Wait for warp-svc to start... Attempt $((++attempt_counter)) of $MAX_ATTEMPTS" 27 | sleep 1 28 | if [[ $attempt_counter -ge $MAX_ATTEMPTS ]]; then 29 | echo "Failed to register after $MAX_ATTEMPTS attempts. Exiting." 30 | return 1 31 | fi 32 | done 33 | echo "warp-svc has been started and registered successfully!" 34 | } 35 | 36 | # Call the registration function 37 | if attempt_registration; then 38 | echo "Service started and registered successfully." 39 | else 40 | echo "There was an issue starting the service or registering. Check logs for details." 41 | kill $WARP_PID 42 | exit 1 43 | fi 44 | 45 | # Set the proxy port to 40000 46 | warp-cli --accept-tos proxy port 40000 47 | 48 | # Set the mode to proxy 49 | warp-cli --accept-tos mode proxy 50 | 51 | # Disable DNS log 52 | warp-cli --accept-tos dns log disable 53 | 54 | # Set the families mode based on the value of the FAMILIES_MODE variable 55 | warp-cli --accept-tos dns families "${FAMILIES_MODE}" 56 | 57 | # Set the WARP_LICENSE if it is not empty 58 | if [[ -n $WARP_LICENSE ]]; then 59 | warp-cli --accept-tos registration license "${WARP_LICENSE}" 60 | fi 61 | 62 | # Connect to the WARP service 63 | warp-cli --accept-tos connect 64 | 65 | while true; do 66 | # Check if warp-cli is connected 67 | if warp-cli --accept-tos status | grep -iq connected; then 68 | echo "Connected successfully." 69 | # If connected, start healthcheck and break the loop 70 | supervisorctl start healthcheck 71 | break 72 | else 73 | echo "Not connected. Checking again..." 74 | fi 75 | # Wait for a specified time before checking again 76 | sleep 1 77 | done 78 | 79 | # Wait for warp-svc process to finish 80 | wait $WARP_PID 81 | --------------------------------------------------------------------------------