Maycon Santos
dd44b168fa
- Route all DNS through the tunnel on iOS by always setting matchDomains=[""], eliminating the drift between Go's DNS server (which has a root zone fallback handler) and iOS tunnel settings that only matched specific domains - Handle empty route notifications from Go — when the exit node was the only route and was deselected, the notifier sent an empty string that Swift silently dropped, leaving stale 0.0.0.0/0 in the tunnel and black-holing all traffic - Fix route card status indicator showing green after deselecting a route by checking route.selected before evaluating peer connection status
Start using NetBird at netbird.io
See Documentation
Join our Slack channel
NetBird iOS & tvOS Client
The NetBird iOS/tvOS client allows connections from mobile devices running iOS 14.0+ and Apple TV running tvOS 17.0+ to private resources in the NetBird network.
Install
You can download and install the app from the App Store:
Screenshots
Code structure
The code is divided into 4 parts:
- The main netbird Go code from the NetBird repo which is compiled into an xcframework. This contains most of the client logic.
- The network extension /NetbirdNetworkExtension that is running in the background where the compiled Go code is executed.
- The UI and app code under
/NetBird - The
/NetbirdKit/NetworkExtensionAdapterthat controls the extension and builds the link between UI and extension
Requirements
- iOS 14.0+ / tvOS 17.0+
- Xcode 16.1+
- Go 1.24+
- gomobile-netbird (NetBird's fork with tvOS support)
gomobile-netbird
This project requires gomobile-netbird, NetBird's fork of gomobile that adds tvOS support. See: https://github.com/netbirdio/gomobile-tvos-fork
To install:
go install github.com/netbirdio/gomobile-tvos-fork/cmd/gomobile-netbird@latest
gomobile-netbird init
Run locally
To build the app, this repository and the main netbird repository are needed.
git clone https://github.com/netbirdio/netbird.git
git clone https://github.com/netbirdio/ios-client.git
cd ios-client
Build the XCFramework from the main netbird repo using the build script:
./build-go-lib.sh ../netbird
Or manually with gomobile-netbird:
cd netbird
gomobile-netbird bind -target=ios,iossimulator,tvos,tvossimulator -bundleid=io.netbird.framework -o ../ios-client/NetBirdSDK.xcframework ./client/ios/NetBirdSDK
This builds a single universal XCFramework that supports iOS, iOS Simulator, tvOS, and tvOS Simulator.
Open the Xcode project, and we are ready to go.
Running on iOS Device
Note: The app cannot run in the iOS simulator. To test the app, a physical device needs to be connected to Xcode via cable and set as the run destination.
Running on Apple TV
Note: The app cannot run in the tvOS simulator. To test the app, a physical device running tvOS 17.0 or later needs to be paired with Xcode.
Firebase Configuration (Optional)
The app supports Firebase for analytics and crash reporting. To enable it, add your GoogleService-Info.plist file to the project root. The app will work without Firebase configuration.
Other project repositories
NetBird project is composed of multiple repositories:
- NetBird: https://github.com/netbirdio/netbird, contains the code for the agents and control plane services.
- Dashboard: https://github.com/netbirdio/dashboard, contains the Administration UI for the management service
- Documentations: https://github.com/netbirdio/docs, contains the documentation from https://netbird.io/docs
- Android Client: https://github.com/netbirdio/android-client
- iOS/tvOS Client: https://github.com/netbirdio/ios-client (this repository)