Install NetBird on an Android

The Android supports mobile devices, tablets and Android TV devices running Android 8.0 or later.

Where to Download

NetBird has an official Android application that you can download at Google Play Store:

APK releases are also available to install directly on your Android device via the NetBird Android GitHub repository.

Configure Netbird on Android

First Launch

Upon first launch, NetBird will inform you that it's using the default managemet server.

Select 'Continue' to ackownledge and you'll be greeted with the app's main screen.

Management Server Configuration

Select the hamburger menu on the top left of the main screen (or hold the left directional button on Android TV) and navigate to the 'Change Server' menu.

Changing servers erases the device's current NetBird config, so you'll need to confirm the action before proceeding:

Enter your management server endpoint. For cloud users, this is https://api.netbird.io:443. For self-hosted users, it's usually https://your_management_server_url:443, but you can refer to your management.json configuration file if you're unsure.

If enrolling the device with a setup key, select '+ Add this device with a setup key' and enter your setup key. Select 'change' to apply your new management server config, and if successful you'll see the following:

You're now ready to connect to your Netbird network!

Connecting to Your Network

Select the NetBird logo button to connect. The app will request permission to create a VPN connection:

Select 'OK'. If you didn't enter a setup key in the 'Change Server' menu, then you'll need to authenticate with your SSO provider. NetBird will open a browser window where you'll be instructed to sign in to your SSO provider.

After logging in, NetBird will confirm your authentication. Once you close the browser window, your device should be connected!

Authenticating on Android TV

Since Android TV doesn't ship with a built-in browser, and entering credentials with a remote may be less than ideal, the TV client uses a slightly different authentication flow. If you're not using a setup key, then after you grant the app permission to create a VPN connection, you'll be presented a QR code and device ID:

Scan the QR code with your phone and you'll be able to sign in to your SSO provider there. If asked to confirm your device code, confirm that the code underneath the QR code matches the one presented by your SSO provider. Once you've completed the SSO flow, the QR code dialog in the NetBird app will automatically dismiss itself, and your device should now be connected!