github.com/bepass-org/wireguard-go@v1.0.4-rc2.0.20240304192354-ebce6572bc24/README.md (about)

     1  # Warp-Plus-Go
     2  
     3  Warp-Plus-Go is an open-source implementation of Cloudflare's Warp, enhanced with Psiphon integration for circumventing censorship. This project aims to provide a robust and cross-platform VPN solution that can use psiphon on top of warp and warp-in-warp for changing the user virtual nat location.
     4  
     5  ## Features
     6  
     7  - **Warp Integration**: Leverages Cloudflare's Warp to provide a fast and secure VPN service.
     8  - **Psiphon Chaining**: Integrates with Psiphon for censorship circumvention, allowing seamless access to the internet in restrictive environments.
     9  - **Warp in Warp Chaining**: Chaning two instances of warp together to bypass location restrictions.
    10  - **Cross-Platform Support**: Designed to work on multiple platforms, offering the same level of functionality and user experience.
    11  - **SOCKS5 Proxy Support**: Includes a SOCKS5 proxy for secure and private browsing.
    12  - **Verbose Logging**: Optional verbose logging for troubleshooting and performance monitoring.
    13  
    14  ## Getting Started
    15  
    16  ### Prerequisites
    17  
    18  - You can download prebuilt binaries or compile it with Go (You MUST use go 1.20)
    19  - Basic understanding of VPN and proxy configurations
    20  
    21  ### Installation
    22  
    23  1. Clone the repository:
    24     ```bash
    25     git clone https://github.com/bepass-org/wireguard-go.git
    26     cd warp-plus-go
    27     ```
    28  
    29  2. Build the project:
    30     ```bash
    31     go build
    32     ```
    33  
    34  ### Usage
    35  
    36  Run the application with the following command:
    37  
    38  ```bash
    39  ./warp-plus-go [-v] [-b addr:port] [-c config-file-path] [-e warp-ip] [-k license-key] [-country country-code] [-cfon] [-gool]
    40  ```
    41  
    42  - `-v`: Enable verbose logging.
    43  - `-b`: Set the SOCKS bind address (default: `127.0.0.1:8086`).
    44  - `-c`: Path to the Warp configuration file.
    45  - `-e`: Specify the Warp endpoint IP.
    46  - `-k`: Your Warp license key.
    47  - `-gool`: enable warp in warp.
    48  - `-country`: ISO 3166-1 alpha-2 country code for Psiphon.
    49  - `-cfon`: Enable Psiphon over Warp.
    50  - `-rtt`: scanner rtt threshold, default is `1000`
    51  
    52  ### Country Codes for Psiphon
    53  
    54  - Austria (AT)
    55  - Belgium (BE)
    56  - Bulgaria (BG)
    57  - Brazil (BR)
    58  - Canada (CA)
    59  - Switzerland (CH)
    60  - Czech Republic (CZ)
    61  - Germany (DE)
    62  - Denmark (DK)
    63  - Estonia (EE)
    64  - Spain (ES)
    65  - Finland (FI)
    66  - France (FR)
    67  - United Kingdom (GB)
    68  - Hungary (HU)
    69  - Ireland (IE)
    70  - India (IN)
    71  - Italy (IT)
    72  - Japan (JP)
    73  - Latvia (LV)
    74  - Netherlands (NL)
    75  - Norway (NO)
    76  - Poland (PL)
    77  - Romania (RO)
    78  - Serbia (RS)
    79  - Sweden (SE)
    80  - Singapore (SG)
    81  - Slovakia (SK)
    82  - Ukraine (UA)
    83  - United States (US)
    84  
    85  ### Termux
    86  
    87  ```
    88  bash <(curl -fsSL https://raw.githubusercontent.com/Ptechgithub/wireguard-go/master/termux.sh)
    89  ```
    90  ![1](https://github.com/Ptechgithub/configs/blob/main/media/18.jpg?raw=true)
    91  
    92  - بعد از نصب برای اجرای مجدد فقط کافیه که `warp` یا `usef` یا `./warp` را وارد کنید . 
    93  - اگر با 1 نصب نشد و خطا گرفتید عدد 2 رو انتخاب کنید یعنی Arm.
    94  - برای نمایش راهنما ` warp -h` را وارد کنید. 
    95  - ای پی و پورت `127.0.0.1:8086`پروتکل socks
    96  - در روش warp به warp plus مقدار account id را وارد میکنید و با این کار هر 20 ثانیه 1 GB به اکانت شما اضافه میشود. 
    97  - برای تغییر  لوکیشن با استفاده از سایفون برای مثال به USA  از دستور  زیر استفاده کنید: 
    98  - `warp -cfon -country US`
    99  - برای اسکن ای پی سالم وارپ از دستور `warp -scan` استفاده کنید. 
   100  - برای ترکیب (chain) دو کانفیگ برای تغییر لوکیشن از دستور `warp -gool` استفاده کنید. 
   101  
   102  ## Contributing
   103  
   104  Contributions to Warp-Plus-Go are welcome. Please read our [contributing guidelines](CONTRIBUTING.md) for more information.
   105  
   106  ## Acknowledgements
   107  
   108  - Cloudflare Warp
   109  - Psiphon
   110  - All contributors and supporters of this project
   111  
   112  ## License
   113  
   114      Copyright (C) 2017-2023 WireGuard LLC. All Rights Reserved.
   115      
   116      Permission is hereby granted, free of charge, to any person obtaining a copy of
   117      this software and associated documentation files (the "Software"), to deal in
   118      the Software without restriction, including without limitation the rights to
   119      use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
   120      of the Software, and to permit persons to whom the Software is furnished to do
   121      so, subject to the following conditions:
   122      
   123      The above copyright notice and this permission notice shall be included in all
   124      copies or substantial portions of the Software.
   125      
   126      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   127      IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   128      FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   129      AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   130      LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   131      OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   132      SOFTWARE.