Added install page from Android TV/tvOS (#495)

* - Seperated Android and iOS install pages
- Added detailed setup guide for Android, Android TV

* updated image alt tags

* removed dead links, tv.mdx

* redirect old mobile page to install index page

---------

Authored-by: Ashley Mensah <ashley@netbird.io>
This commit is contained in:
shuuri-labs
2025-11-27 18:59:52 +01:00
committed by GitHub
parent e45bb7ce11
commit 11867aa4b8
12 changed files with 96 additions and 4 deletions

View File

@@ -178,7 +178,7 @@ const nextConfig = {
},
{
source: '/how-to/installation/mobile',
destination: '/get-started/install/mobile',
destination: '/get-started/install',
permanent: true,
},
{

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 163 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

View File

@@ -37,9 +37,10 @@ export const docsNavigation = [
{ title: 'Linux', href: '/get-started/install/linux' },
{ title: 'Windows', href: '/get-started/install/windows' },
{ title: 'MacOS', href: '/get-started/install/macos' },
{ title: 'Android', href: '/get-started/install/android' },
{ title: 'iOS', href: '/get-started/install/ios' },
{ title: 'Docker', href: '/get-started/install/docker' },
{ title: 'Synology', href: '/get-started/install/synology' },
{ title: 'Android/iOS', href: '/get-started/install/mobile' },
{ title: 'pfSense', href: '/get-started/install/pfsense' },
{ title: 'OPNsense', href: '/get-started/install/opnsense' },
],

View File

@@ -0,0 +1,80 @@
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>
## Where to Download
NetBird has an official Android application that you can download at Google Play Store:
<p>
<a href="https://play.google.com/store/apps/details?id=io.netbird.client" target="_blank">
<img src="/docs-static/img/how-to-guides/google-play-badge.png" alt="playstore" className="imagewrapper"/>
</a>
</p>
APK releases are also available to install directly on your Android device via the [NetBird Android GitHub repository](https://github.com/netbirdio/android-client/releases).
## Configure Netbird on Android
### First Launch
Upon first launch, NetBird will inform you that it's using the default managemet server.
<img src="/docs-static/img/get-started/android/first-install-dialog.png" alt="firstinstall" className="imagewrapper"/>
Select 'Continue' to ackownledge and you'll be greeted with the app's main screen.
<img src="/docs-static/img/get-started/android/main-screen.png" alt="mainscreen" className="imagewrapper"/>
### 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 .
</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.
<img src="/docs-static/img/get-started/android/change-server-menu-item.png" alt="changeserver" className="imagewrapper"/>
Changing servers erases the device's current NetBird config, so you'll need to confirm the action before proceeding:
<img src="/docs-static/img/get-started/android/confirm-erase-config.png" alt="confirmeraseconfig" className="imagewrapper"/>
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:
<img src="/docs-static/img/get-started/android/server-changed.png" alt="serverchanged" className="imagewrapper"/>
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:
<img src="/docs-static/img/get-started/android/vpn-connection-request.png" alt="vpnconnectionrequest" className="imagewrapper"/>
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:
<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!

View File

@@ -0,0 +1,11 @@
import {Note} from "@/components/mdx";
# iOS
NetBird has an official iOS application that you can download from the App Store:
<p>
<a href="https://apps.apple.com/de/app/netbird-p2p-vpn/id6469329339?l=en-GB" target="_blank">
<img src="/docs-static/img/how-to-guides/app-store-badge.svg" alt="appstore" className="imagewrapper" style={{ padding: '30px' }}/>
</a>
</p>

View File

@@ -14,8 +14,8 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme
* [Install on macOS](/get-started/install/macos)
* [Install on Windows](/get-started/install/windows)
* [Install on Synology](/get-started/install/synology)
* [Install on Android](/get-started/install/mobile)
* [Install on iOS](/get-started/install/mobile)
* [Install on Android](/get-started/install/android)
* [Install on iOS](/get-started/install/iOS)
## Running NetBird with SSO Login
### Desktop UI Application