diff --git a/src/pages/how-to/examples.mdx b/src/pages/how-to/examples.mdx index b2216f78..8f5eb95d 100644 --- a/src/pages/how-to/examples.mdx +++ b/src/pages/how-to/examples.mdx @@ -107,7 +107,7 @@ The setup key could be found in the NetBird Management dashboard under the Setup Set the ```NB_SETUP_KEY``` environment variable and run the command. ```bash -docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest +docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest ``` That is it! Enjoy using NetBird. diff --git a/src/pages/how-to/getting-started.mdx b/src/pages/how-to/getting-started.mdx index daf3818a..4c4d8ac9 100644 --- a/src/pages/how-to/getting-started.mdx +++ b/src/pages/how-to/getting-started.mdx @@ -337,11 +337,16 @@ On **Windows**: ### Running NetBird in Docker Set the ```NB_SETUP_KEY``` environment variable and run the command. + You can pass other settings as environment variables. See [environment variables](/how-to/cli#environment-variables) for details. + +NetBird makes use of eBPF and raw sockets, therefore to guarantee the client software functionality, we recommend adding the flags `--cap-add=SYS_ADMIN` and `--cap-add=SYS_RESOURCE` for docker clients. +The experience may vary depending on the docker daemon, operating system, or kernel version. + ```bash -docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest +docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest ``` See [Docker example](/how-to/examples#net-bird-client-in-docker) for details. diff --git a/src/pages/how-to/installation.mdx b/src/pages/how-to/installation.mdx index 2dfa8c97..87933362 100644 --- a/src/pages/how-to/installation.mdx +++ b/src/pages/how-to/installation.mdx @@ -273,11 +273,16 @@ On **Windows**: ### Running NetBird in Docker Set the ```NB_SETUP_KEY``` environment variable and run the command. + You can pass other settings as environment variables. See [Environment variables](/how-to/cli#environment-variables) for details. + +NetBird makes use of eBPF and raw sockets, therefore to guarantee the client software functionality, we recommend adding the flags `--cap-add=SYS_ADMIN` and `--cap-add=SYS_RESOURCE` for docker clients. +The experience may vary depending on the docker daemon, operating system, or kernel version. + ```bash -docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest +docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest ``` See [Docker example](/how-to/examples#net-bird-client-in-docker) for details.