From 4cff1dc139fc9f15771950cb82cc1fc4ff3d3ee5 Mon Sep 17 00:00:00 2001
From: ValentinBELYN <35041719+ValentinBELYN@users.noreply.github.com>
Date: Sat, 12 Dec 2020 21:39:52 +0100
Subject: [PATCH] Update README.md
---
README.md | 35 ++++++++++++++++++++++++-----------
1 file changed, 24 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index cd8e6a3..c7c6b4d 100644
--- a/README.md
+++ b/README.md
@@ -17,18 +17,13 @@
-
icmplib 2.0 is here! 🎉
-
-To celebrate its first year and its integration into popular projects,
-icmplib has been completely revised! Thanks to its advanced features,
-including the ability to use the library without root privileges, QoS and
-increased compatibility with all modern operating systems, it becomes the
-most advanced library in its category. Many things are yet to come!
-
-Star this project if you like it 😍
-
icmplib is a brand new and modern implementation of the ICMP protocol in Python.
-Use the built-in functions or build your own, you have the choice!
+Use the built-in functions or build your own, you have the choice!
+
+-=-=- You can now use this library without root privileges -=-=-
+
+
+
@@ -905,6 +900,22 @@ The use of the built-in `resolve` function is recommended:
- If you pass an IP address, no lookup is done. The same address is returned.
- Raises a `NameLookupError` exception if the requested name does not exist or cannot be resolved.
+### How to use the library without root privileges?
+Since its version 2.0, icmplib can be used without root privileges.
+
+For this, you can set the `privileged` parameter to `False` on the `ping` and `multiping` functions, as well as the low level classes. By disabling this parameter, the kernel handles some parts of the ICMP headers.
+
+On some Linux systems, you must allow this feature:
+
+```shell
+$ sudo sysctl -w net.ipv4.ping_group_range='0 2147483647'
+net.ipv4.ping_group_range = 0 2147483647
+```
+
+*Since Ubuntu 20.04 LTS, this manipulation is no longer necessary.*
+
+[Read more on www.kernel.org](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt)
+
### Why I have no response from a remote host?
In the event of no response from a remote host, several causes are possible:
- Your computer's firewall may not be properly configured. This impacts in particular the `traceroute` function which can no longer receive ICMP Time Exceeded messages.
@@ -912,6 +923,8 @@ In the event of no response from a remote host, several causes are possible:
- The remote host or an upstream gateway drops ICMP messages for security reasons.
- In the case of the `traceroute` function, if the last host in the list is not the one expected, more than 30 hops (default) may be needed to reach it. You can try increasing the value of the `max_hops` parameter.
+
+
## Contributing
Comments and enhancements are welcome.