Document daemon IPC privilege requirements and the Windows named pipe (#894)

This commit is contained in:
Viktor Liu
2026-07-30 13:51:23 +02:00
committed by GitHub
parent 0977b7e7b4
commit cb6aa7b244
7 changed files with 160 additions and 22 deletions
+7 -5
View File
@@ -42,7 +42,7 @@ Below is the list of global flags:
--admin-url string Admin Panel URL [http|https]://[host]:[port] (default "https://app.netbird.io:443")
-A, --anonymize anonymize IP addresses and non-netbird.io domains in logs and status output
-c, --config string Overrides the default profile file location. Deprecated on `up` and `login`; use `--service-env NB_CONFIG=<path>` instead.
--daemon-addr string Daemon service address to serve CLI requests [unix|tcp]://[path|host:port] (default "unix:///var/run/netbird.sock")
--daemon-addr string Daemon service address to serve CLI requests [unix|tcp|npipe]://[path|host:port|name] (default "unix:///var/run/netbird.sock", "npipe://netbird" on Windows)
-n, --hostname string Sets a custom hostname for the device
--log-file console Sets NetBird log paths written to simultaneously. If "console" is specified the log will be output to stdout. If "syslog" is specified the log will be sent to the syslog daemon. You can pass the flag multiple times or separate entries by comma (default [/var/log/netbird/client.log])
-l, --log-level string Sets NetBird log level (default "info")
@@ -509,9 +509,9 @@ For SFTP and SCP, use native clients (`sftp` and `scp` commands) which work with
**Connection fails:**
- Ensure SSH is enabled on the target peer:
- Ensure SSH is enabled on the target peer, which requires root or an administrator:
```shell
netbird up --allow-server-ssh
sudo netbird down; sudo netbird up --allow-server-ssh
```
- Verify SSH Access is enabled in the dashboard (Peers > your_peer > SSH Access)
- Check that an ACL policy allows TCP port 22022
@@ -520,13 +520,13 @@ For SFTP and SCP, use native clients (`sftp` and `scp` commands) which work with
- Complete the OIDC flow when prompted (browser window will open)
- Verify your IdP is properly configured
- To disable JWT authentication: `netbird up --allow-server-ssh --disable-ssh-auth`
- To disable JWT authentication, as root or an administrator: `sudo netbird down; sudo netbird up --allow-server-ssh --disable-ssh-auth`
**Port forwarding not working:**
- Ensure the server has the appropriate flags:
```shell
netbird up --allow-server-ssh \
sudo netbird up --allow-server-ssh \
--enable-ssh-local-port-forwarding \
--enable-ssh-remote-port-forwarding
```
@@ -833,6 +833,7 @@ This will output:
-S, --system-info Adds system information to the debug bundle (default true)
-U, --upload-bundle Uploads the debug bundle to a server
--upload-bundle-url string Service URL to get an upload URL for the debug bundle (default "https://upload.debug.netbird.io/upload-url")
--upload-bundle-insecure Allow uploading to an http or untrusted-TLS upload server (self-hosted); requires root
```
### debug for
@@ -872,6 +873,7 @@ Log level restored to INFO
-S, --system-info Adds system information to the debug bundle (default true)
-U, --upload-bundle Uploads the debug bundle to a server
--upload-bundle-url string Service URL to get an upload URL for the debug bundle (default "https://upload.debug.netbird.io/upload-url")
--upload-bundle-insecure Allow uploading to an http or untrusted-TLS upload server (self-hosted); requires root
```
### debug log