Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/components/NavigationDocs.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ export const docsNavigation = [
{ title: 'MacOS', href: '/get-started/install/macos' },
{ title: 'Docker', href: '/get-started/install/docker' },
{ title: 'iOS', href: '/get-started/install/ios' },
{ title: 'tvOS', href: '/get-started/install/tvos'},
{ title: 'Android', href: '/get-started/install/android' },
{ title: 'Android TV', href: '/get-started/install/android-tv'}
],
},
{
Expand Down
86 changes: 86 additions & 0 deletions src/pages/get-started/install/android-tv.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
import {Note} from "@/components/mdx";

# Install NetBird on an Android TV

The Android TV app supports 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/get-started/android/google-play-badge.png" alt="playstore" className="imagewrapper-medium"/>
</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 TV

### 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-tv/main-screen.png" alt="android-tv-main-screen" className="imagewrapper-large"/>

### 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 [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) and navigate to the 'Change Server' menu.

<img src="/docs-static/img/get-started/android-tv/main-menu-change-server.png" alt="android-tv-main-menu" className="imagewrapper-large"/>

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-tv/change-server.png" alt="confirm-erase-cponfig" className="imagewrapper-large"/>

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

<Note>
For self-hosted users _not_ enrolling the device with a setup key, Device Authentication needs to be enabled in the management server config.
</Note>

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 to the mobile app. 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-large"/>

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?
- Manage your device's [access](/manage/access-control/manage-network-access) to the network
- Use your device for [remote access access to your home network](/manage/networks/homelab/access-home-network)
- Use your device as an [exit node](/manage/network-routes/configuring-default-routes-for-internet-traffic#make-the-peer-an-exit-node-routing-peer)

25 changes: 7 additions & 18 deletions src/pages/get-started/install/android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,15 @@ 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

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/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>
Expand All @@ -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"/>

Expand All @@ -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!

#### 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"/>
After logging in, NetBird will confirm your authentication. Once you close the browser window, your device should be connected!

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



Expand Down
58 changes: 58 additions & 0 deletions src/pages/get-started/install/tvos.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import {Note} from "@/components/mdx";

# tvOS (Apple TV)

The tvOS app supports all Apple TV devices running tvOS 17.0 or later. It's available to download in the Apple TV app store.

<Note>
tvOS support is currently in beta.
</Note>

## Configure NetBird on tvOS

### First Launch

<img src="/docs-static/img/get-started/tvos/confirm-add-vpn-config.png" alt="tvos-confirm-add-vpn-config" className="imagewrapper-large"/>

Upon first launch, NetBird will request permission to create a new VPN configuration. Select 'Allow' to continue.

### 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 [Connecting & Authenticating](#connecting-and-authenticating)
</Note>

By default, the app is configured to connect to NetBird's cloud management server. If you're a self-hosted user, or you'd like to enroll the device with a setyo key, you'll need to
change the management server settings.

Navigate to **'Settings > Change Server'**, and the app will warn you that changing management server settings will erase your current config and disconnect if a connection is currently active:

<img src="/docs-static/img/get-started/tvos/confirm-change-server.png" alt="tvos-confirm-change-server" className="imagewrapper-large"/>

After confirming, you'll be presented with a dialog to enter your management server URL. Cloud users who want to enroll the device with a setup key should enter the URL 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. NetBird will run a brief verification step
on the details you've entered, after which you can move on to connecting.

### Connecting & Authenticating

On the main 'Connection' screen, select the 'Connect' button to initiate a connection to your NetBird network.

<Note>
For self-hosted users _not_ enrolling the device with a setup key, Device Authentication needs to be enabled in the management server config.
</Note>

If you're not using a setup key, you'll be presented a QR code and device ID:

<img src="/docs-static/img/get-started/tvos/authentication-screen.png" alt="tvos-authentication" className="imagewrapper-large"/>

Scan the QR code with a mobile device 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, after a few seconds the authentication dialog in the NetBird app will automatically dismiss itself. Select the 'Connect' button once more, and your device should now be connected!

<img src="/docs-static/img/get-started/tvos/main-screen-connected.png" alt="tvos-main-screen-connected" className="imagewrapper-large"/>

## What's next?
- Manage your device's [access](/manage/access-control/manage-network-access) to the network
- Use your device for [remote access access to your home network](/manage/networks/homelab/access-home-network)
- Use your device as an [exit node](/manage/network-routes/configuring-default-routes-for-internet-traffic#make-the-peer-an-exit-node-routing-peer)
Loading