Instructions for appbundle not connected

nizwar · nizwar · commit 63e91dc49a93 · 2025-02-16T13:19:20.000+07:00
diff --git a/README.md b/README.md
@@ -1,61 +1,84 @@
-Connect OpenVPN service with Flutter, Issues and PRs are very welcome!
+Connect to the OpenVPN service using Flutter. Contributions through issues and pull requests are highly appreciated!
 
 ## Android Setup
-### <b>1. Permission handler</b>
-#### JAVA
-Add this to your onActivityResult in MainActivity.java (if you are using Java)
+
+### 1. Permission Handler
+
+#### Java
+Include the following code in the `onActivityResult` method of `MainActivity.java` (if you are using Java):
 
 ```java
-    OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK);
+OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK);
 ```
-So it look like this
+
+The complete method should look like this:
+
 ```java
-    ...
-    import id.laskarmedia.openvpn_flutter.OpenVPNFlutterPlugin;
-    ...
-    
-    @Override
-    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-        OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK);
-        super.onActivityResult(requestCode, resultCode, data);
-    }
+...
+import id.laskarmedia.openvpn_flutter.OpenVPNFlutterPlugin;
+...
+
+@Override
+protected void onActivityResult(int requestCode, int resultCode, Intent data) {
+    OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK);
+    super.onActivityResult(requestCode, resultCode, data);
+}
 ```
 
 #### Kotlin
-Add this to your onAcivityResult in MainActivity.kt (if you are using Kotlin)
+Include the following code in the `onActivityResult` method of `MainActivity.kt` (if you are using Kotlin):
 
 ```kotlin
-    OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK);
+OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK);
 ```
-So it look like this
+
+The complete method should look like this:
+
 ```kotlin
-   ...
-    import id.laskarmedia.openvpn_flutter.OpenVPNFlutterPlugin
-   ...
-    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
-        OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK)
-        super.onActivityResult(requestCode, resultCode, data)
-    }
+...
+import id.laskarmedia.openvpn_flutter.OpenVPNFlutterPlugin
+...
+override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
+    OpenVPNFlutterPlugin.connectWhileGranted(requestCode == 24 && resultCode == RESULT_OK)
+    super.onActivityResult(requestCode, resultCode, data)
+}
+```
+
+### 2. App Bundle Build Not Connecting
+
+If you encounter issues with the app not connecting using the latest Flutter SDK, apply the following quick fix:
+
+Ensure that you include the following attribute within the `<application>` tag in your `AndroidManifest.xml` file:
+
+```xml
+<application
+    ...
+    android:extractNativeLibs="true"
+    ...>
+</application>
 ```
 
 ## iOS Setup
 
-### <b>1. Add Capabillity</b>
-Add 2 capabillity on Runner's Target, <b>App Groups</b> and <b>Network Extensions</b>, Look at the image below to get clearer details
+### 1. Add Capabilities
+
+Add the `App Groups` and `Network Extensions` capabilities to the Runner's target. Refer to the image below for detailed instructions:
 
 <img src="https://blogger.googleusercontent.com/img/a/AVvXsEjYWGJ2ug4JM5g8_WslvdRY0Q-UUizOdmoCG8Ybhte9LiIv8_SSYFDHl-PzWApnAxvTA0hdpnBzca7C_zU5pHnyD8NLNoMw1ZOty7Zo6PTF22oIk7liB0aCXQnRAI1R0Zv9XfnuwuHuourtUR6lzf1ztrU_PTa6QFAU8kRPK-4h5MVu7QVzmpVs4Fvl=s600"/>
 
-### <b>2. Add New Target</b>
-Click + button on bottom left, Choose <b>NETWORK EXTENSION</b>, and follow instruction's image bellow
+### 2. Add New Target
+
+Click the `+` button on the bottom left, choose `NETWORK EXTENSION`, and follow the instructions in the image below:
 
 <img src="https://blogger.googleusercontent.com/img/a/AVvXsEirvK1MMCqLADbXdtjppE-z1QC_cDPBnCWZ1EPkNLCM7TYyG3c2IGf8zlb1svW6aP6UB4eNOpX3svFwP_e9D0iP9Mb-dlXVtnUsYlg3iIQVqi_mmw4vLH5d8peEt7UGORikSlB3Hy0o1vj4XIBJNv5g8bIellHTXo4Zu4toh7Dt0jw4ZMyWDAoepLp7=s600"/>
 
-Add Capabillity on VPNExtension, Do it same like Runner's Capabillitiy
+Add the same capabilities to the VPNExtension as you did for the Runner's target:
 
 <img src="https://blogger.googleusercontent.com/img/a/AVvXsEgEj_1oXmgRSaVISGFHutY88enlUG1V8ynqfDHso-uS6vKEBLa-dhhChjZQ12iN7UpNM6thCHLmll3h6p_lW9URAPca-pXkwIN1pmATdfk3NnqnmlYtgUAicbr-zDZmNF7JJ4l4EArFtdrb_IjxH_FpLJGCURkpGO9qBtkw9WYs3k2vRSa3c8ga9b6S=s600"/>
 
-### <b>3. Copy Paste</b>
-Add the following lines to your Podfile (`ios/Podfile`)
+### 3. Copy and Paste
+
+Add the following lines to your Podfile (`ios/Podfile`):
 
 ```dart
 target 'VPNExtension' do
@@ -64,49 +87,48 @@ target 'VPNExtension' do
 end
 ```
 
-Open VPNExtension > PacketTunnelProvider.swift and copy paste this script <a href="https://raw.githubusercontent.com/nizwar/openvpn_flutter/master/example/ios/VPNExtension/PacketTunnelProvider.swift">PacketTunnelProvider.swift</a>
+Open `VPNExtension > PacketTunnelProvider.swift` and copy-paste the script from [PacketTunnelProvider.swift](https://raw.githubusercontent.com/nizwar/openvpn_flutter/master/example/ios/VPNExtension/PacketTunnelProvider.swift).
 
 <img src="https://blogger.googleusercontent.com/img/a/AVvXsEhPf7Vl_8LPYMTTCn0UbpR3f3qzaFPFRMikSg8xetWRyfTuViq6o3fdrjU4-jD-xZtkOZV_i2WoNXkcHLn7znHengHZGgtlJlNbNk6vjNYgI2jYg8ToOYIQjR7QBd443ee4GqpEww0FYPrIiIpabUthpur6SakiPJM1dsDNCBW9ROWixuEzrk61aIod=s600">
 
 ## Note
-You must use iOS Devices instead of Simulator to connect
-
 
+You must use iOS devices instead of the simulator to connect.
 
 ## Recipe
 
 ### Initialize
-Before start, you have to initialize the OpenVPN plugin.
 
-```dart
-    late OpenVPN openvpn;
-
-    @override
-    void initState() {
-        openvpn = OpenVPN(onVpnStatusChanged: _onVpnStatusChanged, onVpnStageChanged: _onVpnStageChanged);
-        openvpn.initialize(
-            groupIdentifier: "GROUP_IDENTIFIER", ///Example 'group.com.laskarmedia.vpn'
-            providerBundleIdentifier: "NETWORK_EXTENSION_IDENTIFIER", ///Example 'id.laskarmedia.openvpnFlutterExample.VPNExtension'
-            localizedDescription: "LOCALIZED_DESCRIPTION" ///Example 'Laskarmedia VPN'
-        );
-    }
+Before starting, initialize the OpenVPN plugin:
 
-    void _onVpnStatusChanged(VPNStatus? vpnStatus){
-        setState((){
-            this.status = vpnStatus;
-        });
-    }
+```dart
+late OpenVPN openvpn;
+
+@override
+void initState() {
+    openvpn = OpenVPN(onVpnStatusChanged: _onVpnStatusChanged, onVpnStageChanged: _onVpnStageChanged);
+    openvpn.initialize(
+        groupIdentifier: "GROUP_IDENTIFIER", ///Example 'group.com.laskarmedia.vpn'
+        providerBundleIdentifier: "NETWORK_EXTENSION_IDENTIFIER", ///Example 'id.laskarmedia.openvpnFlutterExample.VPNExtension'
+        localizedDescription: "LOCALIZED_DESCRIPTION" ///Example 'Laskarmedia VPN'
+    );
+}
 
-    void _onVpnStageChanged(VPNStage? stage){
-        setState((){
-            this.stage = stage;
-        });
-    }
+void _onVpnStatusChanged(VPNStatus? vpnStatus){
+    setState((){
+        this.status = vpnStatus;
+    });
+}
 
+void _onVpnStageChanged(VPNStage? stage){
+    setState((){
+        this.stage = stage;
+    });
+}
 ```
 
-
 ### Connect to VPN
+
 ```dart
 void connect() {
   openvpn.connect(
@@ -115,36 +137,37 @@ void connect() {
     username: username,
     password: password,
     bypassPackages: [],
-    // In iOS connection can stuck in "connecting" if this flag is "false". 
+    // In iOS connection can get stuck in "connecting" if this flag is "false". 
     // Solution is to switch it to "true".
     certIsRequired: false,
   );
 }
 ```
 
-### Disconnect 
+### Disconnect
+
 ```dart
-    void disconnect(){
-        openvpn.disconnect();
-    }
+void disconnect(){
+    openvpn.disconnect();
+}
 ```
 
-
 # Publishing to Play Store and App Store
+
 ### Android
-1. You can use appbundle to publish the app
-2. Add this to your files in `android` folder (special thanks to https://github.com/nizwar/openvpn_flutter/issues/10). Otherwise connection will not be
-established in some cases and will siliently report "disconnected" when trying to connect. Most likely it's related to some symbols stripping by
-Google Play.
+
+1. You can use app bundles to publish the app.
+2. Add the following to your files in the `android` folder (special thanks to https://github.com/nizwar/openvpn_flutter/issues/10). Otherwise, the connection may not be established in some cases and will silently report "disconnected" when trying to connect. This is likely related to some symbols being stripped by Google Play.
+
 ```
 gradle.properties > android.bundle.enableUncompressedNativeLibs=false
-AndroidManifest > android:extractNativeLibs="true" in application tag
+AndroidManifest > android:extractNativeLibs="true" in the application tag
 ```
 
-app/build.gradle add these inside android tag
-```gradle
+Add the following inside the `android` tag in `app/build.gradle`:
 
-android{
+```gradle
+android {
     ...
     //from here ======
     lintOptions {
@@ -175,26 +198,31 @@ android{
 ```
 
 #### Notifications
-As the plugin shows notification for connection status and connection detail, you have to request permission by using 3rd-party packages.
 
-Example by using [permission_handler](https://pub.dev/packages/permission_handler)
+As the plugin shows notifications for connection status and connection details, you must request permission using third-party packages.
+
+Example using [permission_handler](https://pub.dev/packages/permission_handler):
+
 ```dart
-    ///Put it anywhere you wish like once you initialize the vpn or pre-connect the server
-    Permission.notification.isGranted.then((_) {
-      if (!_) Permission.notification.request();
-    });
+///Put it anywhere you wish, like once you initialize the VPN or pre-connect to the server
+Permission.notification.isGranted.then((_) {
+  if (!_) Permission.notification.request();
+});
 ```
 
-
 ### iOS
-1. View [Apple Guidelines](https://developer.apple.com/app-store/review/guidelines/#vpn-apps) Relating to VPN
-2. This plugin DOES use Encryption BUT, It uses Exempt Encryptions
+
+1. View [Apple Guidelines](https://developer.apple.com/app-store/review/guidelines/#vpn-apps) relating to VPN.
+2. This plugin DOES use encryption, but it uses exempt encryptions.
 
 ## Licenses
+
 * [openvpn_flutter](https://github.com/nizwar/openvpn_flutter/blob/master/LICENSE) for this plugin
-* [ics-openvpn](https://github.com/schwabe/ics-openvpn) for Android Engine 
-* [OpenVPNAdapter](https://github.com/ss-abramchuk/OpenVPNAdapter) for iOS Engine
-# Love my work?
-Don't forget to give me a 👍 &nbsp;or support me with a cup of ☕️  
+* [ics-openvpn](https://github.com/schwabe/ics-openvpn) for the Android engine
+* [OpenVPNAdapter](https://github.com/ss-abramchuk/OpenVPNAdapter) for the iOS engine
+
+# Support
+
+If you appreciate my work, don't forget to give a thumbs up or support me with a cup of coffee.
 
-<a href="https://paypal.me/nizwar/"><img src="https://raw.githubusercontent.com/andreostrovsky/donate-with-paypal/master/blue.svg" height="40"></a> 
+<a href="https://paypal.me/nizwar/"><img src="https://raw.githubusercontent.com/andreostrovsky/donate-with-paypal/master/blue.svg" height="40"></a>
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -37,10 +37,10 @@ packages:
     dependency: transitive
     description:
       name: collection
-      sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
+      sha256: a1ace0a119f20aabc852d165077c036cd864315bd99b7eaa10a60100341941bf
       url: "https://pub.dev"
     source: hosted
-    version: "1.18.0"
+    version: "1.19.0"
   cupertino_icons:
     dependency: "direct main"
     description:
@@ -79,18 +79,18 @@ packages:
     dependency: transitive
     description:
       name: leak_tracker
-      sha256: "3f87a60e8c63aecc975dda1ceedbc8f24de75f09e4856ea27daf8958f2f0ce05"
+      sha256: "7bb2830ebd849694d1ec25bf1f44582d6ac531a57a365a803a6034ff751d2d06"
       url: "https://pub.dev"
     source: hosted
-    version: "10.0.5"
+    version: "10.0.7"
   leak_tracker_flutter_testing:
     dependency: transitive
     description:
       name: leak_tracker_flutter_testing
-      sha256: "932549fb305594d82d7183ecd9fa93463e9914e1b67cacc34bc40906594a1806"
+      sha256: "9491a714cca3667b60b5c420da8217e6de0d1ba7a5ec322fab01758f6998f379"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.5"
+    version: "3.0.8"
   leak_tracker_testing:
     dependency: transitive
     description:
@@ -150,7 +150,7 @@ packages:
     dependency: transitive
     description: flutter
     source: sdk
-    version: "0.0.99"
+    version: "0.0.0"
   source_span:
     dependency: transitive
     description:
@@ -163,10 +163,10 @@ packages:
     dependency: transitive
     description:
       name: stack_trace
-      sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
+      sha256: "9f47fd3630d76be3ab26f0ee06d213679aa425996925ff3feffdec504931c377"
       url: "https://pub.dev"
     source: hosted
-    version: "1.11.1"
+    version: "1.12.0"
   stream_channel:
     dependency: transitive
     description:
@@ -179,10 +179,10 @@ packages:
     dependency: transitive
     description:
       name: string_scanner
-      sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
+      sha256: "688af5ed3402a4bde5b3a6c15fd768dbf2621a614950b17f04626c431ab3c4c3"
       url: "https://pub.dev"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.0"
   term_glyph:
     dependency: transitive
     description:
@@ -195,10 +195,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "5b8a98dafc4d5c4c9c72d8b31ab2b23fc13422348d2997120294d3bac86b4ddb"
+      sha256: "664d3a9a64782fcdeb83ce9c6b39e78fd2971d4e37827b9b06c3aa1edc5e760c"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.2"
+    version: "0.7.3"
   vector_math:
     dependency: transitive
     description:
@@ -211,10 +211,10 @@ packages:
     dependency: transitive
     description:
       name: vm_service
-      sha256: "5c5f338a667b4c644744b661f309fb8080bb94b18a7e91ef1dbd343bed00ed6d"
+      sha256: f6be3ed8bd01289b34d679c2b62226f63c0e69f9fd2e50a6b3c1c729a961041b
       url: "https://pub.dev"
     source: hosted
-    version: "14.2.5"
+    version: "14.3.0"
 sdks:
-  dart: ">=3.3.0 <4.0.0"
+  dart: ">=3.4.0 <4.0.0"
   flutter: ">=3.18.0-18.0.pre.54"
