Browse Source

Add documentation about privileges

Signed-off-by: Lehner Florian <dev@der-flo.net>
tags/v1.1.0^0
Lehner Florian 3 years ago
parent
commit
f8b98e8c21
2 changed files with 13 additions and 0 deletions
  1. +8
    -0
      README.md
  2. +5
    -0
      doc.go

+ 8
- 0
README.md View File

@@ -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)

+ 5
- 0
doc.go View File

@@ -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

Loading…
Cancel
Save