You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added localization
Fix GitHub Actions
Make android signing optional
Remove build/run scripts
Remove vpnclient-engine project include from android
Update flutter version to v3.29.3
*Diagram: The Flutter UI calls into the VPNclient Engine via a Flutter plugin. The native engine runs on each supported platform (iOS, Android, etc.), handling low-level network operations.*
@@ -46,37 +46,39 @@ This modular design makes it easy to maintain and extend. UI/UX changes can be m
46
46
47
47
There are two ways to get VPNclient App:
48
48
49
-
**1. Install a Pre-built Release (End Users):**
49
+
###Install a Pre-built Release (End Users)
50
50
VPNclient App is in active development and available in beta form:
51
-
-**Android:** Download via Google Play [VPNclient on Google Play](https://play.google.com/store/apps/details?id=vpnclient.click) (or join the testing program). Requires Android 6.0 or higher.
52
-
-**iOS:** Download via App Store – [VPNclient on App Store](https://testflight.apple.com/join/KQr4SeS7). Requires iOS 15.6 or higher.
51
+
-**Android:** Download via Google Play [VPNclient on Google Play](https://play.google.com/store/apps/details?id=click.vpnclient) (or join the testing program). Requires Android 6.0 or higher.
52
+
-**iOS:** Download via App Store – [VPNclient on App Store](https://testflight.apple.com/join/KQr4SeS7). Requires iOS 15.6 or higher.
53
53
54
54
After installing, simply launch the app. On first launch, you may be prompted to accept VPN permissions (Android) or install a VPN profile (iOS) – these are required to create the VPN tunnel.
55
55
56
-
**2. Build from Source (Developers):**
56
+
###Build from Source (Developers)
57
57
If you want to try the latest version or modify the app, you can build it yourself:
58
58
59
-
-**Prerequisites:** Install Flutter (Flutter 3 or later recommended) and Dart SDK on your system. Ensure you can run `flutter` commands and have setup Flutter for your target platforms (e.g. Xcode for iOS, Android SDK for Android).
60
-
-**Clone the Repositories:** This app depends on the VPNclient Engine Flutter plugin. Clone the following repository from GitHub:
-**Get Dependencies:** Navigate into the `VPNclient-app` directory and run:
65
-
```bash
66
-
flutter pub get
67
-
```
68
-
This will fetch Flutter packages and link the local plugin.
69
-
-**Platform Setup:**
70
-
- For **Android**, ensure you have an Android device/emulator and the Android SDK. The app uses the VpnService API; no additional setup is required except granting VPN permissions when prompted.
71
-
- For **iOS**, open the Xcode workspace (`ios/Runner.xcworkspace`) and **enable the “Personal VPN” capability** in the project (this automatically updates entitlements). Also, in `ios/Runner/Info.plist`, ensure the required VPN usage descriptions are present (the engine may use a custom key such as `allow-vpn`). You will need a valid Apple Developer Team provisioning for running VPN entitlements on device.
72
-
- For **macOS/Windows/Linux**, additional setup may be needed (e.g., on Windows, the `wintun` driver should be present; on Linux, you might need root or capabilities to create a TUN interface). Desktop support is experimental and may require manual configuration.
73
-
-**Run the App:** Use Flutter CLI to run on your desired platform:
74
-
```bash
75
-
flutter run
76
-
```
77
-
This will launch the app on an emulator or connected device. You can also build release APKs or app bundles using `flutter build apk` / `flutter build appbundle` (Android) or an IPA (iOS) with Xcode. For desktop, `flutter run -d macos` or `-d windows` can be used if enabled.
78
-
79
-
*Note:* The repository includes helper shell scripts (`build_android.sh`, `build_ipa.sh`, etc.) which automate some build steps for CI or local packaging.
59
+
1.**Prerequisites:** Install Flutter (Flutter 3 or later recommended) and Dart SDK on your system. Ensure you can run `flutter` commands and have setup Flutter for your target platforms (e.g. Xcode for iOS, Android SDK for Android).
60
+
61
+
2.**Clone the Repositories:** This app depends on the VPNclient Engine Flutter plugin. Clone the following repository from GitHub:
3.**Get Dependencies:** Navigate into the `VPNclient-app` directory and run:
67
+
```sh
68
+
flutter pub get
69
+
```
70
+
This will fetch Flutter packages and link the local plugin.
71
+
72
+
4.**Platform Setup:**
73
+
- For **Android**, ensure you have an Android device/emulator and the Android SDK. The app uses the VpnService API; no additional setup is required except granting VPN permissions when prompted.
74
+
- For **iOS**, open the Xcode workspace (`ios/Runner.xcworkspace`) and **enable the “Personal VPN” capability** in the project (this automatically updates entitlements). Also, in `ios/Runner/Info.plist`, ensure the required VPN usage descriptions are present (the engine may use a custom key such as `allow-vpn`). You will need a valid Apple Developer Team provisioning for running VPN entitlements on device.
75
+
- For **macOS/Windows/Linux**, additional setup may be needed (e.g., on Windows, the `wintun` driver should be present; on Linux, you might need root or capabilities to create a TUN interface). Desktop support is experimental and may require manual configuration.
76
+
77
+
5.**Run the App:** Use Flutter CLI to run on your desired platform:
78
+
```sh
79
+
flutter run
80
+
```
81
+
This will launch the app on an emulator or connected device. You can also build release APKs or app bundles using `flutter build apk` / `flutter build appbundle` (Android). There is also a lot of other option to build, you can use `flutter build -h` to list all avaliable options.
80
82
81
83
## Usage Guide
82
84
@@ -87,9 +89,9 @@ Once the VPNclient App is installed and running, using it is straightforward:
87
89
-**Connecting:** On the main screen, tap the **Connect** button (often a large toggle or icon). The first time, your device will ask for VPN connection permission – accept it. The app will then initiate the connection using the selected server and protocol. Within a few seconds, you should see the status change to "Connected", along with a key icon on your status bar (mobile) indicating an active VPN.
88
90
-**During Connection:** While connected, the app may show real-time stats such as upload/download speeds and total data used this session. It will also indicate the current server name or IP. If any error occurs (e.g., invalid credentials or network unreachable), the app will display an error message.
89
91
-**Routing Rules:** If you want to customize which traffic goes through the VPN, go to the **Settings** or **Routing** section. Here you can add rules. For example:
90
-
- Route specific apps through VPN (e.g., route your web browser and video apps through the VPN for privacy, but let banking apps go direct).
91
-
- Route or block specific domains (e.g., send `*.example.com` through VPN or block `ads.example.net`).
92
-
Set your desired rules and save. The VPNclient Engine will enforce these rules when connected.
92
+
- Route specific apps through VPN (e.g., route your web browser and video apps through the VPN for privacy, but let banking apps go direct).
93
+
- Route or block specific domains (e.g., send `*.example.com` through VPN or block `ads.example.net`).
94
+
Set your desired rules and save. The VPNclient Engine will enforce these rules when connected.
93
95
-**Disconnecting:** To stop the VPN, tap the **Disconnect** button. The status will change to "Disconnected" and your internet traffic will resume normal direct routing. You can reconnect at any time by tapping Connect again.
94
96
-**Auto-Connect & Kill Switch:** In settings, you may enable **Auto-Connect** so that the app automatically connects to the last used or a preferred server on startup or when it detects internet connectivity. Enabling the **Kill Switch** ensures that if the VPN drops, the app will block all internet traffic until the VPN is reconnected (preventing leaks). Use these features if you require always-on protection.
95
97
-**Profiles and Configs:** If you use multiple VPN profiles (for example, personal VPN vs. work VPN), you can manage them via separate subscription links or configuration import. The app can handle multiple profiles – they will be listed separately. Select the profile or server group you want before connecting.
0 commit comments