Add documentation about privileges

Signed-off-by: Lehner Florian <[email protected]>
florianl · Jan 26, 2019 · f8b98e8 · f8b98e8
1 parent 96d5c09
commit f8b98e8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,4 +3,12 @@ go-nfqueue [![GoDoc](https://godoc.org/github.com/florianl/go-nfqueue?status.svg
 
 This is `go-nfqueue` and it is written in [golang](https://golang.org/). It provides a [C](https://en.wikipedia.org/wiki/C_(programming_language))-binding free API to the netfilter based queue subsystem of the [Linux kernel](https://www.kernel.org).
 
+Privileges
+----------
+
+This package processes information directly from the kernel and therefore it requires special privileges. You can provide this privileges by adjusting the `CAP_NET_ADMIN` capabilities.
+```
+	setcap 'cap_net_admin=+ep' /your/executable
+```
+
 For documentation and more examples please take a look at [![GoDoc](https://godoc.org/github.com/florianl/go-nfqueue?status.svg)](https://godoc.org/github.com/florianl/go-nfqueue)
diff --git a/doc.go b/doc.go
@@ -1,5 +1,10 @@
 /*
 Package nfqueue provides an API to interact with the nfqueue subsystem of the netfilter family from the linux kernel.
 
+This package processes information directly from the kernel and therefore it requires special privileges. You
+can provide this privileges by adjusting the CAP_NET_ADMIN capabilities.
+
+	setcap 'cap_net_admin=+ep' /your/executable
+
 */
 package nfqueue