mirror of
https://github.com/netbirdio/docs.git
synced 2026-08-30 11:41:26 +02:00
70 lines
3.3 KiB
Plaintext
70 lines
3.3 KiB
Plaintext
import {Note} from "@/components/mdx";
|
|
|
|
# Install NetBird on an Android
|
|
|
|
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-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
|
|
|
|
### 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-medium"/>
|
|
|
|
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-medium"/>
|
|
|
|
### 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 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"/>
|
|
|
|
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-medium"/>
|
|
|
|
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 the `exposedAddress` field in your `config.yaml` (or `management.json` for older multi-container setups) 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-medium"/>
|
|
|
|
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-medium"/>
|
|
|
|
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!
|
|
|
|
## What's next?
|
|
- Configure the device's [group & policy](/manage/access-control) memberships
|
|
|
|
|
|
|
|
|