sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-13 17:19:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Feat/add apple tv installation docs (#520)

Browse Source 
* - Added docs page for installing on tvOS
- Split Android & Android TV installations into seperate pages

---------

Co-authored-by: Ashley Mensah <ashley@netbird.io>
Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
This commit is contained in:
shuuri-labs
2026-01-20 21:54:15 +01:00
committed by GitHub
co-authored by Ashley Mensah Jack Carter
parent c7e6c9850c
commit 410bfe325c
12 changed files with 154 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/get-started/install/android.mdx
+7 -18
View File
@@ -2,11 +2,7 @@ import {Note} from "@/components/mdx";
# Install NetBird on an Android
The Android supports mobile devices, tablets and Android TV devices running Android 8.0 or later.
<Note>
Android TV support is currently in beta.
</Note>
The Android supports mobile devices, tablets and [Android TV](android-tv) devices running Android 8.0 or later.
## Where to Download
@@ -14,7 +10,7 @@ NetBird has an official Android application that you can download at Google Play
<p>
<a href="https://play.google.com/store/apps/details?id=io.netbird.client" target="_blank">
<img src="/docs-static/img/get-started/android/google-play-badge.png" alt="playstore" className="imagewrapper"/>
<img src="/docs-static/img/get-started/android/google-play-badge.png" alt="playstore" className="imagewrapper-medium"/>
</a>
</p>
@@ -36,10 +32,10 @@ Select 'Continue' to ackownledge and you'll be greeted with the app's main scree
### Management Server Configuration
<Note>
This step only applies to self-hosted users, or cloud users enrolling the device with a setup key. If you're a cloud user and are _not_ enrolling the device with a setup key, you can safely skip to .
This step only applies to self-hosted users, or cloud users enrolling the device with a setup key. If you're a cloud user and are _not_ enrolling the device with a setup key, you can safely skip to [Connecting to Your Network](#connecting-to-your-network)
</Note>
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.
Select the hamburger menu on the top left of the main screen and navigate to the 'Change Server' menu.
<img src="/docs-static/img/get-started/android/change-server-menu-item.png" alt="changeserver" className="imagewrapper-medium"/>
@@ -63,17 +59,10 @@ Select the NetBird logo button to connect. The app will request permission to cr
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!
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:
<img src="/docs-static/img/get-started/android/tv-sso-qr-dialog.png" alt="tvssoqr" className="imagewrapper"/>
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!
## What's next?
- Configure the device's [group & policy](example.com) memberships