Skip to content

Commit

Permalink
misc: update readme and termux.sh
Browse files Browse the repository at this point in the history
Signed-off-by: Mark Pashmfouroush <[email protected]>
  • Loading branch information
markpash committed May 23, 2024
1 parent 7beee3e commit f9e8b8d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 28 deletions.
47 changes: 21 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,41 +13,34 @@ Warp-Plus is an open-source implementation of Cloudflare's Warp, enhanced with P

### Prerequisites

- You can download prebuilt binaries or compile it with Go (You MUST use go 1.22)
- [Download the latest version from the releases page](https://github.com/bepass-org/warp-plus/releases)
- Basic understanding of VPN and proxy configurations

### Installation

1. Clone the repository:
```bash
git clone https://github.com/bepass-org/warp-plus.git
cd warp-plus
```

2. Build the project:
```bash
go build
```

### Usage

```
NAME
warp-plus
FLAGS
-4 only use IPv4 for random warp endpoint
-6 only use IPv6 for random warp endpoint
-v, --verbose enable verbose logging
-b, --bind STRING socks bind address (default: 127.0.0.1:8086)
-e, --endpoint STRING warp endpoint
-k, --key STRING warp key
--gool enable gool mode (warp in warp)
--cfon enable psiphon mode (must provide country as well)
--country STRING psiphon country code (valid values: [AT BE BG BR CA CH CZ DE DK EE ES FI FR GB HU IE IN IT JP LV NL NO PL RO RS SE SG SK UA US]) (default: AT)
--scan enable warp scanning
--rtt DURATION scanner rtt limit (default: 1s)
-c, --config STRING path to config file
-4 only use IPv4 for random warp endpoint
-6 only use IPv6 for random warp endpoint
-v, --verbose enable verbose logging
-b, --bind STRING socks bind address (default: 127.0.0.1:8086)
-e, --endpoint STRING warp endpoint
-k, --key STRING warp key
--dns STRING DNS address (default: 1.1.1.1)
--gool enable gool mode (warp in warp)
--cfon enable psiphon mode (must provide country as well)
--country STRING psiphon country code (valid values: [AT BE BG BR CA CH CZ DE DK EE ES FI FR GB HR HU IE IN IT JP LV NL NO PL PT RO RS SE SG SK UA US]) (default: AT)
--scan enable warp scanning
--rtt DURATION scanner rtt limit (default: 1s)
--cache-dir STRING directory to store generated profiles
--tun-experimental enable tun interface (experimental)
--fwmark UINT set linux firewall mark for tun mode (default: 4981)
--wgconf STRING path to a normal wireguard config
-c, --config STRING path to config file
--version displays version number
```

### Country Codes for Psiphon
Expand All @@ -67,6 +60,7 @@ FLAGS
- France (FR)
- United Kingdom (GB)
- Hungary (HU)
- Croatia (HR)
- Ireland (IE)
- India (IN)
- Italy (IT)
Expand All @@ -75,6 +69,7 @@ FLAGS
- Netherlands (NL)
- Norway (NO)
- Poland (PL)
- Portugal (PT)
- Romania (RO)
- Serbia (RS)
- Sweden (SE)
Expand Down
4 changes: 2 additions & 2 deletions termux.sh
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ install() {
pacman -Syu openssh = apt update; apt full-upgrade -y; apt install -y openssh
check_dependencies

if wget https://github.com/bepass-org/warp-plus/releases/download/v1.1.3/warp-plus_android-arm64.zip &&
if wget https://github.com/bepass-org/warp-plus/releases/download/v1.2.0/warp-plus_android-arm64.zip &&
unzip warp-plus_android-arm64.zip &&
mv warp-plus warp &&
chmod +x warp &&
Expand Down Expand Up @@ -85,7 +85,7 @@ install_arm() {
*) echo -e "${red}Unsupported architecture.${rest}"; return ;;
esac

WARP_URL="https://github.com/bepass-org/warp-plus/releases/download/v1.1.3/warp-plus_linux-$ARCH.zip"
WARP_URL="https://github.com/bepass-org/warp-plus/releases/download/v1.2.0/warp-plus_linux-$ARCH.zip"

if wget "$WARP_URL" &&
unzip "warp-plus_linux-$ARCH.zip" &&
Expand Down

0 comments on commit f9e8b8d

Please sign in to comment.