mirror/NetGuard
1
0
Fork 0
mirror of https://github.com/M66B/NetGuard.git synced 2024-12-24 00:38:56 +00:00
Code Issues Releases Wiki Activity

Updated FAQ and README for new stable version

Browse source
This commit is contained in:
M66B 2016-02-25 13:41:45 +01:00
parent 49d7d45c12
commit af7ea3f3c6
2 changed files with 15 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
FAQ.md
View file

@ -53,20 +53,6 @@ However, the network speed graph notification will use extra battery power.
This is why the notification is shown only when the screen is on.
You can decrease the update frequency using the settings to reduce the battery usage.
<a name="FAQ5"></a>
**(5) Can you add usage statistics?**<br />
**(5) Can you add popups to allow/block applications?**<br />
**(5) Can you add selective allowing/blocking applications/IP addresses?**
Unfortunately, this is not possible without using significant battery power
and adding complex code to do network translation from OSI layer 3 to layer 4
(and thus implementing a TCP/IP stack), which will inevitably introduce bugs as well.
This is how most (perhaps all) other no-root firewalls work.
NetGuard is unique, because it doesn't implement a TCP/IP stack, and is therefore both highly efficient and simple.
For more advanced use cases, rooting your device and using an iptables based firewall,
like [AFWall+](https://github.com/ukanth/afwall), might be a better option and will not sacrifice any battery power.
<a name="FAQ6"></a>
**(6) Will NetGuard send my internet traffic to an external (VPN) server?**
@ -107,13 +93,6 @@ to apply the rules with the conditions '*Allow when screen is on*' and '*Block w
If disabling NetGuard is allowed to Tasker, any application can disabled NetGuard too.
Allowing to disable a security application from other applications is not a good idea.
<a name="FAQ12"></a>
**(12) Can you add on demand asking to block/allow access?**
Besides that this requires questionable Android permissions,
it is not possible to implement this, given the way NetGuard works.
For more details, see [question 5](#FAQ5).
<a name="FAQ13"></a>
**(13) How can I remove the ongoing NetGuard entry in the notification screen?**
@ -157,10 +136,7 @@ is incorrectly attributed to NetGuard instead to the Google Play™ store app.
<a name="FAQ18"></a>
**(18) Why can't I find NetGuard in the Google Play™ store app?**
NetGuard requires at least Android 5.0, so it is not available in the Google Play™ store app for devices running older Android versions.
Some devices have an Android version with a bug in the services NetGuard depends upon.
These devices are blacklisted in the Google Play™ store app. Read about them in the [compatibility section](https://github.com/M66B/NetGuard#compatibility).
NetGuard requires at least Android 4.0, so it is not available in the Google Play™ store app for devices running older Android versions.
<a name="FAQ19"></a>
**(19) Why does aplication XYZ still have internet access?**
@ -200,8 +176,7 @@ This cannot be done from the application, because NetGuard is not an application
<a name="FAQ22"></a>
**(22) Can I tether / use Wi-Fi calling while using NetGuard?**
Due to a bug in Android this is not possible.
See [here](https://github.com/M66B/NetGuard/issues/42) for more information.
Yes, but this needs to be enabled in the settings.
<a name="FAQ24"></a>
**(24) Can you remove the notification from the status bar?**
@ -226,32 +201,21 @@ See also [question 0](#FAQ0).
The columns have the following meaning:
1. Time (tap on a log entry to see the date)
1. Wi-Fi / mobile connection
1. Interactive state (screen on)
1. Protocol (see below)
1. Port (tap on a log entry to lookup a port)
1. Packet flags (see below)
1. Application icon (tap on a log entry to see the application name)
1. Application uid
1. IPv4 or IPv6 address (tap on a log entry to lookup an IP address)
From version 0.77:
1. Time (tap on a log entry to see the date)
1. Application icon (tap on a log entry to see the application name)
1. Application uid
1. Wi-Fi / mobile connection, green=allowed, red=blocked
1. Interactive state (screen on)
1. Interactive state (screen on or off)
1. Protocol (see below) and packet flags (see below)
1. Source and destination port (tap on a log entry to lookup a destination port)
1. Source and destination IPv4 or IPv6 address (tap on a log entry to lookup a destination IP address)
1. Organization name owning the IP address (need to be enabled through the menu)
Protocols:
* I = ICMP
* T = TCP
* U = UDP
* ICMP
* TCP
* UDP
* Number = one of the protocols in [this list](https://en.wikipedia.org/wiki/List_of_IP_protocol_numbers)
* 4 = IPv4
* 6 = IPv6
@ -301,13 +265,6 @@ Some pointers on how to set up AFWall+:
* if using filtering, when you un/reinstall NetGuard, remember to RE-allow NetGuard in AFWall+
* if using filtering, applications _need_ VPN internet access (check the box to show that option in AFWall+ settings)
<a name="FAQ31"></a>
**(31) Which hosts file should I use?**
There is no conclusive answer to this question, but my advice is to use a hosts file which is at least maintained.
You can find some suggestions [here](https://github.com/M66B/NetGuard/issues/277),
where you also can find which hosts file *netguard.me/hosts* serves.
<br />
**If you didn't find the answer to your question, you can ask your questions [here](http://forum.xda-developers.com/showthread.php?t=3233012)**.

77
README.md
View file

@ -41,7 +41,7 @@ Since NetGuard has no internet permission, you know your internet traffic is not
Requirements:
* Android 5.0 or later
* Android 4.0 or later
* A [compatible device](#compatibility)
Downloads:
@ -49,7 +49,6 @@ Downloads:
* [GitHub](https://github.com/M66B/NetGuard/releases)
* [On Google Play](https://play.google.com/store/apps/details?id=eu.faircode.netguard) (stable)
* [On Google Play](https://play.google.com/apps/testing/eu.faircode.netguard) (beta)
* [F-Droid](https://f-droid.org/repository/browse/?fdfilter=netguard&fdid=eu.faircode.netguard) (unsupported)
* [XDA Labs App](http://forum.xda-developers.com/android/apps-games/labs-t3241866) ([web page](https://labs.xda-developers.com/store/app/eu.faircode.netguard))
Usage:
@ -62,41 +61,18 @@ You can use the settings menu to change from black list to white list mode.
* Orange = denied internet access
* Green = allowed internet access
<img src="screenshot1.png" width="320" height="569" />
<img src="https://raw.githubusercontent.com/M66B/NetGuard/master/screenshots/01-main.png" width="320" height="569" />
<img src="https://raw.githubusercontent.com/M66B/NetGuard/master/screenshots/02-main-details.png" width="320" height="569" />
<img src="https://raw.githubusercontent.com/M66B/NetGuard/master/screenshots/03-main-access.png" width="320" height="569" />
<img src="https://raw.githubusercontent.com/M66B/NetGuard/master/screenshots/08-notifications.png" width="320" height="569" />
<img src="screenshot2.png" width="320" height="569" />
For more screenshots, see [here](https://github.com/M66B/NetGuard/tree/master/screenshots).
Compatibility
-------------
Devices / ROMs with a broken VPN implementation:
* Allwinner™ bt1077 / Android ? (reported in the Google Play™ store app) (all traffic blocked)
* Asus™ ZenFone 2 / Android 5.0.2, [reported on XDA](http://forum.xda-developers.com/showpost.php?p=63619542&postcount=121) (all traffic blocked)
* Asus™ ZenFone 4 / Android 5.0 (reported in the Google Play™ store app) (all traffic blocked)
* Asus™ ZenFone 5 / Android 5.0 (reported through Google Play™ store app feedback) (VPN prepare fails)
* Asus™ ZenPad S 8.0 / Android 5.0, [reported on Github](https://github.com/M66B/NetGuard/issues/168) (all traffic blocked)
* BQ™ Aquaris E5/M5 / Android 5.0.2/5.0 (reported in the Google Play™ store app) (all traffic blocked)
* Lenovo™ Yoga Tablet Pro-1380L / 2 Pro / Android 5.0.1, [reported on XDA](http://forum.xda-developers.com/showpost.php?p=63784102&postcount=278) (all traffic blocked)
* LGE G Vista / Android 5.0 (reported through Google Play™ store app feedback) (VPN establish fails)
* Marshall London / Android 5.02, [reported on XDA](http://forum.xda-developers.com/showpost.php?p=64778998&postcount=885) (all traffic blocked)
* Samsung™ Galaxy A3 / Android 5.0.2, [reported on XDA](http://forum.xda-developers.com/showpost.php?p=64142621&postcount=509) (all traffic blocked)
* Samsung™ Galaxy A5 / Android 5.0.2, [reported on Github](https://github.com/M66B/NetGuard/issues/20) (all traffic blocked)
* Samsung™ Galaxy Note3 / Android 5.0 (reported through Google Play™ store app feedback) (VPN prepare fails)
* Samsung™ Galaxy Note4 / Android 5.1.1 (reported through Google Play™ store app feedback and on XDA) (telephone unresponsive)
* Samsung™ Galaxy Note5 / Android ? (reported through Google Play™ store app feedback and on XDA) (?)
* Samsung™ Galaxy S5 / Android ? [reported on Github](https://github.com/M66B/NetGuard/issues/223) (VPN start fails on boot)
* Samsung™ Galaxy Tab S4 / Android ? (reported in the Google Play™ store app) (VPN start fails on boot)
* Sony™ Xperia™ M4 Aqua Dual / Android 5.0 (reported in the Google Play™ store app) (all traffic blocked)
* Symphony Teleca™ / Micromax™ Canvas Knight 2 E471 / Android 5.0.2 (reported by e-mail) (VPN establish fails)
* TCT Mobile Limited™ (Alcatel) 6039Y / Android / Android 5.0 (reported in the Google Play™ store app) (all traffic blocked)
* TCT Mobile Limited™ (Alcatel) OneTouch Idol 3 / Android 5.0.2 (reported in the Google Play™ store app) (all traffic blocked)
NetGuard will crash when the package *com.android.vpndialogs* has been removed or otherwise is unavailable.
Wi-Fi/USB tethering and Wi-Fi will not work when NetGuard is enabled due to a bug in Android ([issue](https://github.com/M66B/NetGuard/issues/42)).
Unfortunately it is not possible to workaround any of these Android problems.
<a name="FAQ"></a>
Frequently Asked Questions (FAQ)
@ -117,11 +93,6 @@ Frequently Asked Questions (FAQ)
<a name="FAQ4"></a>
[**(4) Will NetGuard use extra battery power?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ4)
<a name="FAQ5"></a>
[**(5) Can you add usage statistics?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ5)<br />
[**(5) Can you add popups to allow/block applications?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ5)<br />
[**(5) Can you add selective allowing/blocking applications/IP addresses?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ5)
<a name="FAQ6"></a>
[**(6) Will NetGuard send my internet traffic to an external (VPN) server?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ6)
@ -137,9 +108,6 @@ Frequently Asked Questions (FAQ)
<a name="FAQ10"></a>
[**(10) Will you provide a Tasker plug-in?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ10)
<a name="FAQ12"></a>
[**(12) Can you add on demand asking to block/allow access?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ12)
<a name="FAQ13"></a>
[**(13) How can I remove the ongoing NetGuard entry in the notification screen?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ13)
@ -188,10 +156,6 @@ Frequently Asked Questions (FAQ)
<a name="FAQ30"></a>
[**(30) Can I also run AFWall+ on the same device?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ30)
<a name="FAQ31"></a>
[**(31) Which hosts file should I use?**](https://github.com/M66B/NetGuard/blob/master/FAQ.md#FAQ31)
Permissions
-----------
@ -220,32 +184,7 @@ Translations:
* Translations to other languages are welcomed
* You can translate online [here](https://crowdin.com/project/netguard/)
* If your language is not listed, please send a message to marcel(plus)netguard(at)faircode(dot)eu
Current translations:
1. Arabic
1. Simplified Chinese
1. Czech
1. Danish
1. Dutch
1. English
1. French
1. German
1. Greek
1. Hungarian
1. Italian
1. Japanese
1. Korean
1. Polish
1. Portuguese/Brazilian
1. Romanian
1. Russian
1. Slovak
1. Spanish
1. Turkish
1. Ukrainian
You can see the actual status of all translations [here](https://crowdin.com/project/netguard).
* You can see the status of all translations [here](https://crowdin.com/project/netguard).
Please note that you agree to the license below by contributing, including the copyright.
@ -262,7 +201,7 @@ License
[GNU General Public License version 3](http://www.gnu.org/licenses/gpl.txt)
Copyright (c) 2015 Marcel Bokhorst ([M66B](http://forum.xda-developers.com/member.php?u=2799345))
Copyright (c) 2015-2016 Marcel Bokhorst ([M66B](http://forum.xda-developers.com/member.php?u=2799345))
All rights reserved