11notes/netbird-client repository overview

⁠NETBIRD-CLIENT

run netbird client

⁠INTRODUCTION 📢

NetBird⁠ (created by netbird⁠) combines a WireGuard-based overlay network with Zero Trust Network Access, providing a unified open source platform for reliable and secure connectivity. Create your own selfhosted ZTNA mesh network.

⁠SYNOPSIS 📖

What can I do with this? This image will run the Netbird client as a container. Generating a setup key⁠ is all you need to do.

⁠UNIQUE VALUE PROPOSITION 💶

Why should I run this image and not the other image(s) that already exist? Good question! Because ...

• ... this image is auto updated to the latest version via CI/CD
• ... this image has a health check
• ... this image is automatically scanned for CVEs before and after publishing
• ... this image is created via a secure and pinned CI/CD process
• ... this image is very small

If you value security, simplicity and optimizations to the extreme, then this image might be for you.

⁠COMPARISON 🏁

Below you find a comparison between this image and the most used or original one.

⁠VOLUMES 📁

• /netbird/etc - Directory of your client configs

⁠COMPOSE ✂️

name: "netbird"

x-lockdown: &lockdown
  # prevents any process within the container to gain more privileges
  security_opt:
    - "no-new-privileges=true"
  # needed for full netbird client to manipulate routing and DNS
  cap_add:
    - NET_ADMIN
    - SYS_ADMIN
    - SYS_RESOURCE

services:
  client:
    image: "11notes/netbird-client:0.79.0"
    <<: *lockdown
    environment:
      TZ: "Europe/Zurich"
      NETBIRD_PEER_NAME: "${NETBIRD_PEER_NAME}"
      NETBIRD_URL: "${NETBIRD_URL}"
      NETBIRD_SETUP_KEY: "${NETBIRD_SETUP_KEY}"
    devices:
      - "/dev/net/tun"
    volumes:
      - "netbird-client.etc:/netbird/etc"
    tmpfs:
      - "/run:uid=1000,gid=1000"
    network_mode: "host"
    sysctls:
      net.ipv4.ip_forward: "1"
      net.ipv6.conf.all.forwarding: "1"
    restart: "always"

volumes:
  netbird-client.etc:

To find out how you can change the default UID/GID of this container image, consult the RTFM⁠.

⁠DEFAULT SETTINGS 🗃️

⁠ENVIRONMENT 📝

⁠MAIN TAGS 🏷️

These are the main tags for the image. There is also a tag for each commit and its shorthand sha256 value.

• 0.79.0⁠

⁠There is no latest tag, what am I supposed to do about updates?

It is my opinion that the :latest tag is a bad habbit and should not be used at all. Many developers introduce breaking changes in new releases. This would messed up everything for people who use :latest. If you don’t want to change the tag to the latest semver⁠, simply use the short versions of semver⁠. Instead of using :0.79.0 you can use :0 or :0.79. Since on each new version these tags are updated to the latest version of the software, using them is identical to using :latest but at least fixed to a major or minor version. Which in theory should not introduce breaking changes.

If you still insist on having the bleeding edge release of this app, simply use the :rolling tag, but be warned! You will get the latest version of the app instantly, regardless of breaking changes or security issues or what so ever. You do this at your own risk!

⁠REGISTRIES ☁️

docker pull 11notes/netbird-client:0.79.0
docker pull ghcr.io/11notes/netbird-client:0.79.0
docker pull quay.io/11notes/netbird-client:0.79.0

⁠SOURCE 💾

• 11notes/netbird-client⁠

⁠PARENT IMAGE 🏛️

• [${{ json_readme_parent_image }}](${{ json_readme_parent_url }})

⁠BUILT WITH 🧰

• netbirdio/netbird⁠
• 11notes/util⁠

⁠GENERAL TIPS 📌

• Use a reverse proxy like Traefik, Nginx, HAproxy to terminate TLS and to protect your endpoints
• Use Let’s Encrypt DNS-01 challenge to obtain valid SSL certificates for your services

⁠CAUTION ⚠️

• This image must run as root and will require the wireguard module being loaded in the host’s kernel. If you don’t need a full client but only an exit node or a side car container, use 11notes/ netbird-exit-node⁠ which is rootless⁠

⁠ElevenNotes™️

This image is provided to you at your own risk. Always make backups before updating an image to a different version. Check the releases⁠ for breaking changes. If you have any problems with using this image simply raise an issue⁠, thanks. If you have a question or inputs please create a new discussion⁠ instead of an issue. You can find all my other repositories on github⁠.

created 19.09.2026, 06:10:42 (CET)