SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-07-28 08:52:37 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Would it be possible to create a SNAP for Netbird? #264

New Issue
Open
opened 2025-11-20 05:08:46 -05:00 by saavagebueno · 9 comments
saavagebueno commented 2025-11-20 05:08:46 -05:00
Owner
Copy Link

Originally created by @bmullan on GitHub (Jan 8, 2023).

Is your feature request related to a problem? Please describe.
No

Describe the solution you'd like
I'd like to see a Netbird SNAP available. That could enable installation by end-users with a single command such as:

$ sudo snap install netbird-ui
or
$ sudo snap install netbird-cli*

SNAPs utilize a release Channel concept (ie stable, candidate, beta, edge)
They define which release of a snap is installed and tracked for updates.
SNAPs can be updated or rolled-back to a previous version if an update does happen to cause some problem for a user.

Describe alternatives you've considered
none. But I'd imagine there would be interest in a Flatpak installer.

Additional context
Add any other context or screenshots about the feature request here.

Originally created by @bmullan on GitHub (Jan 8, 2023). **Is your feature request related to a problem? Please describe.** No **Describe the solution you'd like** I'd like to see a Netbird SNAP available. That could enable installation by end-users with a single command such as: > **$ sudo snap install netbird-ui** > or > **$ sudo snap install netbird-cli*** SNAPs utilize a release Channel concept (ie stable, candidate, beta, edge) They define which release of a snap is installed and tracked for updates. SNAPs can be updated or rolled-back to a previous version if an update does happen to cause some problem for a user. **Describe alternatives you've considered** none. But I'd imagine there would be interest in a Flatpak installer. **Additional context** Add any other context or screenshots about the feature request here.
saavagebueno added the feature-requestreleasepackaging labels 2025-11-20 05:08:46 -05:00
saavagebueno commented 2025-11-20 05:08:46 -05:00
Author
Owner
Copy Link

@mlsmaycon commented on GitHub (Jan 8, 2023):

thanks for your suggestion @bmullan, as we are using Goreleaser, it is possible to build snap packages.

We have to check our repositories if there are any compatibility issues.

@mlsmaycon commented on GitHub (Jan 8, 2023): thanks for your suggestion @bmullan, as we are using [Goreleaser](https://goreleaser.com/customization/snapcraft/), it is possible to build snap packages. We have to check our repositories if there are any compatibility issues.
saavagebueno commented 2025-11-20 05:08:46 -05:00
Author
Owner
Copy Link

@bmullan commented on GitHub (Jan 8, 2023):

Great thanks the reply. I'll keep my eye out.

brian

On Sun, Jan 8, 2023 at 4:23 PM Maycon Santos @.***>
wrote:

thanks for your suggestion @bmullan https://github.com/bmullan, as we
are using Goreleaser https://goreleaser.com/customization/snapcraft/,
it is possible to build snap packages.

We have to check our repositories if there are any compatibility issues.

—
Reply to this email directly, view it on GitHub
https://github.com/netbirdio/netbird/issues/646#issuecomment-1374930533,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAM23J26IRN5VYRV45R7Y4TWRMV5TANCNFSM6AAAAAATUUOVTY
.
You are receiving this because you were mentioned.Message ID:
@.***>

@bmullan commented on GitHub (Jan 8, 2023): Great thanks the reply. I'll keep my eye out. brian On Sun, Jan 8, 2023 at 4:23 PM Maycon Santos ***@***.***> wrote: > thanks for your suggestion @bmullan <https://github.com/bmullan>, as we > are using Goreleaser <https://goreleaser.com/customization/snapcraft/>, > it is possible to build snap packages. > > We have to check our repositories if there are any compatibility issues. > > — > Reply to this email directly, view it on GitHub > <https://github.com/netbirdio/netbird/issues/646#issuecomment-1374930533>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAM23J26IRN5VYRV45R7Y4TWRMV5TANCNFSM6AAAAAATUUOVTY> > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> >
saavagebueno commented 2025-11-20 05:08:47 -05:00
Author
Owner
Copy Link

@bmullan commented on GitHub (Mar 21, 2023):

thanks for your suggestion @bmullan, as we are using Goreleaser, it is possible to build snap packages.

Did any work happen on creating SNAP package for Netbird?

thanks for your suggestion @bmullan, as we are using Goreleaser, it is possible to build snap packages.

We have to check our repositories if there are any compatibility issues.

@bmullan commented on GitHub (Mar 21, 2023): > thanks for your suggestion @bmullan, as we are using [Goreleaser](https://goreleaser.com/customization/snapcraft/), it is possible to build snap packages. _Did any work happen on creating SNAP package for Netbird?_ > thanks for your suggestion @bmullan, as we are using [Goreleaser](https://goreleaser.com/customization/snapcraft/), it is possible to build snap packages. > > We have to check our repositories if there are any compatibility issues.
saavagebueno commented 2025-11-20 05:08:47 -05:00
Author
Owner
Copy Link

@Guillaumebeuzeboc commented on GitHub (Nov 23, 2023):

Hello, I recently publish a snap for NetBird in beta.
I didn't use goreleaser, but built it directly from sources.
The snap is still waiting for the auto-connections.

The snap is available on the Store (in beta).
The sources for the snap are available on GH.

So far, I did only basic tests with the snap (connect to the default NetBird server). Any feedback is welcome.

I can prepare a PR to have the snap built directly in this repository if you want to take ownership @mlsmaycon .

@Guillaumebeuzeboc commented on GitHub (Nov 23, 2023): Hello, I recently publish a snap for NetBird in beta. I didn't use goreleaser, but built it directly from sources. The snap is still waiting for the auto-connections. The snap is available on the [Store](https://snapcraft.io/netbird) (in beta). The sources for the snap are available on [GH](https://github.com/ubuntu-robotics/netbird_snap/tree/dev/add_snap). So far, I did only basic tests with the snap (connect to the default NetBird server). Any feedback is welcome. I can prepare a PR to have the snap built directly in this repository if you want to take ownership @mlsmaycon .
saavagebueno commented 2025-11-20 05:08:47 -05:00
Author
Owner
Copy Link

@bmullan commented on GitHub (Nov 23, 2023):

@Guillaumebeuzeboc
I just installed your Netbird Snap beta on my ubuntu 22.04.3 LTS system and it only took 30 seconds.

FYI .. your Link (GH) points to an empty Github page!

Also, what all does the Netbird Snap install/configure?
I realize you just published the Netbird Snap beta but a ReadMe on the "missing" Github link (see above) would help answer other basic questions.

Thanks so much for your effort !
I'll respond here if I find anything or have questions.

Brian

@bmullan commented on GitHub (Nov 23, 2023): @Guillaumebeuzeboc I just installed your Netbird Snap beta on my ubuntu 22.04.3 LTS system and _it only took 30 seconds._ FYI .. your Link **_[(GH)](https://github.com/ubuntu-robotics/netbird_snap/tree/dev/add_snap)_** points to an empty Github page! Also, what all does the Netbird Snap install/configure? I realize you just published the Netbird Snap beta but a ReadMe on the "missing" Github link (see above) would help answer other basic questions. Thanks so much for your effort ! I'll respond here if I find anything or have questions. Brian
saavagebueno commented 2025-11-20 05:08:47 -05:00
Author
Owner
Copy Link

@bmullan commented on GitHub (Nov 24, 2023):

@Guillaumebeuzeboc

Your Netbird SNAP works Great from what I've seen!

  1. I setup 2 Ubuntu 22.04.3 LTS Servers.
  2. One local and one on Digital Ocean Cloud.
  3. I installed LXD on both Servers and created 2 LXD (system) Containers on each Server (I used Ubuntu 22.04 as the LXD Container OS's as well)

Note: the "default" LXD config is to create all new LXD Containers behind a Bridge named "lxdbr0"
and using a Private 10.x.x.x/24 network

4.Then on Both Servers (the LXD Container Hosts) I installed the Netbird SNAP
5. Accessed the Netbird Admin UI and verified both Servers showed as Peers.
6. Created a Netbird Route on each Server which routed that Server's lxdbr0 bridge IP /24 Network to the Mesh VPN
7. Verified I could ping from LXD Containers on local Server LXD Host to LXD Containers on Digital Ocean LXD Host and vice-versa

Side Note:
On the Digital Ocean Server's LXD Containers I installed the "ubuntu-mate-deskop" and XRDP (_using cenergy's XRDP install script because it builds from latest NeutrinoLab's XRDP source and can enable Sound Redirection from the remote.
In one of my "local" Server's LXD Containers I installed freerdp2-x11.
I then from that "local" Container's command line I used "xfreerdp /v:x.x.x.x" to launch the Ubuntu Mate desktop on the Digital Ocean LXD Container so it appeared to me Locally.

Works great!

See attached PDF from a Mindmap I created to document the steps I took.

Since LXD "system" containers can run most Linux Distro's (fedora, centos, alpine, ubuntu, debian, suse etc etc) and
each Server (assuming _appropriate "resources" can run dozens or hundreds of LXD Containers).

LXD containers can also run Docker or Flatpak "nested" in an LXD Container.
Docker & Flatpaks run just like they do on a non-LXD Server.

With just 2 Netbird Peers and I can have access to apps on any of those LXD Distro containers.

ciab-netbird-setup.pdf

Let me know if you have any questions.

Brian

@bmullan commented on GitHub (Nov 24, 2023): @Guillaumebeuzeboc Your Netbird SNAP works Great from what I've seen! 1. I setup 2 Ubuntu 22.04.3 LTS Servers. 2. One local and one on Digital Ocean Cloud. 3. I installed LXD on both Servers and **_created 2 LXD (system) Containers on each Server_** (I used Ubuntu 22.04 as the LXD Container OS's as well) > Note: the "default" LXD config is to create all new LXD Containers behind a Bridge named **"lxdbr0"** > and using a Private 10.x.x.x/24 network 4.Then on Both Servers (the LXD Container Hosts) I installed the Netbird SNAP 5. Accessed the Netbird Admin UI and verified both Servers showed as Peers. 6. Created a Netbird Route on each Server which routed that Server's lxdbr0 bridge IP /24 Network to the Mesh VPN 7. Verified I could ping from LXD Containers on local Server LXD Host to LXD Containers on Digital Ocean LXD Host and vice-versa **_Side Note:_** On the Digital Ocean Server's LXD Containers I installed the "**_ubuntu-mate-deskop_**" and XRDP ***(_using [cenergy's XRDP install script](https://c-nergy.be/blog/?p=19228)*** because _it builds from latest NeutrinoLab's XRDP source and can enable Sound Redirection from the remote_. In one of my "**local**" Server's LXD Containers I installed **freerdp2-x11**. I then from that "**local**" Container's command line I used "**xfreerdp /v:x.x.x.x**" to launch the Ubuntu **Mate desktop** on the Digital Ocean LXD Container so it appeared to me Locally. **Works great!** _See attached PDF from a Mindmap I created to document the steps I took._ Since LXD "_**system**_" containers can run most Linux Distro's (fedora, centos, alpine, ubuntu, debian, suse etc etc) and each Server (assuming _appropriate "resources" can run dozens or hundreds of LXD Containers). LXD containers can also run Docker or Flatpak **_"nested"_** in an LXD Container. Docker & Flatpaks run just like they do on a non-LXD Server. With just 2 Netbird Peers and I can have access to apps on any of those LXD Distro containers. [ciab-netbird-setup.pdf](https://github.com/netbirdio/netbird/files/13460579/ciab-netbird-setup.pdf) Let me know if you have any questions. Brian
saavagebueno commented 2025-11-20 05:08:47 -05:00
Author
Owner
Copy Link

@Guillaumebeuzeboc commented on GitHub (Nov 27, 2023):

@bmullan

I think the GH link died since I merged in the meantime. Currently, the main branch contains a basic readme.

Regarding the snap configure/install, they are snap hooks which are essential executables to execute at certain time of the snap life. In the NetBird snap the configure hook is used to restart the NetBird daemon whenever someone changed the configuration (via snap set netbird service-run-arguments in this case). The install hook is simply unsetting the value for the configuration service-run-arguments on the snap installation.

Thank you for all the tests! I am glad it worked.
It appears that we have different use cases. I have been using NetBird to interconnect edge devices on different networks.

From your tests I just want to clarify some points:

  • Although the snap is "based" on core 22, it can run on other Ubuntu versions or even other Linux distros. I have been using it on 20.04 for example.
  • I saw that you installed the snap on the host for the LXD containers to access it. The snap can also be installed in one of the LXD containers to give access to only one container, for example.
  • I am not sure why you mention Flatpack. Did you mean snap? Or is it a use case to have snap + Flatpack + docker running side by side?
  • In your mind map, the birdup.sh is calling sudo netbird up, I think the sudo is not necessary since the NetBird socket has enough permission.

Also, to simplify the connection process for the snap, I have requested auto-connections. Once approved, this means that the user will simply have to type sudo snap netbird install --beta and then netbird up.

@Guillaumebeuzeboc commented on GitHub (Nov 27, 2023): @bmullan I think the GH link died since I merged in the meantime. Currently, the [main branch](https://github.com/ubuntu-robotics/netbird_snap) contains a basic readme. Regarding the snap configure/install, they are [snap hooks](https://snapcraft.io/docs/supported-snap-hooks) which are essential executables to execute at certain time of the snap life. In the NetBird snap the configure hook is used to restart the NetBird daemon whenever someone changed the configuration (via `snap set netbird service-run-arguments` in this case). The install hook is simply unsetting the value for the configuration `service-run-arguments` on the snap installation. Thank you for all the tests! I am glad it worked. It appears that we have different use cases. I have been using NetBird to interconnect edge devices on different networks. From your tests I just want to clarify some points: - Although the snap is "based" on core 22, it can run on other Ubuntu versions or even [other Linux distros](https://snapcraft.io/docs/installing-snapd). I have been using it on 20.04 for example. - I saw that you installed the snap on the host for the LXD containers to access it. The snap can also be installed in one of the LXD containers to give access to only one container, for example. - I am not sure why you mention Flatpack. Did you mean snap? Or is it a use case to have snap + Flatpack + docker running side by side? - In your mind map, the `birdup.sh` is calling `sudo netbird up`, I think the `sudo` is not necessary since the NetBird socket has enough permission. Also, to simplify the connection process for the snap, I have [requested auto-connections](https://forum.snapcraft.io/t/autoconnect-for-netbird/37849/2). Once approved, this means that the user will simply have to type `sudo snap netbird install --beta` and then `netbird up`.
saavagebueno commented 2025-11-20 05:08:47 -05:00
Author
Owner
Copy Link

@bmullan commented on GitHub (Nov 27, 2023):

@Guillaumebeuzeboc

regarding some of your questions:

I saw that you installed the snap on the host for the LXD containers to access it. The snap can also be installed in one of the LXD containers to give access to only one container, for example.

Yes, I know I could configure an individual LXD Container with Netbird. LXD "system" Containers have multiple approaches to doing that besides install Netbird inside an individual Container. An LXD Container's networking can be via MACVLAN, Bridge, Routed interfaces to the Host. They also support use of "cloud-init" to preinstal/configure things in a container.

I am not sure why you mention Flatpak. Did you mean snap? Or is it a use case to have snap + Flatpak + Docker running side by side?

LXD Containers default to running "unprivileged" (root in the container is not root in the Host) but can be run as Privileged Containers if desired.

By running Docker containers or Flatpak's "Nested" inside an "unprivileged" LXD "system" Container your Docker or Flatpak's have that extra security.

Unprivileged containers are safe by design. The container uid 0 is mapped to an unprivileged user outside of the container and only has extra rights on resources that it owns itself.

With such container, the use of SELinux, AppArmor, Seccomp and capabilities isn't necessary for security. LXD will still use those to add an extra layer of security which may be handy in the event of a kernel security issue

Docker containers typically run with root as the default user

So as an example, running a Docker Container "nested" in an LXD Container... if the Docker app were to escape to a shell it might gain "root" in the LXD Container but not in the Host Server.

Regarding Flatpaks, an example, to give a Flatpak app permission to access the Linux host file system:

$ sudo flatpak override [app id] --filesystem=host

But doing that to a Flatpak running "Nested" in an LXD "system" Container the Flatpak can run Privileged (re root)
in the LXD Container but it is not root in the Host Server!

So that is one reason I mentioned LXD capable of running Docker & Flatpak "nested".

Also, LXD supports export/import of local/remote Containers & "live migration of a Container from Server A to Server B"

It appears that we have different use cases. I have been using NetBird to interconnect edge devices on different networks.

I do that also but I always try a remote desktop connection from Edge device (lxd container on Server A to LXD Container on Server B somewhere else) just as one test of the mesh vpn performance. I also do that using iPerf.

Also thanks for letting me know:

In your mind map, the birdup.sh is calling sudo netbird up, I think the sudo is not necessary since the NetBird socket has enough permission.

@bmullan commented on GitHub (Nov 27, 2023): @Guillaumebeuzeboc regarding some of your questions: > I saw that you installed the snap on the host for the LXD containers to access it. The snap can also be installed in one of the LXD containers to give access to only one container, for example. Yes, I know I could configure an individual LXD Container with Netbird. LXD "system" Containers have multiple approaches to doing that besides install Netbird inside an individual Container. An LXD Container's networking can be via MACVLAN, Bridge, Routed interfaces to the Host. They also support use of "cloud-init" to preinstal/configure things in a container. > I am not sure why you mention Flatpak. Did you mean snap? Or is it a use case to have snap + Flatpak + Docker running side by side? LXD Containers default to running "**_unprivileged_**" (_root in the container is not root in the Host_) but can be run as Privileged Containers if desired. By running Docker containers or Flatpak's "Nested" inside an "unprivileged" LXD "system" Container your Docker or Flatpak's have that extra security. Unprivileged containers are safe by design. The container uid 0 is mapped to an unprivileged user outside of the container and only has extra rights on resources that it owns itself. With such container, the use of SELinux, AppArmor, Seccomp and capabilities isn't necessary for security. LXD will still use those to add an extra layer of security which may be handy in the event of a kernel security issue > *Docker containers typically run with root as the default user* So as an example, running a Docker Container "nested" in an LXD Container... _if the Docker app were to escape to a shell it might gain "root" in the LXD Container but not in the Host Server._ Regarding Flatpaks, an example, to give a Flatpak app permission to access the Linux host file system: > $ sudo flatpak override [app id] --filesystem=host But doing that to a Flatpak running "Nested" in an LXD "system" Container the Flatpak can run Privileged (re root) in the LXD Container _but it is not root in the Host Server_! So that is one reason I mentioned LXD capable of running Docker & Flatpak "nested". Also, LXD supports export/import of local/remote Containers & "live migration of a Container from Server A to Server B" > It appears that we have different use cases. I have been using NetBird to interconnect edge devices on different networks. I do that also but I always try a remote desktop connection from Edge device (lxd container on Server A to LXD Container on Server B somewhere else) just as one test of the mesh vpn performance. I also do that using iPerf. Also thanks for letting me know: > *In your mind map, the birdup.sh is calling sudo netbird up, I think the sudo is not necessary since the NetBird socket has enough permission.*
saavagebueno commented 2025-11-20 05:08:48 -05:00
Author
Owner
Copy Link

@Guillaumebeuzeboc commented on GitHub (Dec 5, 2023):

The snap is now auto-connected to the required interfaces. The manual connections are no longer required.

The instructions to install and setup NetBird snap are now simpler:

sudo snap install netbird --beta
netbird up
@Guillaumebeuzeboc commented on GitHub (Dec 5, 2023): The snap is now auto-connected to the required interfaces. The manual connections are no longer required. The instructions to install and setup NetBird snap are now simpler: ``` sudo snap install netbird --beta netbird up ```
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label feature-request packaging release
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#264
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?