sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-09 07:09:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Adds doc for NB_SOCKS5_LISTENER_ADDRESS (#860)

Browse Source
This commit is contained in:
Riccardo Manfrin
2026-07-20 09:41:47 +02:00
committed by GitHub
parent 31f2b6c7ad
commit 313c6e0645
2 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/client/environment-variables.mdx
+1
View File
@@ -46,6 +46,7 @@ To clear all saved service parameters (including env vars), run `sudo netbird se
| `NB_USE_NETSTACK_MODE` | All | Run WireGuard on top of a userspace TCP/IP stack (gVisor netstack) instead of a TUN device. Required for environments without TUN support (e.g. unprivileged containers). | | `NB_USE_NETSTACK_MODE` | All | Run WireGuard on top of a userspace TCP/IP stack (gVisor netstack) instead of a TUN device. Required for environments without TUN support (e.g. unprivileged containers). |
| `NB_NETSTACK_SKIP_PROXY` | All | When using netstack mode, do not start the built-in SOCKS5 proxy that exposes the WireGuard network to local applications. | | `NB_NETSTACK_SKIP_PROXY` | All | When using netstack mode, do not start the built-in SOCKS5 proxy that exposes the WireGuard network to local applications. |
| `NB_SOCKS5_LISTENER_PORT` | All | Override the port the netstack SOCKS5 proxy listens on (default: `1080`). Only relevant when netstack mode is active. | | `NB_SOCKS5_LISTENER_PORT` | All | Override the port the netstack SOCKS5 proxy listens on (default: `1080`). Only relevant when netstack mode is active. |
| `NB_SOCKS5_LISTENER_ADDRESS` | All | Override the host/IP the netstack SOCKS5 proxy binds to (default: `127.0.0.1`). The proxy is unauthenticated and meant for local applications only, so it listens on loopback. Set this (e.g. to `0.0.0.0`) only when the proxy must be reachable from other hosts, such as a container gateway — this exposes an unauthenticated proxy on that address. Only relevant when netstack mode is active. |
## Firewall ## Firewall
src/pages/use-cases/cloud/netbird-on-faas.mdx
+8
View File
@@ -36,6 +36,14 @@ docker run --rm --name PEER_NAME --hostname PEER_NAME -d \
``` ```
This is useful when you want to configure a simple routing peer without adding privileged permissions or linux capabilities. This is useful when you want to configure a simple routing peer without adding privileged permissions or linux capabilities.
<Note>
The SOCKS5 proxy binds to `127.0.0.1` by default, so it is reachable only from
within the same container. If your application runs in a **separate** container
and connects to the agent's proxy over the Docker network, set
`NB_SOCKS5_LISTENER_ADDRESS=0.0.0.0` on the agent so the proxy accepts those
connections. The proxy is unauthenticated, so only do this on trusted networks.
</Note>
## How to use the SOCKS5 proxy? ## How to use the SOCKS5 proxy?
Once you have the agent running in netstack mode, you need to configure your application to use the SOCKS5 proxy. The following is an example of a python 3 application: Once you have the agent running in netstack mode, you need to configure your application to use the SOCKS5 proxy. The following is an example of a python 3 application:
```python ```python