Merge branch 'bepass-org:master' into master

Ptechgithub · May 24, 2024 · a44e6f4 · a44e6f4
2 parents 2914f6e + b674937
commit a44e6f4
Show file tree

Hide file tree

Showing 26 changed files with 1,437 additions and 605 deletions.
diff --git a/.github/workflows/container-image.yaml b/.github/workflows/container-image.yaml
@@ -0,0 +1,56 @@
+name: Container Image
+
+on:
+  push:
+    branches:
+      - master
+      - main
+    tags:
+      - v**
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build-publish:
+    name: Build and publish container image
+    runs-on: ubuntu-latest
+    env:
+      CGO_ENABLED: 0
+      PLATFORMS: linux/arm/v7,linux/arm64,linux/amd64
+    steps:
+      - name: Checkout codebase
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+          check-latest: true
+
+      - name: Setup `ko`
+        # The latest (@v0.6) version of this workflow has bug if there are uppercase letters in repo name
+        uses: ko-build/setup-ko@main
+
+      - name: Extract metadata
+        uses: docker/metadata-action@v5
+        id: meta
+        with:
+          # The images doesn't required, as only tags needed for the ko build step.
+          images: ""
+          tags: |
+            type=ref,event=branch
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+            type=sha,format=long
+
+      - name: Build and push image
+        env:
+          TAGS: ${{ steps.meta.outputs.tags }}
+        run: ko build --platform "${PLATFORMS}" --bare --tags $(echo $TAGS | tr ' ' ',')
diff --git a/.github/workflows/go-build.yaml b/.github/workflows/go-build.yaml
@@ -26,15 +26,19 @@ jobs:
             goarch: amd64
           - goos: linux
             goarch: arm64
+          - goos: linux
+            goarch: arm
+            goarm: 7
           - goos: linux
             goarch: riscv64
           - goos: linux
             goarch: mips64
           - goos: linux
             goarch: mips64le
           - goos: linux
-            goarch: arm
-            goarm: 7
+            goarch: mips
+          - goos: linux
+            goarch: mipsle
 
           - goos: windows
             goarch: amd64
@@ -61,12 +65,12 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.21'
+          go-version: '1.22'
           check-latest: true
 
       - name: Build warp-plus
         run: |
-          go build -v -o build_assets/ -trimpath -ldflags "-s -w -buildid=" .
+          go build -v -o build_assets/ -trimpath -ldflags "-s -w -buildid= -X main.version=${{ github.ref }}" .
 
       - name: Copy README.md & LICENSE
         run: |

diff --git a/README.md b/README.md
@@ -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.21)
+- [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
@@ -67,6 +60,7 @@ FLAGS
 - France (FR)
 - United Kingdom (GB)
 - Hungary (HU)
+- Croatia (HR)
 - Ireland (IE)
 - India (IN)
 - Italy (IT)
@@ -75,6 +69,7 @@ FLAGS
 - Netherlands (NL)
 - Norway (NO)
 - Poland (PL)
+- Portugal (PT)
 - Romania (RO)
 - Serbia (RS)
 - Sweden (SE)