Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maple3142/cf-warp
https://github.com/maple3142/cf-warp
vpn warp wireguard
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/maple3142/cf-warp
- Owner: maple3142
- License: mit
- Created: 2019-10-01T15:46:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T21:54:53.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T12:19:10.782Z (4 months ago)
- Topics: vpn, warp, wireguard
- Language: JavaScript
- Size: 57.6 KB
- Stars: 439
- Watchers: 20
- Forks: 64
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - maple3142/cf-warp - (JavaScript)
README
# cf-warp
> A simple cli to get [Warp+](https://blog.cloudflare.com/announcing-warp-plus/) as [WireGuard](https://www.wireguard.com/) configuration
> For people who just want a easy way to get a WireGuard of Warp, just download this file: [https://cf-warp.maple3142.net/warp.conf](https://cf-warp.maple3142.net/warp.conf).
> Source code of the backend can be found [here](https://glitch.com/edit/#!/cf-warp).
## Usage
By using this, you agree the [Privacy Policy](https://www.cloudflare.com/application/privacypolicy/) and [Terms of Service](https://www.cloudflare.com/application/terms/) of Cloudflare 1.1.1.1
### With Node.js (Recommended)
#### Step 1
Install `cf-warp` globally through yarn or npm.
```bash
yarn global add cf-warp # npm i -g cf-warp
```
#### Step 2
Initialize your Warp+ account by running `cf-warp` command.
Example:
```bash
$ cf-warp
Your Warp credentials are located at "C:\Users\maple3142\.cf-warp\data.json", and WireGuard connection file is "C:\Users\maple3142\.cf-warp\cf-warp.conf".
You currently have 1GB Warp+ quota.
To get your current Warp+ quota, simply run "cf-warp".
To increase your Warp+ quota by 10 GB, simply run "cf-warp 10".
```
#### Step 3
Obtain `cf-warp.conf` from `~/.cf-warp/cf-warp.conf` and use it normally.
### Without Node.js
#### Step 1
Go ahead to [releases](https://github.com/maple3142/cf-warp/releases) page and download a binary for your platform.
#### Step 2
Open your cmd/terminal and locate the binary you just downloaded, such as `cf-warp-win.exe` ...
#### Step 3
Use it just like `cf-warp` installed by npm.
### With Docker
#### Step 1
```bash
docker run --rm -v ~/.cf-warp:/root/.cf-warp maple3142/cf-warp [args]
```
## FAQ
### How does `cf-warp` get Warp+ quota for free?
It currently get quota by faking referrers since there is no way to pay for premium version outside of 1.1.1.1 app, but it is recommended to pay for it on your phone if you think their service is good.
### How do link this to a WARP+ license from the mobile 1.1.1.1 app?
1. Find your license key on your mobile 1.1.1.1 app
- It should be under settings/account/key, in the form of "1a2b3d4e-1a2b3d4e-1a2b3d4e"
2. Copy that key, and run the command:
```bash
cf-warp --license 1a2b3d4e-1a2b3d4e-1a2b3d4e #Your own license key goes here
```
3. When done, the current config should be sharing the same data quota as the mobile 1.1.1.1
- If you've paid on your phone, this config should enjoy unlimited data and WARP+.
### IPv6 doesn't works in Linux by default
Due to the private tunnel local address Linux needs `getaddrinfo` [configuration](https://github.com/maple3142/cf-warp/issues/9#issuecomment-716139339).
## Thanks
https://github.com/yyuueexxiinngg/some-scripts/tree/master/cloudflare