mirror of
https://github.com/netbirdio/docs.git
synced 2026-05-04 16:26:36 +00:00
Feat/add apple tv installation docs (#520)
* - 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:
58
src/pages/get-started/install/tvos.mdx
Normal file
58
src/pages/get-started/install/tvos.mdx
Normal file
@@ -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)
|
||||
Reference in New Issue
Block a user